Skip to content

docs: position Python as reference implementation, document optional MCP#7

Merged
kurtseifried merged 1 commit into
mainfrom
docs/mcp-positioning-reference-impl
May 28, 2026
Merged

docs: position Python as reference implementation, document optional MCP#7
kurtseifried merged 1 commit into
mainfrom
docs/mcp-positioning-reference-impl

Conversation

@kurtseifried

Copy link
Copy Markdown
Contributor

Summary

Documentation-only PR following decisions from the testing-maturity discussion:

  • Python implementation positioned as the reference implementation (shows REST API + MCP + pluggable storage) — TS and Go (planned) will be production-throughput-focused and serve REST only.
  • The optional MCP endpoint is now explicitly documented. Requires `pip install mcp`; the server starts normally without it and the `/mcp` endpoint is logged as disabled.
  • Three planned implementations (Python active, TypeScript + Go planned) replaces the prior two-impl framing.
  • CLAUDE.md and AGENTS.md updated to reflect the factory pattern (post PR refactor: move secid_server.py to factory pattern for testability #6) and existing test/CI infrastructure.

Files changed

  • `README.md` — Implementations table now lists three; MCP section spells out optional `pip install mcp` requirement and positioning
  • `CLAUDE.md` — Project overview, repo structure, and Key Design Decisions reflect factory pattern + optional MCP
  • `AGENTS.md` — Removed stale "no automated suite" line; Project Structure mentions test_smoke.py + CI workflow

No code or behavior changes.

🤖 Generated with Claude Code

Updates README.md, CLAUDE.md, and AGENTS.md to reflect:

1. Reference-implementation framing for the Python server. It's not just
   "one of N implementations"; it's specifically the one that demonstrates
   every server-side feature (REST + optional MCP + pluggable storage).
   TS and Go ports (planned) will focus on production throughput and
   serve REST only.

2. Optional MCP dependency. /mcp is mounted only when the `mcp` Python
   package is installed (pip install mcp). Without it the server starts
   normally and the REST API works; /mcp is logged as disabled. Now
   documented explicitly in README.

3. Three planned implementations (Python active; TypeScript + Go planned),
   instead of the prior "two implementations" framing.

4. Current factory-pattern shape (post PR #6) noted in CLAUDE.md's Key
   Design Decisions and AGENTS.md's Project Structure.

5. AGENTS.md testing section updated — test_smoke.py exists and CI runs;
   removed the "no automated suite" line.

No code changes; documentation only.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@kurtseifried kurtseifried merged commit 3aed34a into main May 28, 2026
@kurtseifried kurtseifried deleted the docs/mcp-positioning-reference-impl branch May 28, 2026 20:24
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