Get virtual machine details

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds that the tool returns 'comprehensive VPS configuration and status,' which is useful, but it does not disclose return format, error behavior, or other operational details.

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 short and front-loaded with the main action. The second sentence repeats some of the first but adds the useful 'configuration and status' context, so it is not pure redundancy.

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?

For a simple read-only single-parameter tool, the description plus annotations provide enough context to select and invoke it correctly. It could be more complete by describing the response shape, but the absence of an output schema and the low complexity keep this gap minor.

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 100%, and the sole parameter virtualMachineId is documented in the schema. The description only echoes 'specified virtual machine' without adding parameter-level detail, so the baseline 3 applies.

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 verb and resource: 'Retrieve detailed information about a specified virtual machine.' The word 'specified' plus 'detailed' distinguishes it from sibling list operations like VPS_getVirtualMachinesV1 and from getters for other resources.

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 comprehensive VPS configuration and status,' which gives clear context for the call. However, it does not explicitly mention alternatives or when not to use it, such as contrasting with VPS_getVirtualMachinesV1 for listing VMs.

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