Hide a comment

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

Beyond the idempotentHint annotation, the description explains exactly what idempotency means here: hiding an already-hidden comment leaves it hidden. It also discloses that the operation is reversible and that preview mode is the default, with a clear write-mode toggle.

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 sentences carry the endpoint, moderation intent, idempotency, preview mode, and the apply mechanism. The most decision-relevant facts are front-loaded, with no 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?

Given the tool's low complexity, the provided annotations, and full schema coverage, the description is complete. It covers what the action is, how to perform it, its reversibility, its idempotency, and how to switch from preview to actual execution.

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. The description adds value by mapping commentId into the endpoint path and clarifying the apply parameter's role in preview vs. actual write, including the IG_WRITE_MODE environment variable fallback.

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 hides a comment, gives the exact endpoint semantics (POST /{comment-id}?hide=true), and frames it as reversible moderation preferred over deletion. This distinguishes it from sibling tools like instagram_delete_comment and instagram_unhide_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?

Explicitly says hide is preferred over delete for moderation, implying delete is the non-reversible alternative. It also gives precise invocation guidance: preview by default, then re-run with apply:true or set IG_WRITE_MODE=apply to perform the change.

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