pve_snapshot_create

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

Discloses mutation, dry-run, async with UPID, and storage prerequisites. No annotations provided, so description carries the burden. Missing potential side effects (disk usage, performance) but covers core behavior 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?

Two concise sentences with front-loaded purpose and key behavior. Every word adds value; no redundancy or fluff.

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?

Covers basic workflow (dry-run, async polling) and prerequisite. However, with 7 parameters including kind (default lxc) and no guidance on VM vs container or error handling, the description is incomplete for a tool of this complexity.

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?

Only 14% schema description coverage. The description only explains the 'confirm' parameter (controls dry-run). Other required parameters like vmid, snapname, kind, node, description are left unexplained, leaving the agent to guess their meaning.

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 it creates a snapshot as a restore point. It distinguishes from siblings like pve_snapshot_delete and pve_snapshot_list by focusing on creation, and the MUTATION prefix signals a write operation.

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 dry-run by default, confirm to execute, async behavior, and required snapshot-capable storage. It does not explicitly list when not to use or compare to alternatives like pve_backup, but the context is clear.

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