mcp-go icon indicating copy to clipboard operation
mcp-go copied to clipboard

feat: add request header

Open wlxwlxwlx opened this issue 7 months ago • 9 comments

Add the request header to mcp.Request so that users can use the header to handle business logic in the hooks function.

Summary by CodeRabbit

  • New Features
    • Added support for passing and accessing HTTP headers in server requests, enabling features like authorization and header-based filtering.
  • Tests
    • Updated tests to include header information in server request handling.
    • Added a new test to verify header-based filtering of tools based on authorization tokens.

wlxwlxwlx avatar Apr 14 '25 02:04 wlxwlxwlx

Walkthrough

A new Header field was added to the Request struct, and the HandleMessage method in the server was updated to accept and propagate a header map. All relevant server, SSE, stdio, and client code, as well as tests, were updated to accommodate the new header parameter, including a new test for header-based filtering.

Changes

Files/Paths Change Summary
mcp/types.go Added Header map[string]string field to the Request struct.
server/request_handler.go Updated HandleMessage method signature to accept a header map and assign it to request structs.
server/sse.go, server/streamable_http.go Extracted HTTP headers into a map and passed it to HandleMessage.
server/stdio.go, client/transport/inprocess.go Updated calls to HandleMessage to include an empty header map argument.
client/client.go Removed an extraneous blank line in sendRequest; no logic changes.
server/server_test.go Updated all HandleMessage test calls to include a header map; added TestMCPServer_HandleWithHeader for header-based filtering.
server/resource_test.go, server/session_test.go Updated all HandleMessage test calls to include an authorization header map.

Suggested reviewers

  • robert-jackson-glean
  • ezynda3

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2 Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2ea4efc5d32574d10bfbb451782c121d27337e1 and 4386a9e9733e4a71915ffe495f149a40b409f904.

📒 Files selected for processing (1)
  • server/request_handler.go (11 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • server/request_handler.go
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Apr 14 '25 02:04 coderabbitai[bot]

This PR enables the request headers received by the server launched in SSE to be read within the hook function. I have already resolved the conflicts and hope that it can be merged.

wlxwlxwlx avatar Apr 30 '25 09:04 wlxwlxwlx

I added a testing. I retrieve the token from the header to filter different permissions and allow returning different tools lists.

wlxwlxwlx avatar May 12 '25 02:05 wlxwlxwlx

Is there any update to this? I'd like to get Auth header to differentiate users for my remote servers, and I'd prefer not to use a fork to do so

0xNF avatar Jun 02 '25 03:06 0xNF

If the only concern is with the naming of the field (i.e Header) then can we close that by renaming it to something like "RequestMetadata" ? I do agree that "Header" is not apt as this is more of a protocol addition rather than transport.

arun11299 avatar Jun 06 '25 10:06 arun11299

If it can be merged, I think the field name can be changed. I still think this feature is necessary.

wlxwlxwlx avatar Jun 11 '25 01:06 wlxwlxwlx

@wlxwlxwlx Thank you. Can you raise review with the suggested changes from @rwjblue-glean ?

arun11299 avatar Jun 11 '25 03:06 arun11299

For my use case, I see that in the latest code CallToolRequest has Meta fieds wherein additional information can be passed.

toolCallRequest := mcp.CallToolRequest{}
toolCallRequest.Params.Name = toolCall.Name
toolCallRequest.Params.Arguments = toolCall.Args
toolCallRequest.Params.Meta = &mcp.Meta{
	AdditionalFields: meta,
}

I am pretty sure this is new addition and was not there in the previous code version that I was having.

arun11299 avatar Jun 11 '25 11:06 arun11299

This is exactly the feature I’ve been looking for. Is there any plan to merge it?

leisurelicht avatar Jun 13 '25 01:06 leisurelicht