get_application_diff

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

No annotations are provided, so the description carries full burden. It correctly frames this as a non-mutating preview ('would be created... if sync were triggered'), which is good behavioral disclosure. However, it doesn't mention what happens with the output format, whether it's safe/read-only explicitly, or rate-limit considerations. The 'dry-run diff' framing implies read-only, which is acceptable but not exhaustive.

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 short sentences, zero waste. States purpose, what it shows, and when to use it. Perfectly front-loaded and economical.

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 read-only diff-preview tool with an output schema available, the description covers the essential context: what it does, what it returns conceptually, and when to use it. It could mention that this is non-destructive or that it relates to sync_application, but the output schema presumably covers the return structure. Adequate for a tool of this complexity.

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 carries full burden for parameters, but it adds zero parameter-level detail. The schema itself documents name (application name), instance (ArgoCD instance name), and revision (target revision). Given the params are self-explanatory in the schema and the description's purpose is clear, baseline 3 is appropriate. The description doesn't add semantics beyond what the schema gives.

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 clearly states the tool previews a dry-run diff of sync changes (create/update/delete). It's distinct from sync_application (which triggers the sync) and get_application_status (which shows current state). Clear verb+resource+scope, though it doesn't explicitly name sibling alternatives.

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 explicitly says 'Use this before syncing to understand the impact,' which provides clear timing guidance. It implies this is a pre-sync checkpoint tool distinct from the sync_application siblings. However, it doesn't give explicit 'when NOT to use' guidance or name alternatives.

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