Documentation

This directory contains developer-facing usage, production, and operations documentation.

Start Here

Developer Guide: install, CLI, SDK, MCP, order workflows, audit, and validation commands.
Production Readiness: deployment checklist, secrets, remote MCP, audit, sidecar, paper, and live gates.
Public API: supported Rust facade modules and examples.
Testing: local/CI gates, fixture coverage, replay, secret regression, and performance budgets.

Client Portal Gateway: local broker session expectations and troubleshooting.
Read and Tool Commands: read-only data, MCP maturity tools, preview, paper, live-gated, bracket, and sidecar commands.
Local and Remote MCP: MCP transports, tool registry, forbidden generic write tools, and provider usage.
Remote MCP OAuth/OIDC: protected resource metadata, RS256/JWKS validation, token-id hashing, rate limiting, and connection caps.
Order Preview: non-executable previews and deterministic risk checks.
Paper Orders: approval and idempotent paper lifecycle.
Paper to Live and Live Runbook: live trading gates and operational checklist.
Sidecar Relay: pairing, heartbeat, and local CP Gateway forwarding boundary.
Provider Compatibility: MCP client targets and provider-neutral compatibility checks.
Audit Log, Audit Retention, and Incident Review: evidence handling and redacted review workflows.