Skip to content

[v1.x] docs(server/auth): document that resourceServerUrl and resourceMetadataUrl are needed for MCP-compliant discovery #2752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bumhwan wants to merge 1 commit into
base: v1.x
Choose a base branch
from
+13 −1
Open

[v1.x] docs(server/auth): document that resourceServerUrl and resourceMetadataUrl are needed for MCP-compliant discovery #2752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/server/auth/middleware/bearerAuth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ export type BearerAuthMiddlewareOptions = {
requiredScopes?: string[];

/**
* Optional resource metadata URL to include in WWW-Authenticate header.
* Resource metadata URL to advertise in the `WWW-Authenticate` challenge on 401/403
* responses (RFC 9728 §5.1). The MCP authorization spec requires MCP servers to send it, so
* pass `getOAuthProtectedResourceMetadataUrl(mcpServerUrl)` for any protected MCP endpoint.
* When omitted, clients must guess the well-known location and strict clients can fail
* discovery; leave it out only for non-MCP or legacy deployments.
*/
resourceMetadataUrl?: string;
};
Expand Down
8 changes: 8 additions & 0 deletions src/server/auth/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ export type AuthRouterOptions = {
/**
* The URL of the protected resource (RS) whose metadata we advertise.
* If not provided, falls back to `baseUrl` and then to `issuerUrl` (AS=RS).
*
* Pass the MCP endpoint URL itself (e.g. `https://api.example.com/mcp`), not just the
* origin. RFC 9728 §3 places the metadata at
* `/.well-known/oauth-protected-resource/<path>` and §3.3 requires its `resource` to be
* identical to the resource the client connected to. The `baseUrl` fallback therefore only
* yields a compliant document when the MCP endpoint is served at the origin root; clients
* that enforce §3.3 (Gemini CLI, Antigravity CLI) reject `resource: https://host/` when they
* connected to `https://host/mcp`, while the reference SDK client happens to accept it.
*/
resourceServerUrl?: URL;

Expand Down
Loading