list_work_item_attachments

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

Without annotations, the description carries the burden of behavioral disclosure. It states that the tool returns metadata and lists the fields, which is helpful. However, it does not disclose potential pagination, ordering, error conditions, or required permissions. It is adequate but lacks deeper behavioral context.

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 and front-loaded with the purpose. The Args and Returns sections are logically structured and contain no redundant information. Every sentence serves a purpose, making it highly efficient.

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, the description is largely complete. It specifies the return fields and points to the download tool for further action. Since an output schema exists, return value details are covered elsewhere. It could mention pagination or scaling behavior, but that is not critical for basic 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 description coverage is 0%, so the description must compensate. It explains project_id and work_item_id as UUIDs and clarifies which project and work item they refer to. This adds a bit beyond the raw schema, but the explanations are terse and mostly restate the parameter names. It does not explain how to find these IDs or any relationships.

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 that the tool lists all attachments for a work item, using a specific verb and resource. It also differentiates itself from the sibling tool get_work_item_attachment_download_url by explicitly pointing to that tool for downloadable links, avoiding confusion.

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 provides clear context for when to use this tool (to list attachment metadata) and explicitly directs users to get_work_item_attachment_download_url for download links. It does not mention other alternatives like read_work_item_attachment, but the main alternative is covered, making usage guidance strong though not exhaustive.

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