bursia_json_diff
Compare two JSON documents and list added, removed and changed paths (max 500). Pure computation, free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | Yes | ||
| before | Yes |
Compare two JSON documents and list added, removed and changed paths (max 500). Pure computation, free.
| Name | Required | Description | Default |
|---|---|---|---|
| after | Yes | ||
| before | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotation readOnlyHint=true plus openWorldHint=false already establish that this is a safe, closed-world read, and 'pure computation, free' reinforces that with cost/side-effect context the annotations do not carry. The 'max 500' cap is a genuinely useful disclosure about output truncation. However, nothing is said about what happens on invalid JSON input, what the path notation looks like, or whether arrays are compared by index or content.
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 tight sentence plus a short qualifier; zero filler, and the core capability is front-loaded before the cost/limit note.
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 two-input pure function with no output schema, the description says what shape the result takes (added/removed/changed paths) and notes the 500 cap, which covers the essentials. It omits input encoding expectations and truncation semantics (are extra diffs dropped, or is an error returned), which matter for correct invocation.
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 are bare 'type: string' with no descriptions. The phrase 'two JSON documents' gestures at before/after, but with JSON documents normally being objects, an agent is left guessing whether it must pass serialized JSON strings or raw objects — a real failure mode for a single required parameter mistake. The description does not close that gap.
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?
Specific verb + resource + output shape: 'Compare two JSON documents and list added, removed and changed paths'. It clearly separates itself from siblings like bursia_json_format, bursia_json_validate and bursia_json_path, which operate on a single document or extract a path rather than diffing two.
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?
Usage is implied (use it when you have a before and an after JSON document), and 'pure computation, free' signals there is no cost or side effect to worry about. But no alternatives are named and no exclusions or preconditions are given, e.g. nothing tells the agent to validate malformed inputs first or to prefer bursia_json_path for single-document queries.
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.