snapshot_create

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

With no annotations provided, the description carries the full burden. It includes '[WRITE][risk=medium]' indicating write operation and risk level. It explains undo recording (real ID captured from XO response) and dry_run behavior (preview without snapshotting, no undo recorded). This provides meaningful behavioral context beyond the basic operation.

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 at 6 sentences. It front-loads the core action and risk, then explains undo recording, then lists parameters. Every sentence adds value without redundancy.

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 snapshot creation tool, the description covers the main behavior, parameter semantics, and undo mechanism. However, it lacks details on return value (e.g., snapshot ID) and possible errors (e.g., VM not found). Given no output schema, this information would be helpful for completeness.

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 compensate. The Args section explains each parameter: vm_id (VM uuid, see vm_list), name (with example), dry_run (preview behavior), target (Xen Orchestra target, optional). This adds significant value over the schema, though could be more detailed on default behavior for target.

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 starts with '[WRITE][risk=medium] Snapshot a VM.' clearly indicating the action and scope. It also mentions the inverse operation (snapshot_delete), distinguishing it from sibling tools like snapshot_list and snapshot_revert.

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 provides guidance on using the tool (e.g., referencing vm_list for vm_id, naming convention) and mentions dry_run preview. However, it does not explicitly state when to use this tool versus alternatives like snapshot_list, snapshot_delete, or snapshot_revert, nor does it explain when not to use it.

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