[feat] separate request struct #333

OswinWu · 2025-05-26T07:10:41Z

Description

Fixes #<issue_number> (if applicable)

Type of Change

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
MCP spec compatibility implementation
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Code refactoring (no functional changes)
Performance improvement
Tests only (no functional changes)
Other (please describe):

Checklist

My code follows the code style of this project
I have performed a self-review of my own code
I have added tests that prove my fix is effective or that my feature works
I have updated the documentation accordingly

MCP Spec Compliance

This PR implements a feature defined in the MCP specification
Link to relevant spec section: Link text
Implementation follows the specification exactly

Additional Information

This PR aims to avoid anonymous struct

Summary by CodeRabbit

Refactor
- Improved the organization of request parameters for better clarity and maintainability. No changes to user-facing functionality.

coderabbitai · 2025-05-26T07:18:12Z

"""

Walkthrough

Multiple structs in the mcp package were refactored by replacing anonymous inline Params structs with named parameter struct types. This change was applied consistently across several request and notification types in mcp/types.go, as well as in mcp/tools.go and mcp/prompts.go, without modifying fields or JSON tags.

Changes

Files	Change Summary
mcp/tools.go	Replaced anonymous `Params` struct in `CallToolRequest` with named `CallToolParams` struct.
mcp/prompts.go	Replaced anonymous `Params` struct in `GetPromptRequest` with named `GetPromptParams` struct.
mcp/types.go	Replaced anonymous `Params` structs with named parameter structs in multiple types including `Request`, `CancelledNotification`, `InitializeRequest`, `ProgressNotification`, `PaginatedRequest`, `ReadResourceRequest`, `SubscribeRequest`, `UnsubscribeRequest`, `ResourceUpdatedNotification`, `SetLevelRequest`, `LoggingMessageNotification`, `CreateMessageRequest`, and `CompleteRequest`.

Possibly related issues

Extract Params from CallToolRequest into a Named Struct #108: This change directly implements the suggested refactor to use a named struct for Params in CallToolRequest, improving readability and testability.

Possibly related PRs

feat(protocol): allow additional fields in meta #293: Also modifies the CallToolRequest.Params.Meta field by changing it to a named Meta type with custom JSON marshaling, related by working on the same struct but at different abstraction levels.

Suggested labels

type: enhancement, area: mcp spec
"""

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 96f1b3b and a283d23.

📒 Files selected for processing (1)

