Skip to content

feat(sse): Add SessionWithTools support to SSEServer #232

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 1 commit into from
May 1, 2025

Conversation

rwjblue-glean
Copy link
Collaborator

@rwjblue-glean rwjblue-glean commented May 1, 2025

Implement SessionWithTools interface for sseSession to support session-specific tools:

  • Add tools field to sseSession struct
  • Implement GetSessionTools and SetSessionTools methods

Summary by CodeRabbit

  • New Features

    • Improved session management to support storing and retrieving session-specific tools.
  • Tests

    • Added comprehensive tests to verify session tool management and ensure thread safety during concurrent access.

Implement SessionWithTools interface for sseSession to support
session-specific tools:

- Add tools field to sseSession struct
- Implement GetSessionTools and SetSessionTools methods
Copy link
Contributor

coderabbitai bot commented May 1, 2025

Walkthrough

The changes introduce session-specific tool management to the sseSession struct in the SSE server implementation. A new tools field using sync.Map is added, along with methods to set and retrieve these tools. Interface compliance is updated to reflect the new capabilities. Corresponding tests are added to verify correct and thread-safe behavior of session tool management, including concurrent access scenarios. No changes were made to other logic or exported entities outside of these additions.

Changes

File(s) Change Summary
server/sse.go Added a tools field to sseSession for session-specific tools; implemented GetSessionTools and SetSessionTools methods; updated interface compliance assertions.
server/sse_test.go Added a subtest to TestSSEServer to verify session tool management and concurrent access; minor adjustment to HTTP request variable declaration.

📜 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 eadd702 and 06fff84.

📒 Files selected for processing (2)
  • server/sse.go (2 hunks)
  • server/sse_test.go (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
server/sse_test.go (6)
server/session.go (1)
  • ClientSession (11-20)
server/server.go (3)
  • NewMCPServer (276-302)
  • WithHooks (235-239)
  • ServerTool (50-53)
examples/everything/main.go (1)
  • NewMCPServer (31-160)
server/sse.go (1)
  • NewTestServer (242-248)
mcp/tools.go (5)
  • Tool (69-80)
  • Description (222-226)
  • ToolAnnotation (133-144)
  • Title (238-242)
  • CallToolResult (34-41)
mcp/utils.go (1)
  • NewToolResultText (221-230)
server/sse.go (2)
server/server.go (1)
  • ServerTool (50-53)
server/session.go (2)
  • ClientSession (11-20)
  • SessionWithTools (23-31)
🔇 Additional comments (6)
server/sse.go (4)

31-31: Good addition of thread-safe tools storage.

The use of sync.Map is appropriate here as it's designed for concurrent use cases without additional locking, which aligns well with the session handling in an SSE server where multiple requests might interact with the same session.


62-71: Clean implementation of GetSessionTools().

This method properly iterates over the sync.Map, type-asserts each value to ServerTool, and builds a regular map to return. The implementation correctly provides thread-safe access to session tools as required by the SessionWithTools interface.


73-84: Well-implemented SetSessionTools().

The method correctly handles thread safety by:

  1. First clearing all existing tools
  2. Then storing the new tools in the sync.Map

This approach ensures atomic-like behavior when replacing the entire tool set, which is important for maintaining consistency during concurrent operations.


86-89: Good practice with interface compliance assertions.

The updated assertions ensure compile-time checking of interface implementation for both ClientSession and SessionWithTools. This helps catch potential interface mismatches early in the development process.

server/sse_test.go (2)

669-670: Minor code style improvement.

Separated variable declaration from assignment, which improves readability and is generally considered better practice in Go.


1134-1242: Excellent test coverage for the new SessionWithTools functionality.

This comprehensive test:

  1. Verifies that tools can be set and retrieved correctly
  2. Tests thread safety through concurrent operations from multiple goroutines
  3. Ensures tools remain accessible and consistent after concurrent access

The test is thorough and covers both basic functionality and edge cases. It effectively verifies that the sseSession implementation of the SessionWithTools interface behaves correctly and is thread-safe, which is critical for a server component.

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

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.

@rwjblue-glean
Copy link
Collaborator Author

@SamMorrowDrums - Related to #179 (in case you also need this functionality for the SSEServer).

@ezynda3 ezynda3 merged commit 3ba0c91 into mark3labs:main May 1, 2025
2 checks passed
@rwjblue-glean rwjblue-glean deleted the rwjblue/push-pwvonmstvxyr branch May 1, 2025 14:56
adlternative pushed a commit to adlternative/mcp-go that referenced this pull request May 20, 2025
Implement SessionWithTools interface for sseSession to support
session-specific tools:

- Add tools field to sseSession struct
- Implement GetSessionTools and SetSessionTools methods
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