mcp-go icon indicating copy to clipboard operation
mcp-go copied to clipboard

fix: Prevent panic in parsing functions for null results

Open cocovs opened this issue 8 months ago • 4 comments

This PR addresses a potential panic in ParseGetPromptResult, ParseCallToolResult, and ParseReadResourceResult. The panic could occur if the input rawMessage pointer is nil, as json. Unmarshal would attempt to dereference this nil pointer.

The functions now check for a nil rawMessage at the beginning. Instead of proceeding (which would lead to a panic) or returning (nil, nil), they now return nil for the result object and a specific error (fmt. Errorf("rawMessage is nil")).

Reasoning:

While a nil rawMessage could conceptually represent a null JSON value, in the context of the expected protocol (e.g., Model Context Protocol), receiving a nil message pointer without a preceding transport-level error is often indicative of an upstream issue or a protocol violation.

Returning an explicit error in this scenario, rather than (nil, nil), provides clearer feedback about unexpected input and helps surface potential problems in the data source or transport layer, rather than silently treating it as a valid "empty" response. This approach prioritizes stricter input validation and better error visibility.

Fixes #207

Summary by CodeRabbit Bug Fixes Enhanced the stability of message parsing functions (ParseGetPromptResult, ParseCallToolResult, ParseReadResourceResult) by adding checks for nil input messages, preventing potential crashes and returning specific errors instead.

cocovs avatar Apr 28 '25 06:04 cocovs

"""

Walkthrough

The update introduces nil-pointer checks at the beginning of three parsing functions within mcp/utils.go: ParseGetPromptResult, ParseCallToolResult, and ParseReadResourceResult. Each function now immediately returns an error if the input rawMessage pointer is nil, thereby preventing potential panics that would occur if further processing was attempted on a nil pointer. No other functional logic or error handling has been altered.

Changes

Files / Grouped Files Change Summary
mcp/utils.go Added explicit nil-pointer checks at the start of ParseGetPromptResult, ParseCallToolResult, and ParseReadResourceResult to return an error if input is nil.

Assessment against linked issues

Objective Addressed Explanation
Add nil-pointer checks to prevent panics in ParseCallToolResult, ParseGetPromptResult, ParseReadResourceResult (#207)
"""

📜 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 d0453d835fb46055a68cd7eafdd976e247174e0a and 6510b4ef797e2ac707f16bd1cd2154083e9013ed.

📒 Files selected for processing (1)
  • mcp/utils.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • mcp/utils.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.
    • 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.

coderabbitai[bot] avatar Apr 28 '25 06:04 coderabbitai[bot]

It seems that transport will never return nil-result and nil-error at the same time.

also see spec: https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio

The server MUST NOT write anything to its stdout that is not a valid MCP message.

dugenkui03 avatar Apr 28 '25 12:04 dugenkui03

It seems that transport will never return nil-result and nil-error at the same time.

also see spec: https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio

The server MUST NOT write anything to its stdout that is not a valid MCP message.

Thank you for the feedback and for pointing out the MCP specification. I agree that, according to the MCP spec (https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio), the transport layer should only output valid MCP messages to stdout, meaning a nil rawMessage should not occur in a compliant implementation. However, to ensure robustness and prevent potential panics (e.g., if an upstream issue or non-compliant transport layer results in a nil rawMessage), the PR adds a check for nil rawMessage and returns an explicit error (fmt. Errorf("rawMessage is nil")) instead of (nil, nil). This approach aligns with defensive programming practices, providing clearer error visibility and helping to surface protocol violations or transport-layer issues for debugging. The updated PR description clarifies this reasoning, emphasizing that returning an error prioritizes strict input validation over silently treating nil as a valid "empty" response. Please let me know if you think we should handle this differently or if further adjustments are needed!

cocovs avatar Apr 29 '25 14:04 cocovs

It seems that transport will never return nil-result and nil-error at the same time. also see spec: https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio

The server MUST NOT write anything to its stdout that is not a valid MCP message.

Thank you for the feedback and for pointing out the MCP specification. I agree that, according to the MCP spec (https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio), the transport layer should only output valid MCP messages to stdout, meaning a nil rawMessage should not occur in a compliant implementation. However, to ensure robustness and prevent potential panics (e.g., if an upstream issue or non-compliant transport layer results in a nil rawMessage), the PR adds a check for nil rawMessage and returns an explicit error (fmt. Errorf("rawMessage is nil")) instead of (nil, nil). This approach aligns with defensive programming practices, providing clearer error visibility and helping to surface protocol violations or transport-layer issues for debugging. The updated PR description clarifies this reasoning, emphasizing that returning an error prioritizes strict input validation over silently treating nil as a valid "empty" response. Please let me know if you think we should handle this differently or if further adjustments are needed!

how about “response is nil” instead of “rawMessage is nil”, because error message below use “response/failed to unmarshal response”

dugenkui03 avatar Apr 30 '25 03:04 dugenkui03

It seems that transport will never return nil-result and nil-error at the same time. also see spec: https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio

The server MUST NOT write anything to its stdout that is not a valid MCP message.

Thank you for the feedback and for pointing out the MCP specification. I agree that, according to the MCP spec (https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio), the transport layer should only output valid MCP messages to stdout, meaning a nil rawMessage should not occur in a compliant implementation. However, to ensure robustness and prevent potential panics (e.g., if an upstream issue or non-compliant transport layer results in a nil rawMessage), the PR adds a check for nil rawMessage and returns an explicit error (fmt. Errorf("rawMessage is nil")) instead of (nil, nil). This approach aligns with defensive programming practices, providing clearer error visibility and helping to surface protocol violations or transport-layer issues for debugging. The updated PR description clarifies this reasoning, emphasizing that returning an error prioritizes strict input validation over silently treating nil as a valid "empty" response. Please let me know if you think we should handle this differently or if further adjustments are needed!

how about “response is nil” instead of “rawMessage is nil”, because error message below use “response/failed to unmarshal response”

Thank you for your suggestion! I agree—using “response is nil” makes the error message more consistent with the existing ones like “failed to unmarshal response.” I’ve updated the code accordingly.

cocovs avatar May 01 '25 06:05 cocovs