Download Attachments

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

The description provides extensive detail beyond the readOnlyHint annotation, explaining base64 encoding, the distinction between EmbeddedResource and TextContent returns, MIME type handling, and the rationale (#1419). This is exactly the kind of behavioral transparency that helps an agent know what to expect.

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 front-loaded with the primary action, then efficiently explains the return format and nuances. Every sentence serves a purpose, and the length is justified by the need to clarify base64 and MIME types.

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 no output schema, the description fully compensates by explaining what the tool returns: base64 content, EmbeddedResource for images, and TextContent for others. The single well-documented parameter plus detailed return behavior makes the tool complete for an agent to use correctly.

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 schema already fully covers the only parameter 'issue_key' with a pattern and example, and the description does not add additional parameter details. With 100% schema description coverage, the baseline of 3 is appropriate.

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 'Download attachments from a Jira issue' with a specific verb and resource. It distinguishes itself from sibling tools like 'jira_get_issue_images' by covering all attachment types, not just images.

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 context is clear: use this tool to retrieve attachment contents from a Jira issue. While it does not explicitly mention alternative tools or when-not-to-use, the purpose is unambiguous given the description and tool name.

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