Backup guest (vzdump)

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

No annotations exist, so the description must disclose behavioral traits. It mentions that snapshot mode 'has no downtime' and lists three modes, but does not elaborate on other behaviors like whether the backup is synchronous, effect on guest performance, permission requirements, or if the tool can cause data loss. Some context is provided but not comprehensive.

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 sentences with zero waste. The first sentence gives the core purpose, the second adds essential detail about the mode parameter. Every word is necessary and informative.

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?

The description covers the basic action and key parameter details, but lacks information about output/return value (e.g., task ID, success indication). Since there is no output schema, the description should at least mention what the agent can expect upon successful invocation. The description is sufficient for a simple backup command but incomplete for automated usage.

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%, so the schema already describes all parameters. The description adds meaningful context: it explains that mode 'snapshot' is the default with 'no downtime', and enumerates the modes again. This goes beyond the raw enum description in the schema by clarifying the default and the no-downtime benefit, helping the agent understand parameter semantics.

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?

Clearly states 'Create a backup of a VM or container to a storage using vzdump.' The verb 'create a backup', resource 'VM or container', and method 'vzdump' are specific. Distinguishes from sibling tools like clone_guest or create_snapshot by focusing on backup. Also mentions the three modes, adding clarity.

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 explicit guidance on when or when not to use this tool versus alternatives. The sibling tools list includes many related actions (e.g., clone, snapshot, shutdown) but the description does not differentiate. The modes are described but without context for choosing between them. Implicit usage for backing up is clear, but no exclusionary context.

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