Pause a link

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

Annotations declare destructive, idempotent and non-read-only, and the description goes beyond them: it says exactly what breaks (all taps hit the not-found page), what survives (history stays in analytics), and that the write is gated behind confirm so a preview is side-effect free. That is the reversal, blast radius and safety interlock all in one place.

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?

Four short sentences, mutation flag and effect front-loaded, then the confirm gate, then the undo path. Nothing repeats and nothing is 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?

With annotations carrying the safety profile and no output schema, the description covers effect, reversibility, analytics impact and the confirm gate. The only thing an agent might still want is how this differs from deactivate_link, which is a sibling it will see in the list.

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 both parameters are already documented. The description nonetheless adds meaning the schema does not — that omitting confirm is a no-op returning a preview the caller can show a user, and that resume_link is the inverse operation.

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 (pause a link) and spells out the observable effect: every tap serves a "link not found" page instead of the app, store or website. That effect distinguishes it from neighbors like deactivate_link and resume_link without the agent opening any 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 explicit operational guidance: needs confirm:true, otherwise nothing changes and you get a preview to show the user, and undo with resume_link. The one gap is that it never contrasts pause with deactivate_link, so an agent cannot tell from the description why it would pick one over the other.

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