list_workitem_comments

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

The readOnlyHint annotation already covers the safety profile, and an output schema exists, so the description only needs to add context. It does add one meaningful trait — that the project is implicit rather than a parameter — but says nothing about ordering, pagination, or behavior when the workitem has no comments or does not exist.

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?

One short sentence with no wasted wording, and the scope qualifier is front-loaded. It is efficient but so terse that it drops information an agent would benefit from.

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 single-parameter, read-only list tool with an output schema, the description is minimally adequate: it identifies the resource and the implicit project scope. It omits result limits, empty-result behavior, and error conditions, which leaves gaps for anything beyond the simplest call.

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% for the single required workitem_id, so the description must carry the burden. It indicates the value identifies 'a certain workitem' but adds no format, source (e.g. from list_workitems/get_workitem), or constraint detail beyond the pattern already in the schema.

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 states a specific verb and resource (list the comments of a workitem) and scopes it to the current project, which separates it cleanly from the create/update/delete_workitem_comment siblings. It stops short of naming any sibling explicitly, so it is clear but not fully differentiated.

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 statement of when to call this versus e.g. get_workitem or the comment-mutation tools, and no note about prerequisites such as needing an active project context (only implicitly hinted by 'current project'). The usage condition is left entirely to inference from the tool name.

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