snapshot_management

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

No annotations provided, so description must disclose behavioral traits. It fails to mention that restore/delete are destructive, may cause downtime, or require VM power state conditions. This gap reduces 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 four sentences, front-loading purpose and structure. It is efficient, though the last sentence could be integrated into the parameter 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?

Given the tool's multi-action nature, the description is adequate but lacks prerequisities (e.g., VM existence, required states for restore) and does not leverage the presence of an output schema to clarify return types.

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 67%, and the description adds minimal value beyond what the schema already provides (e.g., 'All actions require vm_name'). The description does not clarify semantics like default limits or edge cases.

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 identifies the tool as comprehensive snapshot management for VMs, consolidating multiple operations (list, create, restore, delete). It differentiates from sibling tools like vm_management by focusing solely on snapshots.

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 instructs to use the 'action' parameter to specify operation, but does not contrast with sibling tools like vm_management, nor does it specify when not to use this tool (e.g., for non-snapshot VM tasks).

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