list_work_item_comments

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

The description indicates a read operation ('List'), which is accurate. However, it lacks details on pagination behavior, sorting, or any other behavioral traits beyond what is already clear from the operation name. No annotations are provided to supplement.

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 a single concise sentence with a domain tag, front-loading the purpose. It is efficient with no unnecessary words, though slightly more context could be added without becoming verbose.

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 simplicity (list with pagination), the description covers the basic purpose. However, it does not mention the return format, result ordering, or that pagination is supported (only implied by schema). No output schema exists, so more detail would help completeness.

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 has 100% description coverage, so the description does not need to add parameter details. The description adds nothing beyond the schema; it only references 'for a specific work item', which matches the workItemId parameter. Baseline 3 is appropriate.

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 verb 'List' and the resource 'comments', scoped to a specific work item. It effectively distinguishes from sibling tools like 'create_work_item_comment' and 'get_work_item'.

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 retrieving comments of a work item but provides no explicit guidance on when to use this tool versus alternatives like 'list_workitem_attachments'. 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.