diff_solutions

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

Annotations already mark the operation as readOnlyHint=true and openWorldHint=false. The description adds useful behavioral context: it accepts zips or unpacked folders, treats formula changes as 'small diffs', and falls back to reporting changed files for anything not explicitly modeled. No contradiction with annotations exists.

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?

The description is a single dense sentence with a clear front-loaded purpose, followed by a structured enumeration of comparison categories. It is efficient and free of filler, though the long comma-separated list could benefit from light formatting for readability.

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?

The description covers a broad and complex comparison surface, but significant gaps remain: parameter semantics are undocumented, and with no output schema the agent is not told anything about the shape or nature of the returned diff. For a tool this complex, that leaves the definition only partially complete.

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%, so the description must compensate for the three parameters. It only indirectly references the two solution versions and formula changes, but never names old, new, or max_formula_changes, and gives no guidance on how paths are provided or what the max_formula_changes limit controls.

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 opens with a specific verb and resource ('What changed between two versions of a solution') and enumerates the concrete dimensions covered: tables, columns, relationships, canvas apps, flows, env vars, and changed files. This clearly differentiates diff_solutions from siblings like export_solution or list_tables.

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?

The description implies the tool is used to compare two solution versions, giving examples like two export_solution outputs. However, it does not explicitly state when to use this tool over alternatives, nor does it mention any exclusions or prerequisites beyond the basic input format.

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