hide_comment

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

Goes well beyond the annotations (which only say non-destructive, idempotent, open-world) by disclosing visibility semantics: hidden comments vanish for everyone but the author, owner-authored comments on own media stay visible, and hidden comments drop out of get_media_comments. Also clarifies that preview sends nothing.

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?

Purpose and the delete_comment contrast are front-loaded, then protocol, Args, Returns and Limits in scannable sections. Slightly long, and the Returns summary partially duplicates the existing output schema, but no line is wasted.

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 3-param mutation with an output schema, everything an agent needs is present: prerequisites, the confirm gating protocol, edge-case visibility rule, and the downstream consequence that the comment_id must be surfaced to the user for later unhiding.

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 0% — the JSON schema gives only titles and defaults — so the description must carry the full burden, and it does: it documents comment_id's source (get_media_comments), hide's true/false meaning, and confirm's preview-vs-execute semantics with defaults stated for each.

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 and resource ("Hide (or unhide) a comment on the user's media") plus the key property "Reversible." Explicitly contrasts with the sibling delete_comment, so an agent can distinguish the two without opening either 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?

Names the alternative (delete_comment) and the condition that selects this tool ("for spam or abuse, since it can be undone"). Adds a mandatory two-step protocol: confirm=false first for a no-op preview, then confirm=true only after user approval.

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