resolve_pr_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 explicitly discloses partial-success semantics ('individual thread errors don't fail the entire batch'). However, it omits details about authentication, rate limits, or reversibility.

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 concise with a clear headline and bulleted arguments. Every sentence serves a purpose, no redundant phrasing. It is well-structured and front-loaded.

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 presence of an output schema (not shown but indicated), the description appropriately avoids explaining return values. It covers the main operation, partial-success, and parameters. However, it lacks information on batch size limits or behavior when the PR does not exist.

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 0% description coverage, so the description compensates fully. Each parameter is explained: 'pr_url_or_id' (full URL or numeric ID), 'thread_ids' (IDs to resolve), 'status' (target, default 'fixed'), and 'working_directory' (optional path). This adds significant clarity beyond the schema's type definitions.

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 begins with 'Batch-resolve PR comment threads', clearly specifying the verb (batch-resolve) and resource (PR comment threads). This distinguishes it from sibling tools like 'post_pr_comment' and 'reply_to_pr_comment'.

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 implies usage for batch resolving comment threads and mentions partial-success semantics, but it does not explicitly state when to use this tool versus alternatives like 'analyze_pr_comments' or 'post_pr_comment'. No exclusion criteria or prerequisite conditions are provided.

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