devops_pull_request_list_thread_comments

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

The description adds behavioral details beyond the annotations: it specifies that only non-deleted text comments are retrieved. Annotations already declare readOnlyHint=true, so the description's clarification about deleted comments and thread scope provides useful context without contradiction.

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, clear sentence that front-loads the verb and resource. There is no extraneous information; every word is necessary and concise.

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 has an output schema (mentioned in context) and only three required parameters with schema descriptions, the one-sentence description is sufficient for an agent to understand the scope and behavior. No additional explanation of return values is needed.

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% coverage, with basic descriptions for each parameter. The tool description does not add extra semantic meaning (e.g., data formats, constraints) beyond the schema, so it meets the baseline but does not enhance understanding.

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 tool retrieves a list of non-deleted text comments in a specific thread, with a specific verb and resource. This distinguishes it from sibling tools like devops_pull_request_list_threads (lists threads) and devops_pull_request_reply_comment (creates replies).

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 does not provide explicit guidance on when to use this tool versus alternatives. It implies usage for retrieving comments in a thread, but lacks 'when-not-to-use' or alternative suggestions. The readOnlyHint annotation partially compensates but is not mentioned in the description.

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