create_vm_snapshot

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

No annotations provided. The description mentions the vmstate parameter hints at including RAM state, but does not disclose side effects, permissions needed, or behavior for running VMs. Limited behavioral transparency.

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 with a single-sentence purpose followed by an Args list. It is efficiently structured, though the list is necessary due to lack of schema descriptions.

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 5 parameters, no annotations, and an output schema present, the description is incomplete. It fails to mention prerequisites (e.g., VM must exist), failure conditions, or any caveats, leaving significant gaps.

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 description must add meaning. It provides one-line explanations for each parameter (e.g., 'the node name'), which are minimal and barely add value beyond the parameter names.

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 snapshot of a VM.' with a specific verb and resource. It distinguishes from sibling tools like create_container_snapshot and delete_vm_snapshot.

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?

No guidance on when to use this tool versus alternatives such as create_backup_job or create_vzdump. The description only lists parameters without usage context.

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