pdm_pve_qemu_snapshot_create

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

No annotations provided, so the description carries full burden. It discloses the mutation nature, additive risk, dry-run behavior, and that confirm triggers actual creation returning a task UPID. Missing details on authentication requirements or error handling, but covers key behavioral aspects well.

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?

Four sentences, front-loaded with purpose, then usage guidelines and parameter hints. Every sentence adds value without redundancy. Highly concise and well-structured.

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?

With 7 parameters and an output schema, the description provides sufficient context for correct invocation. It explains the key behavioral aspects (dry-run, risk, return value) and parameter flags. Could include more on error states, but output schema likely covers return structure.

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 description adds context such as 'vmstate=True includes the VM's RAM state (larger, slower)' and 'Dry-run by default (PLAN); confirm=True creates it and returns the Proxmox task UPID.' This provides practical semantics beyond the schema descriptions.

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 'MUTATION: snapshot a VM on a PDM-registered remote (through PDM).' This clearly specifies the action (snapshot) and the resource (QEMU VM via PDM). It also differentiates from the LXC counterpart by mentioning 'For a container use pdm_pve_lxc_snapshot_create.'

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?

Explicitly states when to use the LXC alternative. Explains the dry-run default and confirm flag. Provides clear usage context for the vmstate and confirm parameters. However, does not mention other snapshot tools like pve_snapshot_create that might be alternatives for direct PVE interaction.

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