download_issue_attachment

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

Annotations only declare readOnlyHint=true; the description goes further by disclosing the return modality per file type (images as image content, text as text, binaries as base64), which materially affects how the agent consumes the result. It omits size limits, rate limits, or permission requirements, keeping it short of a 5.

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?

Two tightly packed sentences with zero filler, and the core behavior (content download and its return format) is front-loaded ahead of the optional-parameter tip.

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 correctly carries the burden of explaining what comes back, and it covers the optional filename behavior. It is complete for calling the tool, though it leaves the relationship to sibling attachment tools unaddressed.

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 description coverage is 100%, so all three parameters are already documented. The description's note that filename is auto-resolved when omitted restates the schema's own "auto-resolved if omitted" text rather than adding new meaning, so the baseline 3 applies.

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?

States a specific verb and resource ("Download attachment content") with clear scope, so an agent immediately knows this fetches the file bytes rather than metadata. It does not, however, distinguish itself from close siblings such as get_issue_attachment, download_entity_attachment, or get_attachment_thumbnail.

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?

Usage is implied rather than stated: you call it when you need the actual file content, and the auto-resolve note implies filename can be skipped. There is no explicit when-not guidance or named alternative (e.g. use get_issue_attachment for metadata only).

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