Hide or unhide a comment

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

The annotations already indicate non-destructive behavior with destructiveHint=false, and the description adds valuable behavioral details: the action is reversible, and the hidden state still allows visibility to the author and their friends. It goes beyond what annotations alone convey, though it omits details like permission requirements.

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, front-loaded with the core behavior, and follows with rationale and a preference comparison. Every sentence serves a purpose without redundancy or filler.

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 three-parameter tool with clear schema descriptions and non-destructive annotations, the description provides the essential context: what the action does, who still sees the comment, that it is reversible, and how it relates to the delete alternative. No critical information is missing for an agent 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 description coverage is 67%, with page and hidden already described in the schema. The description does not add significant parameter-level detail beyond what the schema provides, though the reversibility wording ties into the hidden boolean. This meets the baseline for schema-covered 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 states the action (hide or unhide) and the resource (a comment), and specifies the exact visibility effect: hidden from everyone except the author and their friends. It also distinguishes itself from the sibling delete_comment by explicitly saying 'Prefer this to deleting.'

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 gives explicit guidance on when to use this tool: it is 'the usual answer for spam or abuse' and should be preferred over deleting. This provides a clear decision rule compared to delete_comment, the main alternative.

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