create_snapshot

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

No annotations are provided, so the description must disclose behavior. It mentions the return value (task UPID) and tracking via task_status, which is helpful. However, it does not disclose side effects, permissions, or whether the operation is safe (though snapshot is generally safe). The description adds some value beyond the schema but is not fully transparent.

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?

Three sentences with front-loaded purpose and return value info. The third sentence ('Needs node, vmid, type') is slightly redundant with schema required fields, but overall concise and no wasted words.

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 no output schema, the description explains the return value (UPID) and references tool_status for tracking. It covers the essential use case and constraints. It could mention what the snapshot is of, but parameters imply the target.

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%, but the description explains that 'name' is the snapshot name and 'description' is optional. It lists required params (node, vmid, type) but does not add meaning beyond their names. The enum for type is clear from schema. Overall, the description compensates partially for the lack of schema descriptions.

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 'Take a snapshot' with a specific purpose: 'safety net before a risky change.' It distinguishes from siblings like create_backup and delete_snapshot by highlighting snapshot as a safety net.

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 implies when to use ('before a risky change') but does not explicitly exclude scenarios or mention alternatives like create_backup. The guidance is adequate for an agent to infer usage context.

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