get_test_result_attachment_content

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

No annotations provided, so description bears full burden. States returns base64-encoded content with MIME type, and explains how to handle different content types. Does not mention rate limits or size constraints, but overall sufficient for a download tool.

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?

Three sentences, front-loaded with purpose, no redundant information. Each sentence adds value: purpose, source of ID, and usage examples.

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 one parameter, no output schema, and no annotations, the description covers key aspects: return format, MIME type, and handling of different content types. Could mention potential errors, but overall complete for typical usage.

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%, so baseline is 3. Description adds context by specifying attachmentId comes from list_test_result_attachments and reinforces that it must be an integer. Provides meaningful guidance beyond schema.

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?

Clear verb 'Download' and resource 'binary content of a test result attachment'. Distinguishes from sibling tools like list_test_result_attachments and get_test_case_attachment_content by referencing attachment ID source and providing usage context.

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?

Explicitly tells to use attachment ID from list_test_result_attachments, and advises how to process the content (decode base64 for text, render for images). Lacks when-not-to-use or comparison with similar tools like get_test_case_attachment_content.

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