delete_deployment

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

No annotations are provided, so the description carries full burden. It states this is a deletion operation, implying it's destructive, but doesn't disclose critical behavioral traits like whether deletion is permanent, requires specific permissions, has side effects on related resources, or returns detailed error messages. The mention of a 'Confirmation message' return is minimal behavioral context.

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 appropriately brief and front-loaded with the core purpose in the first sentence. The Args/Returns sections are structured but could be more integrated. No unnecessary information is included, though it could be slightly more detailed without losing conciseness.

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 destructive nature (implied by 'Delete'), lack of annotations, no output schema, and 0% schema coverage, the description is incomplete. It doesn't cover error cases, side effects, permissions, or detailed return values beyond a generic confirmation. For a deletion tool with significant behavioral implications, this leaves too many contextual gaps.

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 must compensate. It adds that 'deployment_id' is a 'UUID', which provides format context beyond the schema's generic string type. However, it doesn't explain where to find this ID or validate it, leaving gaps. With one parameter and some added semantics, this meets the baseline for minimal compensation.

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 action ('Delete') and target resource ('a deployment by ID'), making the purpose immediately understandable. It distinguishes from siblings like 'delete_flow' or 'delete_flow_run' by specifying the deployment resource type. However, it doesn't explicitly differentiate from 'cancel_flow_run' which might also terminate deployments indirectly.

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 about when to use this tool versus alternatives. While the description specifies deleting by ID, it doesn't mention prerequisites (e.g., whether the deployment must be stopped first), consequences (e.g., what happens to associated flow runs), or when to choose this over similar tools like 'delete_flow' or 'cancel_flow_run'.

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