Deactivate a link

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds real behavioral detail beyond that: end-user traffic falls through to a not-found page, analytics history is preserved, and the action is reversible via update_link. The only omission is any note about permissions or effect on in-flight/redirecting taps.

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?

Front-loaded with the effect and the confirm requirement, and every sentence carries information: outcome, data retention, reversibility, confirmation gate. The leading fragment "Write." is slightly odd but functionally signals a mutation; no real 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 no output schema, the description usefully notes that a missing confirm returns a preview of the link, covering the return-value gap. For a two-parameter mutation with full annotation coverage this is close to complete, with the pause_link ambiguity being the remaining hole.

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 baseline is 3, and the description earns an extra point by explaining the consequence of omitting confirm — you get a preview of the link to show the user, not an error. That is meaning beyond the schema's terse "true to deactivate; omit or false to preview".

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 ("Turns a link off") and describes the observable effect: taps hit a "link not found" page instead of the app, store or website. It does not differentiate from the sibling pause_link, which sounds like it does something very similar, so an agent cannot fully resolve the choice from the description alone.

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?

Explicit about the confirm gate ("needs confirm: true; without it nothing changes") and explicitly names update_link with isActive: true as the way to reverse it. What's missing is guidance on when to use this vs. pause_link, which is the closest alternative in the sibling list.

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