docs: add MCP migration guide for 1.7.x consumers - #40
Merged
Conversation
Step-by-step playbook for exposing an existing endpoint-gen backend's endpoints as MCP tools: version matrix, RON description requirements, regeneration expectations, the 1.8.0 typed-error handler migration patterns, SubAuthController changes, enable_mcp wiring, and a websocat verification recipe. Linked from the README's MCP section, with pathscale/api.support.cafe#3 as the worked example. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
docs/mcp-migration.md— a step-by-step guide for taking an existing endpoint-gen + endpoint-libs backend from 1.7.x to the 1.9 MCP surface — and links it from the README's MCP section.The guide is distilled from a real migration (pathscale/api.support.cafe#3, ~25 endpoints, 94 compile errors → 0) and covers:
description:requirements (and whyField-level descriptions don't flow through)type_registry(), the realEnumErrorCodecatalog, per-service*_mcp_tools.jsondocs)type Error = CustomError, public errors vs.internal(), the typedSubAuthControllershapeenable_mcpwiring and a websocat verification recipe with the assertions that constitute "MCP works"Docs-only change; no code touched.
🤖 Generated with Claude Code