Compare two snapshots

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

With no annotations, the description carries the full behavioral burden and does so well: it discloses that noise (ids, audit info, connection ids) is stripped, that it writes <reportDir>/<a>-vs-<b>.md and .json, and that failOnDrift turns drift into an error result. This is meaningful side-effect and error-behavior context beyond the schema.

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 tight three-sentence paragraph that front-loads what is compared, then output locations, then the gate behavior. Nearly every clause carries information, with only mild density from the enumerated comparison targets.

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?

With no output schema, the description compensates by naming the two artifact files produced, and it explains the drift-gate return behavior. For a 7-parameter diff tool this covers what an agent needs, though a few parameters (ignoredKeys, strictVariables) remain unexplained.

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 coverage is 71%, so the schema documents most parameters. The description adds context for reportDir (write location pattern) and failOnDrift (error-on-drift), but says nothing about ignoredKeys, includeDiffs, or strictVariables, leaving a gap it could have filled. Baseline 3 is appropriate.

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 and resource ('offline diff of two snapshot folders') and enumerates exactly what is compared (solution version, per-agent YAML, flows, connections, env vars, unpublished changes). The 'offline diff of folders' framing implicitly distinguishes it from live-environment siblings like cs_compare_environments, but 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?

Usage is implied rather than stated: the reader infers this is for stage-to-stage folder comparison, and 'for pipeline gates' hints at the failOnDrift use case. However, there is no explicit when-to-use guidance or exclusion against cs_check_drift or cs_compare_environments, which the agent must disambiguate on its own.

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