Conversation
9 tasks
koic
force-pushed
the
let_a_provider_customize_the_oauth_http_client
branch
from
September 18, 2026 02:41
33a2bbf to
e1c73ef
Compare
## Motivation and Context `MCP::Client::OAuth::Flow` takes an `http_client_factory:`, but `MCP::Client::HTTP` builds the flow itself and passes none, so an application using `oauth:` could not add middleware to the requests the flow makes: Protected Resource Metadata and authorization server metadata discovery, dynamic client registration, and every token request. The block that customizes the transport's Faraday connection does not help, because that connection is bound to the MCP server URL and carries the `headers:` meant for that server, and the authorization server is a different origin. The TypeScript SDK hands the transport's `fetch` to `auth()` and the Python SDK sends the provider's requests through the transport's httpx client, so both let an application instrument these requests; this SDK did not. (modelcontextprotocol#558) Providers now take `http_client_customizer:`, a callable invoked with the Faraday connection the flow builds for its own requests, next to the other callables a provider already holds. It runs after the SDK's defaults (`Accept: application/json`, no redirect following) and between two middlewares of the SDK's own: `Flow::RequestedURLStamp`, registered before the customizer is invoked, records the URL the flow asked for on the request environment, and `Flow::RequestedOriginGuard`, registered last, sees what the customizer's middleware did to the request after that record. A request that would leave that origin, by following a redirect or rewriting the URL, or that arrives without the record, is refused with `Flow::DestinationMismatchError` before it reaches the adapter. The record lives on the environment rather than in `env.request.context`, which stays the application's to fill or replace. The error is an `ArgumentError` rather than an `AuthorizationError` so neither discovery nor the transport's refresh fallback can absorb a configuration mistake. The boundary resembles the one the Python SDK keeps for its own requests, which follows a redirect only within the origin; this flow follows none itself. `Flow.build_http_client` assembles that connection and `Flow.new(http_client_factory:)` keeps replacing it whole. Following done inside an adapter cannot be seen by any guard, so the documentation keeps that, `Accept-Encoding`, and `raise_error` off the list of things a customizer may add, and notes that a recording middleware sees client credentials and tokens. Fixes modelcontextprotocol#558. ## How Has This Been Tested? New tests in `test/mcp/client/oauth/flow_test.rb`, `test/mcp/client/oauth/http_oauth_test.rb`, and the three provider test files. Against the library before this change, every one of them fails, on the unknown keyword or on the missing reader. ## Breaking Changes None. The customizer is opt-in, and the guard cannot fire on the SDK's own middleware-free connection.
koic
force-pushed
the
let_a_provider_customize_the_oauth_http_client
branch
from
September 18, 2026 04:04
e1c73ef to
c9f381a
Compare
|
This works for our case — thanks for turning it around so quickly. Putting Our middleware is observation-only — it adds no redirect following, doesn't set Together with #555, this closes both of the blockers that kept us off |
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.
Motivation and Context
MCP::Client::OAuth::Flowtakes anhttp_client_factory:, butMCP::Client::HTTPbuilds the flow itself and passes none, so an application usingoauth:could not add middleware to the requests the flow makes: Protected Resource Metadata and authorization server metadata discovery, dynamic client registration, and every token request. The block that customizes the transport's Faraday connection does not help, because that connection is bound to the MCP server URL and carries theheaders:meant for that server, and the authorization server is a different origin. The TypeScript SDK hands the transport'sfetchtoauth()and the Python SDK sends the provider's requests through the transport's httpx client, so both let an application instrument these requests; this SDK did not. (#558)Providers now take
http_client_customizer:, a callable invoked with the Faraday connection the flow builds for its own requests, next to the other callables a provider already holds. It runs after the SDK's defaults (Accept: application/json, no redirect following) and between two middlewares of the SDK's own:Flow::RequestedURLStamp, registered before the customizer is invoked, records the URL the flow asked for on the request environment, andFlow::RequestedOriginGuard, registered last, sees what the customizer's middleware did to the request after that record. A request that would leave that origin, by following a redirect or rewriting the URL, or that arrives without the record, is refused withFlow::DestinationMismatchErrorbefore it reaches the adapter. The record lives on the environment rather than inenv.request.context, which stays the application's to fill or replace. The error is anArgumentErrorrather than anAuthorizationErrorso neither discovery nor the transport's refresh fallback can absorb a configuration mistake. The boundary resembles the one the Python SDK keeps for its own requests, which follows a redirect only within the origin; this flow follows none itself.Flow.build_http_clientassembles that connection andFlow.new(http_client_factory:)keeps replacing it whole. Following done inside an adapter cannot be seen by any guard, so the documentation keeps that,Accept-Encoding, andraise_erroroff the list of things a customizer may add, and notes that a recording middleware sees client credentials and tokens.Fixes #558.
How Has This Been Tested?
New tests in
test/mcp/client/oauth/flow_test.rb,test/mcp/client/oauth/http_oauth_test.rb, and the three provider test files. Against the library before this change, every one of them fails, on the unknown keyword or on the missing reader.Breaking Changes
None. The customizer is opt-in, and the guard cannot fire on the SDK's own middleware-free connection.
Types of changes
Checklist