VPS_getSnapshotV1

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

No annotations are provided, so the description carries the full burden. It indicates a read operation ('retrieve'), but does not disclose any potential side effects, rate limits, or authorization requirements. The behavior is implied as safe, but explicit details are missing.

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 concise with two sentences, no wasted words. It gets straight to the point and is appropriately sized for such a simple tool.

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 tool has one parameter and no output schema. The description is minimal but adequate for a straightforward retrieval. However, it could benefit from mentioning what snapshot information is returned or providing an example, especially since no output schema exists.

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?

There is one parameter, virtualMachineId, with a schema description 'Virtual Machine ID.' The tool description adds no additional meaning beyond the schema. Since schema coverage is 100%, the baseline is 3, and the description does not improve it.

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 'Retrieve snapshot for a specified virtual machine.' It uses a specific verb ('retrieve') and identifies the resource ('snapshot'). Among sibling tools like VPS_createSnapshotV1 and VPS_deleteSnapshotV1, this tool is distinct as a retrieval operation.

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 says 'Use this endpoint to view current VPS snapshot information,' which implies the context of use. However, it does not provide explicit guidance on when not to use it or contrast it with other snapshot operations (e.g., restore, delete).

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