list_work_item_comments

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

The annotations already indicate readOnlyHint=true, so the description doesn't need to restate that. It adds valuable behavioral details: comments are returned as a flat page with threading reconstructible via parent_comment_id and child_comment_ids, and that text is verbatim and unsanitized (should be treated as untrusted). This goes beyond the annotations.

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 extremely concise: three sentences that cover purpose, threading model, and security warning. Every sentence adds value with no redundant or vague phrases. It is front-loaded with the core purpose.

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 output schema exists, the description sufficiently covers the return structure (flat page with threading hints) and addresses security. It does not mention pagination behavior or default values, but those are defined in the input schema. Overall, it provides enough context for an agent to understand the tool's behavior.

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 50% (two out of four parameters have descriptions). The description does not add any additional meaning to the parameters beyond what's already in the schema. Since coverage is not low (<50%), baseline 3 is appropriate; however, the description misses an opportunity to clarify the pagination parameters or the relationship between work_item_id and project_id.

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 explicitly states 'List a work item's comments as a flat page', clearly indicating the action and resource. It distinguishes from sibling tools like 'create_work_item_comments' and 'list_document_comments' by specifying the context of work items and the flat page structure, which clarifies the purpose.

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 important context on how to use the tool (threading via parent_comment_id and child_comment_ids) and a security warning about unsanitized text. However, it does not explicitly state when to use this tool versus alternatives like 'list_document_comments' or provide guidance on when not to use it.

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