jira_attachment_delete

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

The description discloses the tool's destructive nature with 'DESTRUCTIVE AND IRREVERSIBLE (JIRA has no trash)'. It also explains the confirm guard and the tool's behavior when confirm is not provided, as well as the return format. With no annotations, the description carries the full burden and does so thoroughly.

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 three sentences long, each serving a distinct purpose: stating the action, emphasizing destructiveness, and explaining the confirm guard and return format. It is front-loaded with the most critical information and contains no fluff.

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 simplicity of the tool (2 required params, no output schema, no annotations), the description covers the essential aspects: purpose, destructive nature, confirm requirement, and return format. It could optionally mention error cases or side effects, but overall it is complete enough for effective use.

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?

The input schema already provides descriptions for both parameters. The description adds value by explaining that confirm must be set to true to proceed, and that without it the tool returns an error without contacting the API. This goes beyond what the schema provides.

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 explicitly states 'Delete a JIRA attachment by ID', which is a clear verb+resource. It distinguishes from sibling tools like jira_attachment_download and jira_attachment_upload by focusing on deletion.

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 clear usage guidance: it warns that the deletion is destructive and irreversible, and mandates the confirm: true parameter. However, it does not explicitly state when to use this tool versus alternatives (e.g., when deletion is appropriate).

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