snapshot_create

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

Annotations already flag readOnly=false, idempotent=false, destructive=true, but the description goes further by disclosing the undo-recording mechanism (real snapshot id captured from the XO response so snapshot_delete is replayable) and the dry_run no-undo behavior. This is meaningful behavioral detail an agent cannot get from structured fields.

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 operation class and inverse, then undo semantics, then a tidy Args block. Every line earns its place, though the tag line and inverse line overlap slightly with the write framing.

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 non-idempotent write tool with no output schema, the description supplies operation class, inverse routing, undo mechanics, dry-run behavior, and full parameter meaning. Nothing required to call it correctly is missing.

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 carries the full burden and does so for all four params: vm_id (uuid, see vm_list), name (with example format), dry_run (preview without snapshotting, no undo recorded), and target (XO target from config, omit for default). No parameter is left ambiguous.

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+resource ('Snapshot a VM') and immediately names its inverse (delete THAT snapshot), which cleanly separates it from siblings snapshot_delete, snapshot_revert, and snapshot_list. The [WRITE][risk=medium] tag adds an at-a-glance operation class.

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 clear operational context: the inverse operation is snapshot_delete and the undo is recorded and replayable. It cross-references vm_list for obtaining vm_id. It stops short of stating explicit when-not conditions (e.g. when to prefer snapshot_revert), so it is strong but not fully complete.

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