fix(tools): add `omitempty` to properties #116

jkoelker · 2025-04-07T00:14:01Z

When there is no input to a tool, the Properies map is nil if the Tool is not created using NewTool. This causes the property field to be set to null and clients such as claude-desktop to skip the tools silently.

Annotating the field as omitempty is inline with the behavior of the typescript-sdk.

Summary by CodeRabbit

New Features
- Improved JSON responses by omitting empty data fields, resulting in cleaner and more concise outputs.

coderabbitai · 2025-04-07T00:14:09Z

Walkthrough

The change modifies the JSON serialization behavior for the Properties field in the ToolInputSchema struct defined in mcp/tools.go. The update adds the omitempty directive to the JSON tag, ensuring that the field is omitted from the JSON output when it is empty or nil.

Changes

File	Change Summary
mcp/tools.go	Updated `Properties` field in `ToolInputSchema` struct: modified JSON tag from `json:"properties"` to `json:"properties,omitempty"` to omit empty values.

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 1931cb6 and 4fceacf.

📒 Files selected for processing (1)

mcp/tools.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

mcp/tools.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 plan to trigger planning for file edits and PR creation.
@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.

resurgence72 · 2025-04-08T03:07:40Z

@jkoelker hi, in my case, when i use non params tools, My AI app (dify with mcp-agent) will report errors. This is a record of our discussion at that time (junjiem/dify-plugin-agent-mcp_sse#1 (comment)), when I deleted the omitempty field, everything was fine. So I'm confused right now. @ezynda3 hi, can we confirm this case together?

jkoelker · 2025-04-08T04:01:33Z

@resurgence72 as per the spec (same for the 2024 version) only the type is required and currently it can only ever be object all other fields are optional. The alternative here is to force the json.Marshal to return {} as the value.

I think that the error actually lies in the dify's use of PromptMessageTool, but i didn't look further into what they are actually doing with it because they just #yolo the pydantic definition as dict instead of saying that they require a dict schema.

Just going off the code at https://github.com/junjiem/dify-plugin-agent-mcp_sse/blob/main/strategies/ReAct.py#L579 I think it could be handled it in a way that is more compatible with the spec:

for tool in mcp_tools:
    parameters = tool.get("inputSchema")
    if "properties" not in parameters:
        parameters["properties"] = {}

    prompt_message = PromptMessageTool(
        name=tool.get("name"),
        description=tool.get("description", None),
        parameters=parameters,
    )
    prompt_messages_tools.append(prompt_message)

resurgence72 · 2025-04-08T04:16:54Z

@resurgence72 as per the spec (same for the 2024 version) only the type is required and currently it can only ever be object all other fields are optional. The alternative here is to force the json.Marshal to return {} as the value.

I think that the error actually lies in the dify's use of PromptMessageTool, but i didn't look further into what they are actually doing with it because they just #yolo the pydantic definition as dict instead of saying that they require a dict schema.

Just going off the code at https://github.com/junjiem/dify-plugin-agent-mcp_sse/blob/main/strategies/ReAct.py#L579 I think it could be handled it in a way that is more compatible with the spec:
for tool in mcp_tools:
    parameters = tool.get("inputSchema")
    if "properties" not in parameters:
        parameters["properties"] = {}

    prompt_message = PromptMessageTool(
        name=tool.get("name"),
        description=tool.get("description", None),
        parameters=parameters,
    )
    prompt_messages_tools.append(prompt_message)

Thank you for your reply. I ignored schema.json before, and I think your modification is correct. I will feedback this problem to the developers of dify-mcp in the future

When there is no input to a tool, the `Properies` map is `nil` if the Tool is not created using `NewTool`. This causes the `property` field to be set to `null` and clients such as `claude-desktop` to skip the tools silently. Annotating the field as `omitempty` is inline with the behavior of the [typescript-sdk](https://github.com/modelcontextprotocol/typescript-sdk/blob/fbdeb06a4185ba2f7581603a768cd7171c64d6fc/src/types.ts#L749).

jkoelker · 2025-04-11T03:29:56Z

rebased on main to pick up the race condition fix.

This was referenced Apr 8, 2025

agent节点使用 mcp策略报错 junjiem/dify-plugin-agent-mcp_sse#1

Closed

need optimize the mcp logic for the case of empty properties field junjiem/dify-plugin-agent-mcp_sse#18

Closed

jkoelker force-pushed the omit_properties branch from 1931cb6 to 4fceacf Compare April 11, 2025 03:28

jcooky mentioned this pull request Apr 16, 2025

Arguments type is too much strict #104

Closed

ezynda3 merged commit 7335e3a into mark3labs:main Apr 16, 2025
2 checks passed

HChengH mentioned this pull request Apr 29, 2025

When register a tool with no input argument (no need to pass any args) The properties field is missing #224

Closed

cryo-zd mentioned this pull request Apr 29, 2025

fix: marshal ToolInputSchema.Properties to {} when len=0 #225

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(tools): add `omitempty` to properties #116

fix(tools): add `omitempty` to properties #116

Uh oh!

jkoelker commented Apr 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 7, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

resurgence72 commented Apr 8, 2025 •

edited

Loading

Uh oh!

jkoelker commented Apr 8, 2025

Uh oh!

resurgence72 commented Apr 8, 2025

Uh oh!

jkoelker commented Apr 11, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(tools): add omitempty to properties #116

fix(tools): add omitempty to properties #116

Uh oh!

Conversation

jkoelker commented Apr 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

resurgence72 commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jkoelker commented Apr 8, 2025

Uh oh!

resurgence72 commented Apr 8, 2025

Uh oh!

jkoelker commented Apr 11, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(tools): add `omitempty` to properties #116

fix(tools): add `omitempty` to properties #116

jkoelker commented Apr 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

resurgence72 commented Apr 8, 2025 •

edited

Loading