sam_attachment_url

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

Discloses that the URL returns a 303 redirect to a signed S3 URL and advises on fetch behavior. With no annotations, this adds useful behavioral context beyond the bare function.

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 sentences: first states the purpose, second explains the redirect behavior and how to get the file. No extraneous words.

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?

For a single-parameter tool without output schema, the description covers purpose, parameter source, URL behavior, and fetch instructions. Could mention error cases, but the core usage is adequately addressed.

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?

The schema describes 'resourceId' as the resource id; the description adds that it comes from 'sam_get_opportunity resourceLinks (URL-tail hex)', which aids understanding. Since schema coverage is 100%, the extra detail justifies a score above baseline 3.

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 it builds a public download URL for an attachment resourceId. The action is specific and distinct from sibling tools like sam_get_opportunity.

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?

Directly indicates when to use: given a resourceId, construct the download URL. It also provides guidance on how to handle the redirect (redirect:'follow'), though it doesn't explicitly exclude alternative scenarios.

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