get_work_item_comments

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

With no annotations provided, the description carries the full burden. It discloses that the tool retrieves all comments (comprehensive scope), returns formatted markdown with author names and timestamps (output format), and organizes them chronologically (behavioral trait). However, it doesn't mention potential limitations like pagination, rate limits, or authentication needs, leaving some gaps.

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 well-structured and front-loaded with the core purpose, followed by usage guidelines and parameter details. Every sentence adds value—no redundancy or fluff. It efficiently communicates necessary information in a compact format.

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 read-only tool with 2 parameters and no output schema, the description is largely complete: it covers purpose, usage, parameters, and return format. However, it lacks details on error handling, pagination (if comments are numerous), or any side effects, which could be relevant for full contextual understanding.

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 description coverage is 0%, so the description must compensate fully. It clearly explains both parameters: 'id' as the work item ID (required) and 'project' as an optional project name with fallback behavior ('If not provided, will be determined from the work item'). This adds essential meaning beyond the bare 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 clearly states the specific action ('Retrieves all comments') and resource ('associated with a specific work item'), distinguishing it from sibling tools like 'get_work_item' (which retrieves the work item itself) or 'add_work_item_comment' (which adds comments). The purpose is precise and unambiguous.

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 explicitly lists four specific use cases (e.g., 'Review discussion history', 'See feedback or notes'), providing clear guidance on when to use this tool. It effectively differentiates from alternatives like 'get_work_item' (for general info) or 'query_work_items' (for broader searches).

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