jira_attachment_images

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

No annotations are provided, so the description carries the full burden. It discloses that the tool downloads images, returns YAML metadata, and manages output directories (temp if omitted). It does not mention permissions or rate limits, but the behavior is sufficiently transparent for a read-like operation.

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 extremely concise: two sentences plus a note. It front-loads the core purpose, then adds key details. Every sentence earns its place with 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?

The description covers the tool's action (download images), supported types, return format (YAML), and output directory behavior. It is complete for a simple tool with 2 parameters and no output schema. It could mention if it downloads all images or has a limit, but the schema does not include that either.

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 baseline is 3. The description mentions the output_dir behavior (temp dir if omitted), but this is already present in the schema description. It adds no new parameter semantics 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 clearly states that the tool downloads image attachments from a JIRA issue to disk, with a specific list of supported image formats (PNG, JPEG, GIF, SVG, WebP). It also notes the return value (YAML metadata). This makes it distinct from sibling tools like jira_attachment_delete or jira_attachment_download.

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 explains when to use the tool (to download image attachments) and provides behavior details (output directory handling, temp directory). However, it does not explicitly mention when not to use it or compare it to alternatives like jira_attachment_download, which might download non-image attachments as well.

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