devops_pull_request_list_threads

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

Beyond the annotation 'readOnlyHint: true', the description discloses that the tool returns only non-deleted threads, includes text comments, and organizes them hierarchically. This provides meaningful behavioral context.

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?

A single sentence that front-loads the action and includes all essential qualifiers without superfluous text. Each phrase earns its place.

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 retrieval tool with two required parameters and an existing output schema, the description adequately covers purpose and key behaviors. Minor gaps exist (e.g., missing prerequisites or edge cases), but overall sufficient.

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 already documents both parameters (repository_id and pull_request_id) with descriptions. The tool description adds no additional meaning or constraints to these parameters.

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 specifies the verb 'Retrieve', the resource 'comment threads and their text comments', and key qualifiers 'hierarchical list of non-deleted threads for a pull request'. It differentiates from siblings like 'devops_pull_request_list_thread_comments' by emphasizing hierarchy and inclusion of text comments.

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?

No explicit guidance on when to use this tool versus alternatives such as 'devops_pull_request_list_thread_comments'. The description implies use for a hierarchical view, but lacks explicit context or exclusions.

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