fix: validate clientMetadataUrl at construction time (fail-fast)#1653
Open
rechedev9 wants to merge 2 commits intomodelcontextprotocol:mainfrom
Open
fix: validate clientMetadataUrl at construction time (fail-fast)#1653rechedev9 wants to merge 2 commits intomodelcontextprotocol:mainfrom
rechedev9 wants to merge 2 commits intomodelcontextprotocol:mainfrom
Conversation
…havior Move clientMetadataUrl validation to all SDK-controlled entry points (StreamableHTTP/SSE constructors, auth(), withOAuth factory) so invalid URLs are caught immediately rather than deep in the auth flow. Exports validateClientMetadataUrl() for consumers who implement OAuthClientProvider directly. Existing defense-in-depth validation in authInternal() is preserved. Closes modelcontextprotocol#1159
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
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
validateClientMetadataUrl()utility that reuses the existingisHttpsUrl()helper to validateclientMetadataUrlearlyStreamableHTTPClientTransportconstructor,SSEClientTransportconstructor,auth()function, andwithOAuthmiddleware factoryvalidateClientMetadataUrl()so consumers who implementOAuthClientProviderdirectly can call it in their own constructorsauthInternal()(near-zero cost redundant check)Motivation
clientMetadataUrlwas only validated deep insideauthInternal()after network discovery requests had already been made. This meant invalid URL-based client IDs weren't caught until runtime during authentication, producing confusing stack traces far from the configuration source.This change provides fail-fast behavior: developers discover configuration errors immediately at construction time with clear error messages pointing to where the provider was configured.
Test plan
validateClientMetadataUrl()— valid HTTPS URLs, HTTP rejection, root-path rejection, non-URL strings, undefined passthrough, error formatStreamableHTTPClientTransport,SSEClientTransport,auth(),withOAuthauthInternal()is untouchedCloses #1159