docs: MCP reverse proxy — overview, client setup, deployment notes#24
Merged
Conversation
Closes #19 (Phase 1 scope; Phase 2 addendum lands with #17): - What-it-does bullet + /mcp request flow in the architecture diagram - API section: Phase 1 diagram, [mcp] config, behavior notes (session pinning/404 semantics, readonly tool naming, audit log format, allowed_owners non-enforcement) - Deployment notes: api.githubcopilot.com egress, single-replica session cache, network-trust boundary, self-hosted github-mcp-server fallback - Client setup: Kiro CLI / JSON mcp config, Claude Code, curl probe; Phase 2 X-Ghpool-Key preview
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
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
Closes #19 (Phase 1 scope). Documents the MCP reverse proxy shipped in #20/#21/#23 — the README previously didn't mention
/mcpat all.Changes (README only)
/mcpadded to the request-flow diagram[mcp]config reference, behavior notes verified in e2e: session pinning + 404 re-init semantics, readonly tool naming (issue_readvsget_issue), audit log format,allowed_ownersnon-enforcementapi.githubcopilot.comegress, single-replica session cache constraint, network-trust boundary warning, self-hostedgithub-mcp-serverfallbackX-Ghpool-Keypreview (MCP proxy Phase 2 gate: agent authn + default-deny policy + GitHub App backend + writes #17)Deferred to #17 (per the issue's task list)
Phase 2 addendum: API key delivery, rotation,
[[mcp.agents]]policy examples,ghp mcpshim.config.example.toml's[mcp]section already shipped in #20.