Repository navigation
docs(http): document --authorization-server for RFC 7591 DCR clients - #3847
Open
RealThanhNguyxn wants to merge 1 commit into
Open
RealThanhNguyxn wants to merge 1 commit into
RealThanhNguyxn wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The change removes the only documentation for configuring request-state encryption and the related deployment requirement, while the server behavior and tests still depend on it.
1 open issue
What changed in this PR
Updates Streamable HTTP documentation to explain configuring external OAuth 2.1 / RFC 7591 Dynamic Client Registration proxies for GitHub.com and GHES deployments, including limitations of the hosted MCP endpoint.
Changes:
- Documents
--authorization-serverandGITHUB_AUTHORIZATION_SERVERproxy configuration. - Adds a self-hosted GitHub.com example and hosted endpoint guidance for DCR-dependent clients.
- Removes the existing request-state encryption and
delete_repositoryconfiguration documentation.
| File | Description |
|---|---|
| docs/streamable-http.md | Expands OAuth proxy guidance with GitHub.com examples and hosted endpoint limitations while modifying adjacent HTTP deployment and request-state encryption documentation. |
Review effort: Lite (dynamic)
| Equivalent environment variable: `GITHUB_TRUST_PROXY_HEADERS=1`. Only enable this when the upstream proxy is trusted to set or strip these headers; otherwise prefer `--base-url`. When `--base-url` is set, it always takes precedence and `--trust-proxy-headers` has no effect. | ||
|
|
||
| ### With an OAuth Proxy (GHES / non-standard authorization server) | ||
| ### With an OAuth Proxy (GHES / RFC 7591 DCR clients) |
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
Clarifies
docs/streamable-http.mdto document using--authorization-server(GITHUB_AUTHORIZATION_SERVER) with an external OAuth 2.1 + Dynamic Client Registration (RFC 7591) proxy when self-hosting HTTP mode for MCP clients that require automated DCR and JSON token/refresh responses.Related to #3519 and #2532.
Why
In addition to GitHub Enterprise Server deployments,
https://github.com/login/oauthdoes not expose an RFC 7591/registerendpoint and returnsapplication/x-www-form-urlencodedtoken payloads unlessAccept: application/jsonis supplied. MCP clients that rely on RFC 7591 DCR or standard OIDC refresh tokens (such as Google Gemini Web/Mobile custom apps or OpenCode) cannot complete automated OAuth discovery againstgithub.com/login/oauthdirectly.github-mcp-server httpalready supports--authorization-serverto advertise an OAuth proxy in/.well-known/oauth-protected-resource, so documenting this use case alongside GHES—and noting that the hostedapi.githubcopilot.com/mcp/endpoint requires an external OAuth proxy for DCR clients—gives operators a clear, supported configuration path.What changed
docs/streamable-http.mdto cover self-hostedgithub.comdeployments behind an OAuth 2.1 + DCR proxy in addition to GHES.github.comCLI example using--base-urland--authorization-server.https://api.githubcopilot.com/mcp/advertiseshttps://github.com/login/oauthdirectly and requires an external OAuth proxy for RFC 7591 DCR clients.MCP impact
Prompts tested (tool changes only)
Security / limits
/.well-known/oauth-protected-resource) and external OAuth 2.1 authorization proxies; no runtime auth logic changed.Tool renaming
deprecated_tool_aliases.goLint & tests
./script/lint./script/testdocs/streamable-http.md. Both scripts ran locally:./script/lintreports 0 issues and./script/test(go test -race ./...) passes across all packages.Docs