feat: add per-request HTTP headers support for client session methods #1515
Conversation
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
Implements per-request headers functionality to enable various use cases such as multi-tenant authentication, request tracing, A/B testing, and debugging while maintaining a single persistent connection. Changes: - Add extra_headers parameter to ClientSession.call_tool() - Extend ClientMessageMetadata to support extra_headers - Update StreamableHTTPTransport to merge per-request headers - Add tests - Include usage examples and documentation - Maintain full backward compatibility This addresses GitHub issues modelcontextprotocol#1509 and supports multi-tenant scenarios where different requests require different authentication tokens or contextual headers. Future work will extend extra_headers support to other ClientSession methods (get_prompt, read_resource, etc.) based on maintainer feedback.
- Add 7 diverse usage examples covering tracing, A/B testing, debugging, auth, multi-tenancy - Include multi-tenant example function demonstrating practical usage patterns - Add proper error handling and realistic server endpoints - Update code snippets via automated script for consistency - Fix markdownlint formatting issues
damianoneill
changed the title
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.
Implements per-request headers functionality to enable various use cases such as multi-tenant authentication, request tracing, A/B testing, and debugging while maintaining a single persistent connection.
Changes:
This addresses GitHub issues #1509 and supports multi-tenant scenarios where different requests require different authentication tokens or contextual headers.
Future work (as part of this PR) will extend extra_headers support to other ClientSession methods (get_prompt, read_resource, etc.) based on maintainer feedback.
Motivation and Context
Disscussed in issue #1509
How Has This Been Tested?
UTs, commit provided for review, is approach is agreed will proceed with extensive real world testing before finalising this PR.
Breaking Changes
N/A
Types of changes
Checklist
Additional context