Skip to content

feat(tools): implicitly register capabilities #292

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 15, 2025
Merged

feat(tools): implicitly register capabilities #292

merged 1 commit into from
May 15, 2025

Conversation

david-hamilton-glean
Copy link
Contributor

@david-hamilton-glean david-hamilton-glean commented May 14, 2025 •
edited by coderabbitai bot
Loading

Description

When users add tools via AddTool or AddSessionTool, implicitly set the tools capability. If the user has not already called WithToolCapabilities, then default listChanged to true, but honor any existing value.

This mimics the behavior of the official typescript sdk, which registers tools.listChanged: true when the user adds a tool to the MCP server.

See the discussion in #290 for more context.

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

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability when adding tools or session tools by ensuring tool capabilities are always properly initialized.
  • Tests
    • Added new tests to verify correct initialization and behavior of tool capabilities under different server configurations.

@david-hamilton-glean
feat(tools): implicitly register capabilities
9022e8a 
When users add tools via AddTool or AddSessionTool, implicitly set the
tools capability.  If the user has not already called
WithToolCapabilities, then default listChanged to true, but honor any
existing value.

This mimics the behavior of the official typescript sdk, which registers
`tools.listChanged: true` when the user adds a tool to the MCP server.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 14, 2025 •
edited
Loading

Walkthrough

This change introduces an internal method to the MCPServer that ensures the server's tool capabilities are initialized before tools are added, affecting both global tool addition and session-specific tool addition. New tests are included to verify the correct initialization and state of the tool capability under various server configuration options.

Changes

Files/Group Change Summary
server/server.go, server/session.go Added implicitlyRegisterToolCapabilities to MCPServer and updated AddTools and AddSessionTools to call this method.
server/server_test.go Added TestMCPServer_ToolCapabilitiesBehavior to verify tool capability initialization and listChanged flag behavior.
server/session_test.go Added TestMCPServer_SessionToolCapabilitiesBehavior to test session tool capability initialization and flag state.

Possibly related PRs

Suggested reviewers

  • robert-jackson-glean

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

[!ANNOUNCEMENT]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

[!ANNOUNCEMENT]

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 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 c1e70f3 and 9022e8a.

📒 Files selected for processing (4)
  • server/server.go (1 hunks)
  • server/server_test.go (1 hunks)
  • server/session.go (1 hunks)
  • server/session_test.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
server/session_test.go (3)
server/server.go (4)
  • ServerOption (28-28)
  • MCPServer (125-150)
  • WithToolCapabilities (251-258)
  • NewMCPServer (275-301)
mcp/types.go (1)
  • JSONRPCNotification (206-209)
mcp/tools.go (1)
  • NewTool (166-188)
🔇 Additional comments (5)
server/server.go (2)

414-432: Good implementation of capabilities initialization with proper concurrency handling.

The implementation properly handles concurrency with RLock/RUnlock pattern and only escalates to a full Lock when needed. The method ensures the tools capability is initialized with listChanged: true by default, aligning with the behavior mentioned in the PR description.

435-437: LGTM - Ensuring capabilities are registered before adding tools.

Adding the call to implicitlyRegisterToolCapabilities() at the beginning of AddTools ensures the tools capability is always initialized before tools are added, even if the user didn't explicitly call WithToolCapabilities.

server/session.go (1)

227-228: Good consistency between server and session tool registration.

Adding the call to implicitlyRegisterToolCapabilities() in AddSessionTools ensures consistent behavior between server-wide and session-specific tools.

server/server_test.go (1)

1628-1669: Good test coverage for the new implicit capability registration.

The test thoroughly verifies the behavior of implicitlyRegisterToolCapabilities for both scenarios:

  1. When no tool capabilities are provided, listChanged defaults to true
  2. When explicitly set with WithToolCapabilities(false), the value remains false

This ensures the implementation respects both implicit defaults and explicit configuration.

server/session_test.go (1)

806-860: Good complementary test for session tool capabilities.

This test complements the server test by verifying the same behavior in the context of session tools. It confirms that the implicit capability registration works consistently across both regular and session tools.

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

@pottekkat pottekkat mentioned this pull request May 15, 2025
Merged
16 tasks
pottekkat
pottekkat approved these changes May 15, 2025
View reviewed changes
Copy link
Collaborator

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you.

@rwjblue-glean rwjblue-glean merged commit e7d2547 into mark3labs:main May 15, 2025
4 checks passed
@rwjblue-glean rwjblue-glean added the type: enhancement New feature or enhancement request label May 15, 2025
@david-hamilton-glean david-hamilton-glean deleted the hjdivad/add-tools-with-no-cap branch May 15, 2025 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pottekkat pottekkat pottekkat approved these changes

@rwjblue-glean rwjblue-glean rwjblue-glean approved these changes

Assignees
No one assigned
Labels
type: enhancement New feature or enhancement request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@david-hamilton-glean @pottekkat @rwjblue-glean