Add optional headers argument to websocket transport#455
Closed
andrewmjc wants to merge 3 commits intomodelcontextprotocol:mainfrom
Closed
Add optional headers argument to websocket transport#455andrewmjc wants to merge 3 commits intomodelcontextprotocol:mainfrom
andrewmjc wants to merge 3 commits intomodelcontextprotocol:mainfrom
Conversation
ihrpr
requested changes
May 23, 2025
Contributor
ihrpr
left a comment
There was a problem hiding this comment.
Thank you!
Please address minor suggestions in the comments.
Contributor
|
Closing this PR, looks stale now. Please re-open if the changes are still needed and suggestions applied. |
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.
This is a small PR to expose the additional_headers param on ws_connect through a new 'headers' argument in the websocket transport
Motivation and Context
This enables users to pass through custom headers that the MCP server might require for auth, remote customization, version headers, or otherwise. Currently, the SSE transport supports settings headers, but the WS transport does not.
I am aware that the JS Websocket implementation only allows setting the Sec-WebSocket-Protocol header, so adding headers to all SDKs might be tricky, but I think it's better to expose the ability to set these headers where we can.
How Has This Been Tested?
Will work the exact same as the current WS transport. The receiving server can now view the headers sent in the handshake request.
Breaking Changes
No breaking changes
Types of changes
Checklist
Additional context