Mocapi Documentation¶
Three audiences, three trees:
- guides/ — you are building an MCP server with mocapi. Start here. How to write tools, configure transports, plug in observability, externalize metadata.
- design/ — you are extending mocapi or reasoning about its internals. Living architecture documents, kept synchronized with the code.
- adr/ — you want to know why a thing is the way it is. Point-in-time architecture decisions with status.
Alongside those three trees:
- constitution.md — the non-negotiable architectural invariants (each links its governing ADR).
- roadmap.md — where mocapi is going.
- superpowers/ — the spec-driven-development workflow, with per-feature specs and plans.
Top-level project documents (README, CHANGELOG, CONTRIBUTING, PRD, SECURITY) live at the repo root.
Suggested reading order¶
If you are building a server, read these in order:
- The repo-root
README.md— what mocapi is, the quick start. guides/tools.md— your first@McpTool.guides/configuration.md— the property surface.guides/observability.md— wire up logging, metrics, audit.guides/authorization.md(only if you need OAuth2).
If you are extending mocapi or reviewing a design, read these in order:
design/architecture-overview.md— module layering, request flow, ScopedValues.design/transports.md— Streamable HTTP and stdio.design/extension-spi.md— customizers, strata, parameter resolvers.- The ADR index — pick decisions relevant to your area.
If you are looking for a specific decision, the ADR index is the entry point. ADRs cross-link to the design docs they implement.