json_diff
Diff two JSON documents and return added/removed/changed keys.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| left | Yes | ||
| right | Yes |
Diff two JSON documents and return added/removed/changed keys.
| Name | Required | Description | Default |
|---|---|---|---|
| left | Yes | ||
| right | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. It does disclose the return semantics (added/removed/changed keys), which is genuine value, but it omits whether the diff is deep/recursive or top-level only, and what happens on invalid JSON input.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero filler. It is appropriately tight for a simple utility, though it is terse enough that it leaves the gaps noted in other dimensions.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a pure stateless diff utility with no output schema and no annotations, the definition is minimally adequate but thin. The output structure (flat key list vs. nested paths, change representation) is never described, and input format expectations are unstated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the two parameters ('left', 'right') are undocumented in both schema and description. The phrase 'two JSON documents' loosely maps them to the two operands, but it does not clarify whether they are raw JSON strings, file paths, or how nested structures are compared, leaving a real gap at full required-parameter coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb ('Diff'), the resource ('two JSON documents'), and the output shape ('added/removed/changed keys'). This implicitly separates it from the sibling text_diff, since key-level diffing is a different operation than textual line diffing, though no sibling is named explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus text_diff, nor any prerequisites such as whether inputs must be valid JSON or how malformed input is handled. The agent must infer usage entirely from the one-line purpose statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.