Skip to content

feat: add message to ProgressNotification #119

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 2 commits into from
Apr 19, 2025

Conversation

xhdd123321
Copy link
Contributor

@xhdd123321 xhdd123321 commented Apr 7, 2025

Hello. I noticed that the 3.26 version specification added a message field for progress updates. However, I couldn’t find it in the current Golang SDK. This PR added an optional message field to ProgressNotificationParams according to latest mcp spec.

It's helpful for #77

image

image

I have verified the change with MCP Inspector. It works fine.

image

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Introduced an optional progress message that displays the current completion percentage during long-running operations.
    • Enhanced notifications by providing human-readable progress details for better client feedback.

Copy link
Contributor

coderabbitai bot commented Apr 7, 2025

Walkthrough

The changes include adding an optional message element to progress notifications. In the example code, a new key-value pair is added to the notification map that formats the progress percentage. Additionally, the progress notification structure is updated to include a new optional Message field. The notification utility function is modified to accept an optional message parameter and assigns it to the new field if provided.

Changes

File(s) Change Summary
examples/.../main.go Added a new "message" key in the notification map within the handleLongRunningOperationTool function. This key formats and displays the server's progress percentage.
mcp/types.go, mcp/utils.go Introduced an optional Message field (type string, with JSON omitempty) to the Params struct in the progress notification type. Modified the NewProgressNotification function to accept an optional message parameter and assign it accordingly.

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 3f51f6e and 98e7731.

📒 Files selected for processing (1)
  • mcp/utils.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • mcp/utils.go

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

@xhdd123321
Copy link
Contributor Author

@ezynda3 Hello, looks like all the checks have passed. Could you please review/merge this?

@ezynda3 ezynda3 merged commit 5378d0f into mark3labs:main Apr 19, 2025
2 checks passed
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