Skip to content

Fix bug with MarshalJSON for NotificationParams #233

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 2, 2025

Conversation

Gelembjuk
Copy link
Contributor

@Gelembjuk Gelembjuk commented May 1, 2025

I have noticed the bug when tried to work with a server notifications to clients.
I have used the method SendNotificationToAllClients

The argument params is later used to build the notification := mcp.JSONRPCNotification object.

When this object is serialised to JSON then the dict "params" is always empty. Values originally provided to SendNotificationToAllClients are ignored and not sent to a clients.

This happens because of the

func (p *NotificationParams) MarshalJSON() ([]byte, error) {

was used by a pointer but

type Notification struct {
	Method string             `json:"method"`
	Params NotificationParams `json:"params,omitempty"`
}

So, or Params NotificationParams json:"params,omitempty"`` should be set by a pointer or a pointer should be removed from func (p NotificationParams) MarshalJSON() ([]byte, error) {

Summary by CodeRabbit

  • Refactor
    • Updated internal handling of JSON marshaling for notifications to improve consistency. No changes to visible functionality.

Copy link
Contributor

coderabbitai bot commented May 1, 2025

Walkthrough

The MarshalJSON method for the NotificationParams type in mcp/types.go was updated to use a value receiver instead of a pointer receiver. The internal implementation of the method, which handles the marshaling of the struct to JSON, remains unchanged. No other files or methods were modified.

Changes

File(s) Change Summary
mcp/types.go Changed the MarshalJSON method receiver for NotificationParams from pointer to value receiver.

📜 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 3ba0c91 and 0ccdab9.

📒 Files selected for processing (1)
  • mcp/types.go (1 hunks)
🔇 Additional comments (1)
mcp/types.go (1)

135-135: Great fix for the JSON serialization issue.

Changing the receiver of the MarshalJSON method from a pointer receiver to a value receiver is the correct solution for this bug. This change ensures proper JSON serialization of the NotificationParams field in the Notification struct.

The bug occurred because the Notification struct defines Params as a non-pointer NotificationParams type, but the MarshalJSON method was implemented with a pointer receiver. With the previous implementation, the JSON marshaling interface would not be satisfied when a value type was used, causing the params to be ignored during serialization.

Now, the custom marshaling code will be invoked for both value instances and pointer instances of NotificationParams.

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

@ezynda3 ezynda3 merged commit f3fef81 into mark3labs:main May 2, 2025
2 checks passed
adlternative pushed a commit to adlternative/mcp-go that referenced this pull request May 20, 2025
Co-authored-by: Roman Gelembjuk <Roman Gelembjuk>
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