Release Readiness Check

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

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds value by detailing what the tool returns (blocking issues, rollback template, etc.) and required token scopes, complementing the annotations without contradiction.

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 well-structured with a topic sentence, token scopes, parameter list, and return summary. Every sentence is necessary, no fluff, and information is front-loaded for quick scanning.

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 the tool complexity (6 params, nested object, output schema exists), the description covers the essentials: what it does, what it returns, and parameter behavior. Could be slightly more explicit about the output schema structure, but overall adequate.

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%, so baseline is 3. The description goes beyond the schema by explaining fallbacks (owner/repo), deprecation (baseRef), and defaults (headRef default branch), adding practical context for parameter usage.

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's a pre-release assessment and lists specific checks (CI status, open bugs, CHANGELOG, etc.), but does not explicitly differentiate from sibling tools like quality_gate_status or branch_protection_status, which could be confused.

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 provides token scopes and parameter details, but lacks explicit guidance on when to use this tool versus alternatives. No comparative context is given, requiring the agent to infer usage.

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