This documentation describes the 1.0 public contract. The root README is a quick entry point; the documents below separate product architecture, capability behavior, protocol, security, operations, reference, integration, migration, and release concerns.
| Goal | Document |
|---|---|
| Install and run a local Server | Quick start |
| Understand the 1.0 design | Architecture overview |
| Follow one request end to end | Request and data flow |
| See every public domain | Tool domains |
| Understand runtime availability | Capability availability |
| Connect an MCP Host | Host integrations |
| Deploy safely | Deployment |
- Architecture overview — component boundaries, top-level design, control plane, execution plane, and extension boundaries.
- Request and data flow — initialization, top-level discovery, domain discovery, child execution, Doris routing, and response construction.
- ADR 0001: subscriptions require change events
- ADR 0002: explicit state handles
- Tool domains — the 8-domain/55-child contract.
- Capability availability — version parsing, probes, providers, permissions, manifests, and fail-closed behavior.
- Doris version capability matrix — the 2.0+ baseline and release-aware feature gates.
- Generated tool registry — authoritative generated names, handler bindings, authorization identifiers, variants, and migration inputs.
- MCP 2026-07-28 contract — transports, pagination, schemas, errors, state handles, tracing, and legacy isolation.
- Security and permission model — authentication, authorization layers, query safety, data safety, secrets, and deployment policy.
- Doris fine-grained access control — Doris RBAC, row policies, token-bound identities, and operational examples.
- Deployment — stdio, HTTP, Docker, proxies, workers, secrets, and rollout checks.
- Reliability and limits — health, connection routing, failover, bounds, observability, fallbacks, and known limits.
- Troubleshooting — startup, readiness, authentication, capability, query, and transport diagnostics.
- Contributing and verification
- Migrating to 1.0
- 1.0 release notes
- Compatibility release paths: migration-1.0.0.md and release-notes-1.0.0.md
- Changelog
- Detailed 1.0 release issue
- Runtime behavior and generated catalogs take precedence over prose.
- English and Simplified Chinese topic guides must keep the same section structure and operational meaning.
- The generated
tool-registry.mdmust not be edited by hand. - Examples must use placeholders rather than deployable credentials.
- A capability must not be documented as available solely because its Doris version range matches; runtime probes, provider state, and permissions are part of the contract.