Skip to content

Optimize capability and notification according to specification #184

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

Merged
merged 2 commits into from
Apr 22, 2025

Conversation

dugenkui03
Copy link
Collaborator

@dugenkui03 dugenkui03 commented Apr 21, 2025

Summary by CodeRabbit

  • New Features
    • Added notifications for changes to resources, prompts, and tools lists, as well as individual resource updates, improving real-time awareness for clients.
    • Enhanced client configuration options, allowing more flexible capability settings during client creation.
  • Bug Fixes
    • Improved error reporting by returning a more specific error code when a requested resource is not found.
  • Tests
    • Updated tests to use new notification constants and verify the correct error code for missing resources.

Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

Walkthrough

This update introduces enhancements to both client and server components of the system, focusing on capability management and notification mechanisms. On the client side, the Client struct now distinctly manages client and server capabilities, with new options and getter methods for better configurability and access. The server is updated to send conditional notifications to clients when lists of resources, prompts, or tools change, based on the capabilities negotiated with each client. New constants for notification method names and a specific error code for resource-not-found scenarios are defined. Associated tests are updated to use these constants and to expect the new error codes where appropriate.

Changes

Files/Paths Change Summary
client/client.go Refactored Client struct to separate client and server capabilities; introduced ClientOption type and WithClientCapabilities functional option; updated NewClient constructor to accept variadic options; added getter methods for client and server capabilities; changed JSON tag in initialization parameters from "capabilities" to "serverCapabilities".
mcp/types.go Added new MCP method constants for notifications on resources, prompts, and tools list changes; added RESOURCE_NOT_FOUND error code constant with value -32002.
server/server.go Updated resource, prompt, and tool addition/deletion methods to send conditional notifications based on respective listChanged capability flags; changed error code returned when no resource handler is found from INVALID_PARAMS to RESOURCE_NOT_FOUND.
server/server_test.go Replaced hardcoded notification method strings with defined constants; changed expected error code for undefined resource handler tests from INVALID_PARAMS to RESOURCE_NOT_FOUND; enabled tool capabilities in test server initialization.

📜 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 792e666 and 8ea296f.

