list_workitem_attachments

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

No annotations are provided, so the description carries full responsibility for behavioral disclosure. It indicates that the tool reads attachment data, which is non-destructive, but does not explicitly state it is read-only, mention required permissions, or describe behavior for missing work items (e.g., error handling). Key behavioral traits are missing.

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 concise, using a single sentence to state the purpose and another to list output fields. It is efficiently structured without redundant information, though it could be slightly more front-loaded by placing the output detail earlier.

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 straightforward list operation with two parameters, the description adequately covers what the tool does and what it returns. However, it does not mention if results are paginated, ordered, or if there are limits. No output schema exists, so the description compensates well but misses some details about data volume or sorting.

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 input schema covers both parameters with descriptions (workItemId, organizationId). The tool description does not add meaning beyond what the schema provides; it focuses on output details. With full schema coverage, a score of 3 is appropriate as the description is not enhancing parameter understanding.

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 action: list attachments for a specific work item. It also details the returned information (file name, size, suffix, download URL, creator/modifier details), making the purpose unambiguous and distinguishing it from sibling tools like create_workitem_attachment or get_workitem_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 usage for listing attachments of a work item but provides no explicit guidance on when to use this tool versus alternatives (e.g., get_workitem_file for a single file) or when not to use it. Context is clear, but no exclusions or alternatives are mentioned.

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