Resolve a comment

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

Annotations already declare non-destructive and idempotent, and the description reinforces this with substantive side-effect detail that annotations cannot express: resolved threads remain on the board, disappear only from the open list, and nothing is deleted. It also discloses the dual resolve/reopen mode and the return value (comment id).

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?

Three sentences, front-loaded with the action, followed by side-effect clarification and the sibling hand-off. Every sentence carries distinct information with no padding.

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 three-parameter mutation with no output schema, the description covers the action, the alternate mode, side effects, reversibility of appearance, and the return value, which is everything an agent needs to invoke it correctly.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning by framing 'reopen' as an in-place toggle of the same operation rather than a distinct tool, and by implying the comment selector accepts partial text matches as the schema notes. It does not add syntax or edge-case detail beyond that.

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?

States a specific verb (mark as resolved / reopen) on a specific resource (comment thread), and explicitly distinguishes itself from reply_comment. An agent can tell exactly what operation this performs without inspecting the schema.

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?

Gives an explicit trigger condition ("once you have done what it asked") and names the alternative for the adjacent case ("To answer before resolving use reply_comment"). The when-to-use and which-sibling decision are both spelled out.

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