VPS_restoreSnapshotV1

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

Since no annotations are provided, the description carries full burden. It mentions reverting state but does not disclose potential irreversible changes, downtime, or prerequisites (e.g., VM stopped). This omission is significant for a mutation tool.

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 three sentences. The first two are useful, but the third sentence ('Use this endpoint...') is redundant and could be removed. It is still reasonably concise and well-structured.

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 provides the basic purpose and use cases, but lacks details on return values, synchronization, or permissions. Given the simplicity of the tool (one parameter, no output schema), it is minimally adequate but could be more complete.

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?

The only parameter has full schema coverage (100%) with a description 'Virtual Machine ID'. The tool description adds no additional semantics beyond the schema, so baseline of 3 is appropriate.

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 restores a virtual machine to a previous state using a snapshot, distinguishing it from siblings like VPS_restoreBackupV1 and VPS_createSnapshotV1.

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 when to use the tool (system recovery, undoing changes, testing) and that it reverts VPS instances, but does not explicitly mention when not to use or list alternatives like backup restore.

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