Get work item comments

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

With no annotations, the description carries the behavioral burden. It does disclose that results are pageable, which is useful, but it does not mention authentication requirements, read-only semantics, or handling of deleted comments. The lack of any side-effect warning is tempered because 'List' clearly suggests a non-mutating operation.

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, front-loaded sentence with no filler. It communicates the core action and resource efficiently, but it is terse enough that important behavioral and parameter context is absent.

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 seven parameters, no annotations, and no output schema, the description is too sparse to fully guide an agent. It omits usage context, pagination mechanics, ordering behavior, and expansion options, leaving the agent to discover or guess important calling details.

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 only 29%, and the description adds little beyond the schema. It mentions 'pageable' and 'one Azure Boards work item,' which loosely connects to top, continuationToken, and workItemId, but it does not explain meaning of order, expand, includeDeleted, or continuationToken. The enum-based parameters are left entirely unexplained.

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 has a specific verb ('List'), a clear resource ('comments for one Azure Boards work item'), and the modifier 'pageable' indicating a paginated read operation. This differentiates it from mutation siblings like add_work_item_comment, update_work_item_comment, and delete_work_item_comment, though it does not explicitly call them out.

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?

There is no guidance on when to use this tool versus alternatives such as get_work_item or query_work_items, nor any explicit exclusions. The 'List' verb implies a read operation, but the description does not explain when this endpoint should be chosen over related work item or comment tools.

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