vm_snapshot_create

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

With no annotations provided, the description carries full burden. It marks the operation as [WRITE] and describes parameters, but does not disclose side effects (e.g., VM pause, disk I/O), required permissions, or whether the VM must be running. The dry_run preview is helpful but incomplete for full behavioral understanding.

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 extremely concise: a one-line purpose, a hint about dry_run, and a bulleted parameter list. Every sentence provides necessary information without redundancy or filler. The structure front-loads the core action and then details parameters efficiently.

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?

Given the complexity of a VM snapshot creation tool and the absence of an output schema, the description omits important execution context: what is returned (success message, snapshot ID?), whether it is synchronous, prerequisites (VM must exist, must be running?), and potential errors. The dry_run preview is mentioned but not explained in terms of output.

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?

The input schema has 0% description coverage, so the description's parameter explanations add critical meaning. It clarifies vmid as 'Numeric Proxmox VM id', name as 'Snapshot name (must be unique for the VM)', dry_run as preview toggle, and node as auto-locate. The 'target' parameter is somewhat vague ('Proxmox target name from config'), but overall adds substantial value.

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 'Create a named snapshot of a VM' with the verb 'Create' and resource 'snapshot of a VM'. The '[WRITE]' tag and inverse reference to 'vm_snapshot_delete' immediately distinguish it from sibling snapshot tools like listing or rollback.

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 mentions the inverse tool 'vm_snapshot_delete' and suggests using 'dry_run=True to preview', providing context for safe usage. However, it lacks explicit when-not-to-use guidance or comparisons to related tools like vm_list_snapshots or vm_snapshot_rollback, though the inverse hint partially compensates.

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