snapshot_delete

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

Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds substantive context beyond them: irreversibility, the dry-run preview path, and that prior state is captured for the audit record with no undo declared. This meaningfully informs the agent's risk calculus.

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-loads '[WRITE]' and 'IRREVERSIBLE', then preview guidance, then args – a sensible ordering. Minor redundancy between 'IRREVERSIBLE' and 'declares no undo' costs a point.

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?

For a 3-param destructive tool with no output schema and no annotation coverage of detail, the description supplies purpose, safety, preview path, and per-param meaning. Missing only peripheral items like auth requirements or behavior when the snapshot does not exist.

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%, so the description must carry the params, and it documents all three: snapshot_id with its 'dataset@name' format, dry_run's preview behavior, and target as a TrueNAS config name. Only the target's default/optional nature is left to the schema.

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?

Names a specific verb (Delete) and resource (ZFS snapshot) plus the exact identifier format 'dataset@name'. It is clearly distinguishable from snapshot_create and snapshot_list among its siblings.

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 real usage context: preview via dry_run=True, and points to snapshot_list for id format. It does not, however, explicitly route the agent to undo_apply/undo_list or state when restoration is preferable, so it falls short of a full when/when-not guide.

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