Cancel Deployment

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

Annotations already indicate mutating and non-idempotent. The description adds helpful detail about using deployment UUID vs application UUID. However, it does not disclose side effects, reversibility, or error consequences.

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?

Single sentence, front-loaded with the action and key differentiating detail. 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?

For a straightforward cancellation tool, the description is adequate but lacks information about return values or error conditions. No output schema exists to compensate.

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 100%; parameters are well-documented. The description adds slight value by specifying the source of deployment UUID (coolify_deploy or coolify_list_deployments).

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 (cancel), target (deployment), state (running or queued), and identifier (deployment UUID, not application UUID). It distinguishes from sibling tools like coolify_deploy or coolify_get_deployment.

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 implies when to use the tool (when a deployment is running or queued and needs cancellation), but does not explicitly state when not to use it or compare to alternatives.

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