Let a provider add parameters to the token requests it makes - #555
Conversation
## Motivation and Context `ClientCredentialsProvider` builds a fixed `client_credentials` token request: `grant_type`, `scope`, `resource`, and the client authentication that `Flow#post_to_token_endpoint` adds. An authorization server that requires further parameters, such as Auth0's `audience`, cannot be used through `oauth:` at all, and giving up `oauth:` also gives up the bearer header and the 401-driven retry that the transport provides. RFC 6749 Section 8.2 allows extension parameters on the token request, and the TypeScript SDK lets a provider shape its token request through `prepareTokenRequest`. `ClientCredentialsProvider.new` now takes `token_request_params:`, a Hash of String keys and values added to every token request the provider makes, and `Flow#post_to_token_endpoint` reads the same name by duck typing, so a `Provider` or `CrossAppAccessProvider` subclass that defines the method gets the same treatment on its authorization code exchange, refresh, or `jwt-bearer` request. `Provider.new` and `CrossAppAccessProvider.new` take the same keyword, held by `StorageBackedProvider` like `authorization_request_validator`, so every bundled provider refuses a bad value before anything is stored. The parameters go underneath the flow's own, so the SDK's values always win, and a key the SDK sets itself (`Flow::RESERVED_TOKEN_REQUEST_PARAMS`) is refused rather than silently overridden: with `ArgumentError` from the constructor, before any `client_information` is written, and again with `ArgumentError` from the flow, before the token request is sent. Only Strings are accepted because `URI.encode_www_form` encodes other scalars and Arrays in ways the caller did not write, and the provider keeps a frozen copy so a later change to the caller's Hash cannot alter what is sent. A Hash comparing keys by identity is refused too, since two equal keys are two entries there, sent twice by a provider method or silently collapsed into one by the copy. The flow raises `ArgumentError` rather than `AuthorizationError` because `MCP::Client::HTTP` treats a failed refresh as a reason to run the interactive flow, which would then fail the same way after the user signed in. Both refusals raise `Flow::InvalidTokenRequestParamsError`, a subclass of `ArgumentError`, so a caller can tell them from an unknown keyword, and the copy duplicates keys as well as values, since `Hash` copies only keys whose class is exactly `String`. Fixes modelcontextprotocol#554. ## How Has This Been Tested? New tests cover every token request the parameters can ride (the `client_credentials` grant under all three client authentication methods, the authorization code exchange, refresh, and `jwt-bearer`), both refusal boundaries (the constructors of all three providers, and the flow for a provider defining the method), and the transport surfacing a refused hook from a refresh attempt without starting the interactive flow. All of them fail against the previous library. ## Breaking Changes None. The keyword is optional and the hook is opt-in; a provider that does not define `token_request_params` sends the same requests as before.
|
Thanks for turning this around so fast — One adjacent thing, for a separate change rather than this one. Filed as #558 — happy to open a PR for it. |
|
Thanks for the offer. I've opened PR #560. This lands the capability in a different shape: A recorder goes in as |
Motivation and Context
ClientCredentialsProviderbuilds a fixedclient_credentialstoken request:grant_type,scope,resource, and the client authentication thatFlow#post_to_token_endpointadds. An authorization server that requires further parameters, such as Auth0'saudience, cannot be used throughoauth:at all, and giving upoauth:also gives up the bearer header and the 401-driven retry that the transport provides.RFC 6749 Section 8.2 allows extension parameters on the token request, and the TypeScript SDK lets a provider shape its token request through
prepareTokenRequest.ClientCredentialsProvider.newnow takestoken_request_params:, a Hash of String keys and values added to every token request the provider makes, andFlow#post_to_token_endpointreads the same name by duck typing, so aProviderorCrossAppAccessProvidersubclass that defines the method gets the same treatment on its authorization code exchange, refresh, orjwt-bearerrequest.Provider.newandCrossAppAccessProvider.newtake the same keyword, held byStorageBackedProviderlikeauthorization_request_validator, so every bundled provider refuses a bad value before anything is stored.The parameters go underneath the flow's own, so the SDK's values always win, and a key the SDK sets itself (
Flow::RESERVED_TOKEN_REQUEST_PARAMS) is refused rather than silently overridden: withArgumentErrorfrom the constructor, before anyclient_informationis written, and again withArgumentErrorfrom the flow, before the token request is sent. Only Strings are accepted becauseURI.encode_www_formencodes other scalars and Arrays in ways the caller did not write, and the provider keeps a frozen copy so a later change to the caller's Hash cannot alter what is sent.A Hash comparing keys by identity is refused too, since two equal keys are two entries there, sent twice by a provider method or silently collapsed into one by the copy. The flow raises
ArgumentErrorrather thanAuthorizationErrorbecauseMCP::Client::HTTPtreats a failed refresh as a reason to run the interactive flow, which would then fail the same way after the user signed in. Both refusals raiseFlow::InvalidTokenRequestParamsError, a subclass ofArgumentError, so a caller can tell them from an unknown keyword, and the copy duplicates keys as well as values, sinceHashcopies only keys whose class is exactlyString.Fixes #554.
How Has This Been Tested?
New tests cover every token request the parameters can ride (the
client_credentialsgrant under all three client authentication methods, the authorization code exchange, refresh, andjwt-bearer), both refusal boundaries (the constructors of all three providers, and the flow for a provider defining the method), and the transport surfacing a refused hook from a refresh attempt without starting the interactive flow. All of them fail against the previous library.Breaking Changes
None. The keyword is optional and the hook is opt-in; a provider that does not define
token_request_paramssends the same requests as before.Types of changes
Checklist