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

Optimize capability and notification according to specification

Open dugenkui03 opened this issue 7 months ago • 2 comments

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.

dugenkui03 avatar Apr 21 '25 15:04 dugenkui03

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 792e666cbc26564ed7c70ea5c24fc90927bde9fb and 8ea296f5d0e06e0082d1337d97124ae39318c714.

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

coderabbitai[bot] avatar Apr 21 '25 15:04 coderabbitai[bot]

On my computer, all test run successfully

dugenkui03 avatar Apr 21 '25 15:04 dugenkui03

This is great! Thanks for this!

ezynda3 avatar Apr 22 '25 17:04 ezynda3