read_work_item_attachment

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

With no annotations, the description carries full burden. It fully discloses return types (image vs string), size limits (5 MB images, 1 MB text), error conditions (ValueError), and even explains why certain formats are unsupported (missing extraction libraries). This is exemplary transparency.

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 well-organized into logical sections (supported, unsupported, args, returns, raises) and every sentence adds value—no fluff or repetition. It's longer than many but each detail is necessary for correct use.

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?

Given the tool's moderate complexity (format handling) and the absence of annotations and output schema, the description provides complete guidance: supported and unsupported types, return formats, size limits, and exception behavior. Nothing critical is missing.

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 0%, so the description must compensate, and it does. Each parameter is described as 'UUID of the project/work item/attachment', adding meaning beyond the bare type='string' in the schema. This fully covers parameter intent.

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 opens with a specific verb and resource ('Fetch an attachment's content') and clarifies the LLM-focused purpose. It explicitly distinguishes itself from the sibling tool get_work_item_attachment_download_url by directing unsupported file types there.

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?

It clearly delineates when to use this tool (for images and text files) and when to use the alternative get_work_item_attachment_download_url for unsupported types. Supported and unsupported lists make the decision straightforward.

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