Skip to content

docs(mcp): architecture.md skeleton for contributor docs - #7

Merged
bdavidzhang merged 1 commit into
mainfrom
docs/mcp-architecture-skeleton
Oct 16, 2026
Merged

bdavidzhang merged 1 commit into
mainfrom
docs/mcp-architecture-skeleton

Conversation

@bdavidzhang

Copy link
Copy Markdown
Member

Adds mcp/docs/architecture.md, a skeleton for an architecture guide to the MCP server.

  • Five sections: what the package does, key components, data flow, common changes, gotchas and design concerns
  • A starting component list taken from the src/ layout (cordis plugin composition, auth and session, the HTTP client, tool plugins, the vendored protocol, packaging)
  • Points to the README Architecture section, the rules in CLAUDE.md, and vendor/protocol/README.md, so the guide expands on them instead of repeating them

Docs-only. No code or tests touched.

🤖 Generated with Claude Code

Why: contributors need one place that explains the MCP server's key
components, how a tool call flows to the backend, and how to make common
changes, without reading every file.

What: mcp/docs/architecture.md with a five-section template (what it
does, key components, data flow, common changes, gotchas and design
concerns), a starting component list from the src/ layout, and pointers
to the README Architecture section, CLAUDE.md rules and the vendored
protocol README.

Verified: docs-only; no code or tests touched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@bdavidzhang
bdavidzhang merged commit 107305a into main Oct 16, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant