comment_resolve

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

With no annotations present, the description carries the transparency burden and succeeds: it discloses that the resolution note is shown to the reviewer, is persisted, and clears the pin live in all open previews. These are concrete, observable effects beyond merely stating 'resolve'.

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?

Two concise sentences; the first states the action and precondition, the second adds behavioral consequences and a safety rule. No filler or repetition.

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 two-parameter mutation with no output schema, the description provides purpose, precondition, behavioral effects, and a caution. All necessary operational context is present.

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?

Input schema already covers both parameters at 100%, so baseline is 3; the description adds value by explaining that the 'resolution' value is surfaced to the reviewer and persisted, which clarifies the stakes of that parameter. However, it doesn't describe id formatting or any additional constraints beyond the 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?

Description opens with 'Resolve a reviewer comment after addressing it' – a specific verb and target resource that clearly distinguishes it from sibling read/lookup tools like comments_list and comment_context. The phrase 'after addressing it' adds necessary context about the action's precondition.

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?

Provides explicit timing ('after addressing it') and an explicit prohibition ('Never resolve without actually making the change'), which covers both when and when-not to invoke this tool. While no alternative tool is named, the strong operational guardrail clearly differentiates the intended use case from comment listing/context siblings.

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