Skip to content

DRAFT - HttpRequest.Builder customizer #388

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Kehrlann
Copy link
Contributor

@Kehrlann Kehrlann commented Jul 11, 2025

⚠️ This a draft PR, to start a discussion. It is NOT a full implementation, has no tests, lacks docs, etc.

Provide a way to customize HTTP requests before executing them, for both HttpClientSseClientTransport and HttpClientStreamableHttpTransport.

We introduce AsyncHttpRequestCustomizer, which is the core class that does the heavy lifting. For blocking contexts, we provide a simpler SyncHttpRequestCustomizer API, which ultimately gets wrapped. The details of the implementation in both transports is not relevant (yet) ; we are focused on both customizers and also on the transpots, specifically:

  • AsyncHttpRequestCustomizer
  • SyncHttpRequestCustomizer
  • HttpClientSseClientTransport.Builder#requestCustomizer
  • HttpClientStreamableHttpTransport.Builder#requestCustomizer

Motivation and Context

These are transport-level hooks, to allow users to modify request, e.g. to add security in headers (OAuth2 tokens, API keys, etc).

How Has This Been Tested?

Tested with a Servlet Spring app, using SyncHttpRequestCustomizer.

Breaking Changes

No.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Copy link
Contributor

@tzolov tzolov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kehrlann I think this would work.
What about the webflux clients. would we need to expose a similar customizer abstractions there as well?

/**
* In reactive, DONT USE THIS. Use AsyncHttpRequestCustomizer.
*/
public Builder httpRequestCustomizer(SyncHttpRequestCustomizer syncHttpRequestCustomizer) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels awkward. Perhaps we should leave only the async method and let the user convert the sync customizer outside

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point.

I’m trying to ensure sync-based users don’t have to think about async versions of this API at all. My goal is for the user to make a “sync customizer” and only have to worry about that. Making the transformation outside is one more layer they’d have to think about (and that we would have to explain in the docs).
Also, we’ve had feedback from people absolutely NOT wanting to deal with async.

let me know what you think; happy to make the change to “only async” if you think it’s more confusing than helpful.

@Kehrlann
Copy link
Contributor Author

Nice! I’ll tidy up the PR then.

for WebClient-based transport, the WebClient has transformation primitives already (for ex ExchangeFilterFunction), so no need to add an MCP-specific customizer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants