github_repos_delete_deployment

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

With no annotations, the description must disclose behavioral traits. It only states 'Delete', which implies a destructive action, but omits details on irreversibility, cascading effects (e.g., on deployment statuses), or required authentication level. The brevity leaves significant gaps.

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 extremely concise (3 words), which is structurally efficient. However, it is too brief, sacrificing essential context. It earns its place but does not balance brevity with informativeness.

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 destructive action like deleting a deployment, the description should clarify scope, reversibility, or prerequisites. Without output schema or behavioral notes, the description is incomplete, leaving the agent without critical context for safe invocation.

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%, but parameter descriptions are mere repetitions (e.g., 'owner', 'repo', 'deployment_id'). The tool description adds no extra meaning beyond the schema, meeting the baseline but not exceeding it.

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 verb 'Delete' and resource 'a deployment', making the tool's purpose unambiguous. However, it does not differentiate from sibling tools like 'github_repos_delete_deployment_branch_policy' or 'github_repos_delete_deployment_status', leaving the agent to infer the specific deployment type from the name.

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?

No guidance is provided on when to use this tool versus alternatives, nor any prerequisites or conditions for deletion. The description lacks context about required permissions or deployment state, forcing the agent to rely solely on the tool name.

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