deploy_release_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 discloses return structure (release-to-release diff buckets and migrations.applied_between_releases) and error handling (semantic gateway errors preserved). It does not explicitly state it's read-only or mention rate limits, but the diff nature implies no side effects.

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 two sentences, front-loading the purpose and valid inputs in the first sentence, and output/errors in the second. Every sentence is informative and no words are wasted.

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?

Given no output schema and no annotations, the description adequately covers behavior: parameter expectations, return type, and error handling. It could be slightly more detailed on what 'diff buckets' contain, but is generally complete for agent usage.

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 100%, and the description adds some context by repeating and slightly expanding on allowed values for from and to (empty, active, release id) and mentioning the limit default (1000). However, this adds limited value beyond the schema descriptions.

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 it diffs two release targets for a project, using a specific verb and resource. It distinguishes from siblings like deploy_release_get by focusing on comparison, and specifies valid input values ('from may be empty, active, or a release id; to may be active or a release id').

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 specifies valid inputs for both parameters and notes that semantic gateway errors are preserved, implying appropriate usage. However, it does not explicitly mention when to use this tool over alternatives like deploy_release_get or deploy_list.

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