create_backup

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

The description discloses behavioral traits such as snapshot mode having no downtime, the different modes and compress options, and the return of a task UPID. It also mentions required parameters. Without annotations, it provides good transparency, though it does not cover potential destructive behavior or prerequisites.

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?

Description is concise with front-loaded core action, bullet points for mode and compress, and a final line about return and requirements. Every sentence adds value with minimal waste.

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 5 parameters, no output schema, and no annotations, the description covers purpose, mode/compress options, return type, and required params. It does not explain errors, prerequisites, or full behavior (e.g., overwriting), but is fairly complete for a backup tool.

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 has 0% coverage, so description must add meaning. It explains mode and compress enums with defaults and behavior (snapshot no downtime). It lists required params but does not describe them individually. Overall, it adds significant value for 2 of 5 parameters.

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 the tool backs up a guest using vzdump to a specified storage, with specific mode and compress options. It distinguishes itself from sibling tools like list_backups (listing) and create_snapshot (snapshot vs full backup).

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 explains mode options (snapshot/suspend/stop) and compress options, implying use cases, but does not explicitly state when to use this tool versus alternatives like create_snapshot or other guest tools. It mentions tracking with task_status but lacks direct sibling differentiation.

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