jira_attachment_images

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

No annotations provided, so description must disclose behavioral traits. It mentions file types and default directory but omits critical details: whether it is read-only, overwrite behavior, authentication requirements, or rate limits. Incomplete for a file download tool.

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?

Three concise sentences front-load the action and key details. No redundant or superfluous information. Efficiently conveys the tool's purpose and defaults.

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 simple parameters and no output schema, the description covers the essential workflow: download images, return YAML metadata, default output directory. Missing details on the metadata structure or error handling, but acceptable for a straightforward tool.

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 parameters are well-documented. The description adds a useful default behavior for 'output_dir' (temp directory). No additional semantics for 'key' beyond schema. Meets baseline for a well-documented schema.

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?

Clearly states the tool downloads image attachments (PNG, JPEG, GIF, SVG, WebP) from a JIRA issue to disk, returning YAML metadata. Differentiates from generic attachment tools by specifying image types and by noting it mirrors a specific CLI command.

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?

Implied usage context (downloading image attachments) but no explicit guidance on when to use this vs. the sibling 'jira_attachment_download'. No when-not-to-use or alternative mentioned.

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