analyze_rollback_readiness

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

With no annotations, the description carries the full burden. It describes the scanning, classification, and return fields (rollback_eligible, blocking_migrations, deployment_strategy), implying a read-only operation. It does not mention edge cases or permissions, but the core behavior is transparently disclosed.

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 compact sentence that front-loads the action and includes concrete file patterns, outputs, and usage context. Every phrase adds value with no wasted words.

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 one parameter, no output schema, and no annotations, the description provides a solid picture of what the tool does and returns. It covers purpose, examples, outputs, and usage timing. It could elaborate on classification details or error cases, but the core is sufficiently complete for an agent to invoke it correctly.

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% (repo_path described as 'Absolute path to the repository root to scan for migration files'). The description adds no new semantics beyond the schema, so the baseline of 3 applies.

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 a specific action (scans a repository) and resource (versioned database migration files), and specifies the classification (additive vs destructive). It also names output fields, distinguishing it from sibling tools that focus on test failure analysis.

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?

Explicitly states when to use ('Use before recommending deployment') and the goal (determine rollback safety after go-live). It does not mention when not to use, but the clear context is sufficient given the unrelated sibling tools.

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