📒 Files selected for processing (4)
  • client/client.go (5 hunks)
  • mcp/types.go (2 hunks)
  • server/server.go (6 hunks)
  • server/server_test.go (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • server/server_test.go
  • mcp/types.go
  • client/client.go
  • server/server.go

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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
client/client.go (1)

44-48: ⚠️ Potential issue

ClientOptions are not being applied in NewClient.

The options parameter is accepted but never applied to the client instance. The functional options won't have any effect.

Apply this fix:

func NewClient(transport transport.Interface, options ...ClientOption) *Client {
-	return &Client{
+	client := &Client{
		transport: transport,
	}
+	
+	// Apply all provided options
+	for _, option := range options {
+		option(client)
+	}
+	
+	return client
}
🧹 Nitpick comments (2)
client/client.go (1)

128-129: JSON field name may cause confusion.

The field name in the struct is Capabilities but it's tagged with json:"serverCapabilities". This mismatch between field name and JSON tag could cause confusion.

Consider renaming the field to match its JSON tag for clarity:

params := struct {
	ProtocolVersion string                 `json:"protocolVersion"`
	ClientInfo      mcp.Implementation     `json:"clientInfo"`
-	Capabilities    mcp.ClientCapabilities `json:"serverCapabilities"`
+	ServerCapabilities mcp.ClientCapabilities `json:"serverCapabilities"`
}{
	ProtocolVersion: request.Params.ProtocolVersion,
	ClientInfo:      request.Params.ClientInfo,
-	Capabilities:    request.Params.Capabilities, // Will be empty struct if not set
+	ServerCapabilities: request.Params.Capabilities, // Will be empty struct if not set
}
server/server.go (1)

465-470: Fix comment to reference prompts instead of resources.

The comment incorrectly refers to "resources" when it should refer to "prompts".

-	// When the list of available resources changes, servers that declared the listChanged capability SHOULD send a notification.
+	// When the list of available prompts changes, servers that declared the listChanged capability SHOULD send a notification.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9f39a43 and c5fa4ea.

📒 Files selected for processing (5)
  • client/client.go (5 hunks)
  • client/sse_test.go (1 hunks)
  • mcp/types.go (2 hunks)
  • server/server.go (6 hunks)
  • server/server_test.go (6 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (3)
server/server_test.go (3)
mcp/types.go (2)
  • MethodNotificationToolsListChanged (62-62)
  • RESOURCE_NOT_FOUND (245-245)
server/server.go (2)
  • NewMCPServer (375-401)
  • WithToolCapabilities (351-358)
examples/everything/main.go (1)
  • NewMCPServer (31-155)
client/client.go (2)
mcp/types.go (3)
  • JSONRPCNotification (206-209)
  • ClientCapabilities (323-333)
  • ServerCapabilities (338-361)
client/transport/interface.go (1)
  • Interface (11-27)
server/server.go (1)
mcp/types.go (4)
  • MethodNotificationResourcesListChanged (52-52)
  • MethodNotificationPromptsListChanged (58-58)
  • MethodNotificationToolsListChanged (62-62)
  • RESOURCE_NOT_FOUND (245-245)
🔇 Additional comments (15)
mcp/types.go (2)

49-63: Well-defined notification method constants.

These new notification method constants provide a standardized way to handle notifications for resource, prompt, and tool list changes, which improves code maintainability and reduces the risk of typos in string literals.


243-246: Good addition of specific error code for resource not found.

Adding a dedicated error code RESOURCE_NOT_FOUND provides better semantics than using the more generic INVALID_PARAMS for missing resources. This allows clients to handle this specific case more appropriately.

client/sse_test.go (1)

14-14: Naming updated for consistency.

The comment now correctly refers to "serverCapabilities" instead of just "capabilities", which aligns with the terminology changes in other files where client and server capabilities are now separate concepts.

server/server_test.go (3)

202-202: Good replacement of string literals with constants.

Using the defined constants like mcp.MethodNotificationToolsListChanged instead of hardcoded strings makes the code more maintainable and less prone to errors.

Also applies to: 244-245, 272-273, 297-299


864-864: Correctly updated error code for resource not found.

Updating from mcp.INVALID_PARAMS to the new mcp.RESOURCE_NOT_FOUND error code provides more specific error handling for missing resources.


315-315: Explicit capability configuration improves test clarity.

Adding WithToolCapabilities(true) explicitly in the test server creation clarifies that the tests expect tool capabilities to be enabled.

client/client.go (4)

19-25: Client struct now separates client and server capabilities.

Splitting the capabilities into clientCapabilities and serverCapabilities fields provides a clearer separation of concerns. This is a good architectural improvement.


27-34: Well-implemented functional options pattern.

The introduction of ClientOption and WithClientCapabilities follows the functional options pattern, which is a clean way to configure the client.


145-146: Good use of comments for clarity.

The comment clearly explains that the server capabilities are being stored, which enhances code readability.


420-428: Useful getter methods for capabilities.

Adding getters for both client and server capabilities provides a clean interface for accessing these fields without exposing the internal structure directly.

server/server.go (5)

420-425: Conditional notification for resource list changes looks good.

This enhancement properly implements capability-aware notifications for resource list changes, using the new constant from mcp/types.go. Notifications will only be sent to clients that have opted in through the capabilities system.


445-450: Capability-aware notification for resource templates implemented correctly.

The implementation correctly sends notifications for resource template changes only when the capability is enabled, maintaining consistency with the resource notification pattern.


492-496: Proper implementation of conditional tool notifications.

This change correctly updates the tool notification logic to be capability-aware, using the appropriate constant from mcp/types.go.


515-519: Consistent implementation of tool deletion notifications.

The conditional notification for tool deletions matches the pattern used for tool additions, maintaining consistency throughout the codebase.


748-752: Improved error code specificity for resource not found.

Changing the error code from INVALID_PARAMS to RESOURCE_NOT_FOUND provides a more accurate error representation, making the API more informative for clients. This aligns with the new error code defined in mcp/types.go.

@dugenkui03 dugenkui03 force-pushed the patch-server-capability branch from 023aab9 to 2e4f116 Compare April 21, 2025 15:55
@dugenkui03
Copy link
Collaborator Author

On my computer, all test run successfully

@dugenkui03 dugenkui03 changed the title WIP: optimize capability and notification according to specification Optimize capability and notification according to specification Apr 21, 2025
@dugenkui03 dugenkui03 force-pushed the patch-server-capability branch 2 times, most recently from cf4b6c8 to 792e666 Compare April 21, 2025 17:37
@dugenkui03 dugenkui03 force-pushed the patch-server-capability branch from 792e666 to 8ea296f Compare April 21, 2025 17:39
@ezynda3
Copy link
Contributor

ezynda3 commented Apr 22, 2025

This is great! Thanks for this!

@ezynda3 ezynda3 merged commit 781b732 into mark3labs:main Apr 22, 2025
2 checks passed
wangchaodeyuzhou pushed a commit to wangchaodeyuzhou/mcp-go that referenced this pull request Apr 23, 2025
wangchaodeyuzhou pushed a commit to wangchaodeyuzhou/mcp-go that referenced this pull request Apr 25, 2025
wangchaodeyuzhou pushed a commit to wangchaodeyuzhou/mcp-go that referenced this pull request Apr 30, 2025
wangchaodeyuzhou pushed a commit to wangchaodeyuzhou/mcp-go that referenced this pull request Apr 30, 2025
adlternative pushed a commit to adlternative/mcp-go that referenced this pull request May 20, 2025
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