list_work_item_comments

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

No annotations are provided, so the description must carry the full burden. It states that the tool lists comments and returns a list of WorkItemComment objects, which implies a read-only operation. However, it does not disclose behaviors such as pagination, ordering, filtering via params, permissions, or error conditions.

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 formatted as a concise docstring with Args and Returns sections. Every line serves a purpose, and there is no extraneous content. The structure is clear and easy to scan, though the Args section partially duplicates schema names, but the schema lacks descriptions so it adds value.

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 simple list operation with an output schema indicated, the description gives enough to get started: the return type and required parameters. However, it omits details about pagination, available query parameters, and usage context among the many sibling tools. The lack of annotations also leaves the operational behavior under-specified.

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 schema has zero description coverage for its three parameters. The description contains an Args section that explains each parameter: project_id as UUID, work_item_id as UUID, and params as an optional dictionary. This adds some meaning beyond the schema, but the semantics of the params dictionary remain vague, not specifying allowed keys or how to structure them.

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 'List comments for a work item' with a specific verb and resource. It is distinct from sibling tools like retrieve_work_item_comment, as it implies a list operation. The included Args and Returns sections further clarify the function.

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 no guidance on when to use this tool versus alternatives such as retrieve_work_item_comment or create_work_item_comment. It does not mention any exclusions, prerequisites, or conditions under which this tool is preferred.

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