Skip to content

feat(MCPServer): send log message notifications to specific client #301

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

Closed
wants to merge 4 commits into from

Conversation

cryo-zd
Copy link
Contributor

@cryo-zd cryo-zd commented May 18, 2025

Description

 This PR enables MCPServer to send log message notifications to specific client according to the specification
workflow

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

  • New Features
    • Introduced server-to-client log message notifications, allowing clients to receive log messages based on their configured log level.
  • Bug Fixes
    • Improved error handling and validation for sending log messages to clients.
    • Clarified error message regarding session support for logging level operations.
  • Tests
    • Added comprehensive tests covering various scenarios for sending log messages to clients, including filtering by log level and error conditions.

Copy link
Contributor

coderabbitai bot commented May 18, 2025

"""

Walkthrough

The changes introduce a new server-to-client logging notification mechanism. This includes defining a new MCP method constant, mapping logging levels to RFC-5424 severity codes, and adding logic to determine if a message should be sent based on client subscription level. A method is added to the server for sending log notifications, and comprehensive tests are implemented to verify this functionality under various scenarios. Additionally, an error message was clarified to reflect support for both setting and getting logging levels.

Changes

File(s) Change Summary
mcp/types.go Added MethodNotificationMessage constant, mapping from logging level strings to RFC-5424 severity codes, and the Allows method to determine if a log message should be sent based on subscription level.
mcp/utils.go Modified NewLoggingMessageNotification to use the new MethodNotificationMessage constant instead of a hardcoded string for the method name.
server/session.go Added SendLogMessageToClient method to MCPServer for sending log message notifications to clients, with logic for capability checking, session validation, level filtering, and error handling.
server/session_test.go Added tests for the new log message sending functionality, including scenarios for disabled logging, invalid sessions, invalid messages, channel blocking, and log level filtering. Also included minor formatting and error message improvements.
server/errors.go Updated error message for ErrSessionDoesNotSupportLogging to clarify support for both setting and getting logging level.

Possibly related PRs

Suggested labels

type: enhancement, area: mcp spec
"""

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

Note

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


📜 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 d0e3734 and de45823.

📒 Files selected for processing (1)
  • mcp/types.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • mcp/types.go
✨ 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 requested review from pottekkat and rwjblue-glean and removed request for pottekkat May 18, 2025 04:18
@cryo-zd cryo-zd marked this pull request as ready for review May 19, 2025 09:08
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. We can merge this.

@dugenkui03
Copy link
Collaborator

hi @pottekkat @cryo-zd It's a great idea to support this feature, but this implement is not what I think.

for example, how develops use this function, they can not access SendLogMessageToClient in their tool_function.

I think the python-sdk is a good reference example, it allow develop send log message in tool function:

@mcp.tool()
async def long_task(files: list[str], ctx: Context) -> str:
   """Process multiple files with progress tracking"""
   for i, file in enumerate(files):
       ctx.info(f"Processing {file}")
       await ctx.report_progress(i, len(files))
       data, mime_type = await ctx.read_resource(f"file://{file}")
   return "Processing complete"

@dugenkui03
Copy link
Collaborator

Also, we need to consider compatibility with both cancelled_notification and progress_notification, maybe there are some design ideas they could share.

@pottekkat
Copy link
Collaborator

Relaying the discussion we had in the Discord server. The current implementation has limitations that make it difficult for developers to use the log notifications effectively within tool handlers. Ideally, we want to implement a more idiomatic way to handle these logs, maybe similar to the logging package in the standard library where the SDK does the heavy lifting and offer neat abstractions for Go developers that are intuitive and familiar.

We can merge this PR and open a new issue to track this improvement because it will be a breaking change. We have to plan out how to implement this and @dugenkui03 can include his thoughts.

@dugenkui03
Copy link
Collaborator

@pottekkat I agree with that and create another issue #321.

And I left another comment for this pr: how about change the type of LoggingLevel from string to int

@cryo-zd
Copy link
Contributor Author

cryo-zd commented May 24, 2025

@pottekkat I agree with that and create another issue #321.

And I left another comment for this pr: how about change the type of LoggingLevel from string to int

picked from: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/schema/2025-03-26/schema.json

        "LoggingLevel": {
            "description": "The severity of a log message.\n\nThese map to syslog message severities, as specified in RFC-5424:\nhttps://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1",
            "enum": [
                "alert",
                "critical",
                "debug",
                "emergency",
                "error",
                "info",
                "notice",
                "warning"
            ],
            "type": "string"
        },

May be string is better for consistency?

@dugenkui03
Copy link
Collaborator

@cryo-zd thank you present more details, and I agree with you.

@cryo-zd cryo-zd closed this May 26, 2025
@pottekkat
Copy link
Collaborator

Ok, so we are reimplementing this as per the new proposal in #329 and this was closed.

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.

3 participants