Download File

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: the precise URL-to-parameter mapping and that the file is private, which helps the agent correctly construct requests.

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 two sentences, front-loaded with the endpoint and purpose. The second sentence provides an explicit example for parameter derivation, with no wasted words or redundant information.

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?

No output schema exists, but the tool's purpose as a download implies the response is the file content. The description covers the essential operational steps (URL mapping) and is sufficient given the simplicity of the tool and strong annotations.

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% with descriptions for each parameter, so baseline is 3. The description adds meaning beyond the schema by explaining how all parameters derive from the attachment URL and providing a concrete example ('https://gorgias.io/attachments/abc123/file.png' maps to file_type='attachments', etc.).

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 the tool downloads a private file from Gorgias's servers, with a specific verb ('Download') and resource. It also explains the URL path structure, distinguishing it from related tools like upload_file.

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 implies when to use this tool: when you have an attachment URL and need to download its file. It doesn't explicitly state alternatives or exclusions, but the context is clear and the URL mapping guidance is strong.

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