json_diff

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark it readOnly; the description adds that the output is a structured diff with JSONPath locations, going beyond the schema. It doesn't detail order handling or exact response schema, but for a read-only compare utility this is sufficient.

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?

Three sentences, each earning its place: purpose in the first, output detail in the second, use cases in the third. No filler or repetition.

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 simple, read-only comparison tool with full schema parameter coverage, the description covers what it does, what the output looks like, and typical use cases. No output schema exists, but the description's 'structured diff with JSONPath locations' provides enough for an agent to understand the return.

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 100%, so the schema already documents original/modified/ignore_order. The description adds no new parameter details beyond restating that two JSON objects are compared, so it meets the baseline.

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?

States a specific verb ('Compare'), resource ('two JSON objects'), and output ('structured diff' with additions/deletions/changes and JSONPath locations). Clearly distinguishes from sibling JSON tools like format_json or validate_json_schema.

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?

Provides clear use cases ('comparing API responses, config files, or database records'), establishing when this tool is appropriate. Does not explicitly name alternative tools or exclusion conditions, so slightly below the best examples.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.