Delete attachment

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

Goes well beyond the lone idempotentHint annotation: it discloses that references remain dangling while the file itself is removed, that the action is irreversible, that user confirmation is requested, and even the cost (one API call, ~0.4s). These are exactly the consequences an agent needs before firing a destructive call.

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?

A single tight sentence front-loads the action and its key, then stacks consequence, irreversibility, confirmation, and cost without padding. Every clause carries information an agent can act on.

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 required parameter, no output schema, and no nested objects, the definition covers everything needed: what to pass, where to get it, what happens after, and the interaction cost. Nothing material is missing for a correct 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% so the 'hash' parameter is already documented, but the description adds provenance ('from qase_attachment_upload'), telling the agent where a valid value comes from rather than just its type. That is genuine added meaning over the thin schema description.

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?

Opens with a specific verb+resource ('Delete an attachment') and identifies the identifying key ('by its hash'), immediately distinguishing it from siblings like qase_attachment_upload. An agent knows exactly what this tool does without opening the schema.

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?

Points the agent to qase_attachment_upload as the source of the hash and notes a user-confirmation step before execution. It gives clear context for invoking the tool but does not enumerate when-not-to-use conditions, which is minor for a terminal delete operation.

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