mcp/types.go (9 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

mcp/types.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.

dugenkui03 · 2025-05-26T07:28:28Z

what is the advantage of this change,

and why not change other xxxPromptRequest together?

// GetPromptRequest is used by the client to get a prompt provided by the
// server.
type GetPromptRequest struct {
	Request
	Params struct {
		// The name of the prompt or prompt template.
		Name string `json:"name"`
		// Arguments to use for templating the prompt.
		Arguments map[string]string `json:"arguments,omitempty"`
	} `json:"params"`
}

OswinWu · 2025-05-26T07:55:13Z

what is the advantage of this change,

and why not change other xxxPromptRequest together?

// GetPromptRequest is used by the client to get a prompt provided by the
// server.
type GetPromptRequest struct {
	Request
	Params struct {
		// The name of the prompt or prompt template.
		Name string `json:"name"`
		// Arguments to use for templating the prompt.
		Arguments map[string]string `json:"arguments,omitempty"`
	} `json:"params"`
}

As far as I know, this change will make calling code simpler
current:

CallTool(ctx, mcp.CallToolRequest{
		Params: struct {
			Name      string    `json:"name"`
			Arguments any       `json:"arguments,omitempty"`
			Meta      *mcp.Meta `json:"_meta,omitempty"`
		}{Name: name, Arguments: argument, Meta: nil},
	})

after:

CallTool(ctx, mcp.CallToolRequestParams{
			Name: name,
            Arguments: argument,
            Meta: nil,
		},)

As for other requests, I'm sorry that I forgot to change that.
I will close this pr and create a new one with all the changes if this change is ok.
Thank you for your time.

dugenkui03 · 2025-05-26T09:24:44Z

@OswinWu It would be great if you could include other xxxRequest as well. you could update this pr.

OswinWu · 2025-05-26T10:34:18Z

sure

OswinWu · 2025-05-27T06:19:32Z

I have processed other requests. Please let me know if there's any request I forgot to change.

dugenkui03

thanks for your update, I have some concerns:

for so many structs with one or two fields, anonymous nested struct seems to be better choice, because anonymous nested struct seems more clear and new struct will not be used by other struct
the 'xxxRequestParams' naming style seems strange.

OswinWu · 2025-05-27T15:30:49Z

From my point of view, this change will be easier to use, as mentioned in this issue. As for the naming style, I haven't come up with other thoughts😢. Do you have any other great ideas?

dugenkui03 · 2025-05-28T03:54:41Z

thanks for you present more details.

as for the naming style, how about xxParams, similar to the style of NotificationParams

OswinWu · 2025-05-28T04:39:22Z

Sure, that's a good idea!

pottekkat

LGTM. Seems like there are more places where we use anonymous structs. Maybe we can also change that in other places. It can be a separate PR.

[feat] separate CallToolRequest

64cea69

dugenkui03 self-requested a review May 26, 2025 09:24

dugenkui03 assigned dugenkui03 and unassigned dugenkui03 May 26, 2025

[feat] change other request params

e581ab8

OswinWu changed the title ~~[feat] separate CallToolRequest~~ [feat] separate request struct May 26, 2025

dugenkui03 reviewed May 27, 2025

View reviewed changes

[style] change naming style of structs

96f1b3b

dugenkui03 approved these changes May 28, 2025

View reviewed changes

dugenkui03 requested a review from ezynda3 May 28, 2025 05:13

dugenkui03 added type: enhancement New feature or enhancement request area: sdk SDK improvements unrelated to MCP specification labels May 28, 2025

pottekkat approved these changes May 29, 2025

View reviewed changes

Merge branch 'main' into feat/separate-CallToolRequstParams

a283d23

pottekkat merged commit bfc3773 into mark3labs:main May 29, 2025
4 checks passed

pottekkat mentioned this pull request May 29, 2025

Extract Params from CallToolRequest into a Named Struct #108

Open

coderabbitai bot mentioned this pull request Jun 20, 2025

task: add _meta field to relevant types as defined in MCP specification #429

Open

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[feat] separate request struct #333

[feat] separate request struct #333

Uh oh!

OswinWu commented May 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 26, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

dugenkui03 commented May 26, 2025

Uh oh!

OswinWu commented May 26, 2025 •

edited

Loading

Uh oh!

dugenkui03 commented May 26, 2025

Uh oh!

OswinWu commented May 26, 2025

Uh oh!

OswinWu commented May 27, 2025

Uh oh!

dugenkui03 left a comment

Uh oh!

OswinWu commented May 27, 2025

Uh oh!

dugenkui03 commented May 28, 2025 •

edited

Loading

Uh oh!

OswinWu commented May 28, 2025

Uh oh!

pottekkat left a comment

Uh oh!

Uh oh!

Uh oh!

[feat] separate request struct #333

[feat] separate request struct #333

Uh oh!

Conversation

OswinWu commented May 26, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

MCP Spec Compliance

Additional Information

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested labels

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

dugenkui03 commented May 26, 2025

Uh oh!

OswinWu commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dugenkui03 commented May 26, 2025

Uh oh!

OswinWu commented May 26, 2025

Uh oh!

OswinWu commented May 27, 2025

Uh oh!

dugenkui03 left a comment

Choose a reason for hiding this comment

Uh oh!

OswinWu commented May 27, 2025

Uh oh!

dugenkui03 commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OswinWu commented May 28, 2025

Uh oh!

pottekkat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

OswinWu commented May 26, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

OswinWu commented May 26, 2025 •

edited

Loading

dugenkui03 commented May 28, 2025 •

edited

Loading