Archive Help Center Article

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

Annotations provide destructiveHint=true and idempotentHint=true. The description adds important context: soft-delete behavior, reversibility from admin UI, invisibility to end users, and return of confirmation message. It does not contradict annotations and provides value beyond them.

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 with three well-structured sentences. It front-loads the main purpose, then provides details on behavior, alternatives, and prerequisites without superfluous content.

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 rich input schema (2 params with 100% description coverage) and annotations, the description covers all necessary aspects: purpose, behavior, return type, alternative, and safety. No gaps are evident.

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%, but the description adds meaning by explaining 'confirm' as an explicit safety guard and 'article_id' as a numeric ID obtainable from list_articles or search_articles, which aids the agent in parameter selection.

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 'Archive (soft-delete) a Help Center article' and distinguishes between soft-delete and permanent deletion, as well as from unpublishing via update_article. It specifies the verb (archive) and the resource (Help Center article) with detailed behavior.

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 explicitly states when to use this tool (the only removal API offers) and when not to use it (for temporary hiding, use update_article). It provides an alternative and explains the required confirm flag as a safety guard.

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