get_attachment

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered without the description. The description adds no behavioral context of its own — it does not clarify whether the result is metadata or binary content, which is the one ambiguity that matters here given the sibling get_attachment_content.

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?

A single short, front-loaded sentence with zero waste. It is arguably under-specified rather than over-long, but as a sizing judgement the text is efficient.

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?

An output schema exists so return values need not be explained, but the definition leaves the metadata-vs-content distinction with get_attachment_content entirely unresolved, which is the main invocation risk for this tool in this sibling set.

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 0%, but there is only one parameter, an integer named attachment_id, whose meaning is self-evident. The description's 'by id' merely restates the schema and does not say where the id comes from (e.g., list_work_package_attachments), so it neither hurts nor compensates much.

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 with scope ('a single attachment by id'), so the agent knows it is a single-item retrieval rather than a list. However it does nothing to distinguish itself from the closely named sibling get_attachment_content, and an agent cannot tell from the text whether this returns metadata or the file itself.

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?

There is no guidance on when to use this versus get_attachment_content or list_work_package_attachments, which are the obvious alternatives in the sibling set. The description offers no context, preconditions, or exclusions.

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