Download an attachment

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

Annotations cover the safety profile (readOnlyHint=true, openWorldHint=true), and the description adds genuinely useful context beyond them: the conditional local-write behavior and the fact that the return value differs depending on outputPath. It does not, however, discuss auth/token implications or failure modes when the path is unwritable, which keeps it from 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 written sentences, zero filler, with the primary action (resolve the URL) front-loaded and the conditional branch second. Every clause carries information an agent needs.

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?

There is no output schema, and the description compensates by stating exactly what is returned in each mode (URL only vs. saved file path). Combined with the 100%-covered input schema, an agent has everything needed to call this tool 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?

Schema description coverage is 100%, so the baseline is 3, but the description adds real meaning on top of the schema by explaining the semantic effect of supplying outputPath (file written) versus omitting it (URL only). The overwrite detail is already carried by the schema, so it is not a full 5.

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 gives a specific verb+resource (resolve the download URL of a ticket attachment) and even spells out its dual-mode behavior (URL only vs. saved file). It is unambiguous what the tool does, but it never differentiates itself from siblings such as list_ticket_attachments, upload_attachment, or delete_attachment, so it stops short of a 5.

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 only implied via the outputPath conditional ("when outputPath is given... Without outputPath only the URL is returned"). There is no statement of when to choose this tool over list_ticket_attachments for discovery or how it relates to the upload/delete attachment siblings.

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