Resolve Comment

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

Annotations indicate readOnly=False, so the description's 'set' aligns with a mutation. It adds context that content remains unchanged, which is useful. However, it doesn't disclose other potential side effects (e.g., notifications, idempotency), though annotations already cover the safety profile.

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 tightly written sentences, each earning its place. The description is front-loaded with the core action and immediately clarifies what it doesn't do.

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?

This is a simple tool with two parameters and an output schema present. The description covers the purpose, non-destructive behavior, and an alternative tool, making it complete enough for an agent to use effectively.

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 description coverage is 100%, and the schema already describes id and resolved clearly. The description doesn't add parameter-level detail beyond what the schema provides, so baseline 3 is appropriate.

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's function: 'Set a comment thread's resolved state without changing its content.' This uses a specific verb and resource, and explicitly distinguishes from delete_comment by saying 'Use delete_comment only when the comment should be removed.' This differentiates it from sibling tools like delete_comment and update_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 provides explicit guidance by naming delete_comment as the alternative for removal, and implies this tool is for toggling resolution without content changes. It doesn't mention update_comment directly, but the 'without changing its content' phrasing covers the distinction.

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