Skip to content

Preserve paths when building PRM URL, per specification. #722

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 43 additions & 1 deletion src/server/auth/router.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { mcpAuthRouter, AuthRouterOptions, mcpAuthMetadataRouter, AuthMetadataOptions } from './router.js';
import { mcpAuthRouter, AuthRouterOptions, mcpAuthMetadataRouter, AuthMetadataOptions, getOAuthProtectedResourceMetadataUrl } from './router.js';
import { OAuthServerProvider, AuthorizationParams } from './provider.js';
import { OAuthRegisteredClientsStore } from './clients.js';
import { OAuthClientInformationFull, OAuthMetadata, OAuthTokenRevocationRequest, OAuthTokens } from '../../shared/auth.js';
Expand Down Expand Up @@ -480,3 +480,45 @@ describe('MCP Auth Metadata Router', () => {
});
});
});

describe('MCP Protected Resource Metadata URL', () => {

it('should insert well-known URI after host', () => {
const serverUrl = new URL('https://mcp.example.com')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource');
});

// NOTE: There's some ambiguity in the specifications as to expected output.
// See discussion on OAuth WG mailing list for further details and rationale:
// https://mailarchive.ietf.org/arch/msg/oauth/LLoteOrAn0sd172dsll254oHGX4/
it('should insert well-known URI after host with path', () => {
const serverUrl = new URL('https://mcp.example.com/')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource');
});

it('should insert well-known URI between host and path', () => {
const serverUrl = new URL('https://mcp.example.com/mcp')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource/mcp');
});

it('should insert well-known URI between host and query', () => {
const serverUrl = new URL('https://mcp.example.com?k=v')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource?k=v');
});

it('should insert well-known URI between host and path with query', () => {
const serverUrl = new URL('https://mcp.example.com/mcp?k=v')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource/mcp?k=v');
});

it('should insert well-known URI between host and path while preserving trailing slash from path', () => {
const serverUrl = new URL('https://mcp.example.com/mcp/')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource/mcp/');
});

it('should insert well-known URI between host and path with query while preserving trailing slash from path', () => {
const serverUrl = new URL('https://mcp.example.com/mcp/?k=v')
expect(getOAuthProtectedResourceMetadataUrl(serverUrl)).toBe('https://mcp.example.com/.well-known/oauth-protected-resource/mcp/?k=v');
});

});
15 changes: 13 additions & 2 deletions src/server/auth/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,20 @@ export function mcpAuthMetadataRouter(options: AuthMetadataOptions) {
* @returns The URL for the OAuth protected resource metadata endpoint
*
* @example
* getOAuthProtectedResourceMetadataUrl(new URL('https://api.example.com/mcp'))
* getOAuthProtectedResourceMetadataUrl(new URL('https://api.example.com'))
* // Returns: 'https://api.example.com/.well-known/oauth-protected-resource'
*
* @example
* getOAuthProtectedResourceMetadataUrl(new URL('https://api.example.com/mcp'))
* // Returns: 'https://api.example.com/.well-known/oauth-protected-resource/mcp'
*/
export function getOAuthProtectedResourceMetadataUrl(serverUrl: URL): string {
return new URL('/.well-known/oauth-protected-resource', serverUrl).href;
const wellKnownUrl = new URL(serverUrl);
let path = wellKnownUrl.pathname;
if (path === '/') {
path = path.slice(0, -1);
}

wellKnownUrl.pathname = `/.well-known/oauth-protected-resource${path}`
return wellKnownUrl.toString();
}