osd_purge

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

No annotations provided, so description carries full burden. It explicitly states it is a WRITE operation with high risk, irreversible, and details the actions (destroy, crush rm, auth del). Also mentions need for approver. No contradiction.

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?

Description is concise and well-structured: summary, usage guidelines, parameter explanations. No superfluous text.

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?

Covers prerequisites, risk, preview, approval, and parameters. However, no mention of return values or preview output format. Given high risk, it is very complete but slightly missing output details.

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 description coverage is 0%, but the description adds an 'Args' section explaining all three parameters: osd_id (from osd_tree), dry_run (preview), target (omit for default). This provides crucial context beyond the schema types.

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 'Purge an OSD (destroy + crush rm + auth del). Irreversible.' This specifies the verb and resource, and distinguishes it from other OSD tools like osd_mark_in/out or osd_reweight. No tautology.

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 guidance: 'Pass dry_run=True to preview. Requires an approver... Drain first... before purging.' It mentions prerequisites and alternatives (drain using other tools), and implies when not to use (if not drained or without approver).

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