Skip to content

Export SendNotificationToAllClients #176

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

Conversation

scottfeldman
Copy link
Contributor

@scottfeldman scottfeldman commented Apr 19, 2025

[First PR to project]

Export sendNotificationToAllClients so it can be called from the MCP server to send unsolicited notifications to all clients (sessions).

I have a use-case for my MCP server where I need to send notifications of state change to all sessions. My MCP server is fronting a device hub, and the device's on the hub would like to send notifications up to the LLM.

There is probably a reason why this was not exported, so please forgive this PR if that's the case. I just could not figure out what the spec says about this.

In any case, I added a test and tested with the Inspector. The Inspectory sees the unsolicited notifications. Cool! I also tried with Cursor and Claude, but neither seem to recognize notifications, no matter how hard I tried to convince them.

Summary by CodeRabbit

  • Tests
    • Added tests to verify that notifications are correctly sent to all active client sessions.

[First PR to project]

Export sendNotificationToAllClients so it can be called from the MCP
server to send unsolicited notifications to all clients (sessions).

I have a use-case for my MCP server where I need to send notifications
of state change to all sessions.  My MCP server is fronting a device
hub, and the device's on the hub would like to send notifications up
to the LLM.

There is probably a reason why this was not exported, so please forgive
this PR if that's the case.  I just could not figure out what the spec
says about this.

In any case, I added a test and tested with the Inspector.  The
Inspectory sees the unsolicited notifications.  Cool!  I also tried with
Cursor and Claude, but neither seem to recognize notifications, no
matter how hard I tried to convince them.
Copy link
Contributor

coderabbitai bot commented Apr 19, 2025

Walkthrough

This change makes the sendNotificationToAllClients method of the MCPServer struct exported by renaming it to SendNotificationToAllClients, updating all internal references accordingly. Additionally, a new test function is introduced to verify that notifications are correctly sent to all active client sessions. The test ensures that each session receives the expected notifications and that no extra notifications remain in the session channels after processing.

Changes

Files Change Summary
server/server.go Renamed and exported sendNotificationToAllClients to SendNotificationToAllClients; updated references in AddTools and DeleteTools methods.
server/server_test.go Added TestMCPServer_SendNotificationToAllClients to test notification delivery to all active sessions.

Possibly related PRs

  • Add per-session notifications handling #46: Originally introduced the sendNotificationToAllClients method, per-session notification handling, and session management, which are directly affected by this PR's changes.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 71b910b and d453b0b.

📒 Files selected for processing (2)
  • server/server.go (3 hunks)
  • server/server_test.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
server/server_test.go (2)
server/server.go (3)
  • MCPServer (143-166)
  • ClientSession (54-63)
  • NewMCPServer (375-401)
mcp/types.go (2)
  • JSONRPCNotification (192-195)
  • Params (104-104)
🔇 Additional comments (7)
server/server.go (4)

214-215: Good change to export the function for external usage.

The capitalization of the function name from sendNotificationToAllClients to SendNotificationToAllClients properly exports this method, allowing external packages to call it directly. This aligns with the PR objective of enabling the MCP server to send unsolicited notifications to all connected clients.


214-239: The implementation is robust for concurrent session handling.

The implementation correctly:

  1. Handles concurrent access to the sessions map using sync.Map
  2. Only sends notifications to initialized sessions
  3. Uses a non-blocking send to avoid getting stuck on full channels
  4. Continues iteration even if some notification channels are blocked

This makes the function reliable for use with many concurrent clients.


475-475: References properly updated to use the exported function name.

The internal call has been correctly updated to use the exported function name.


495-495: References properly updated to use the exported function name.

The internal call has been correctly updated to use the exported function name.

server/server_test.go (3)

576-643: Well-structured test for the newly exported function.

This test comprehensively validates the functionality of SendNotificationToAllClients by:

  1. Creating multiple active sessions with buffered notification channels
  2. Sending multiple notifications with different parameters
  3. Verifying that all sessions receive each notification with correct parameters in sequence
  4. Checking that no extra notifications remain in the channels

The test covers the primary use case and edge cases effectively.


592-598: Good test data with incrementing values.

Using incrementing values in the notification parameters allows the test to verify both the reception of notifications and their correct ordering, which is important for ensuring deterministic behavior.


600-631: Thorough validation of notifications in each session.

The test correctly:

  1. Iterates through all registered sessions
  2. Verifies method names
  3. Checks that parameters match the expected values
  4. Ensures the notifications are received in the correct order
  5. Confirms no extra notifications remain

This level of detail in the test helps ensure the function works as expected in all scenarios.

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

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.

@ezynda3 ezynda3 merged commit ee6757f into mark3labs:main Apr 20, 2025
2 checks passed
@scottfeldman scottfeldman deleted the send-notification-to-all-sessions branch April 20, 2025 08:56
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