vm_info

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

No annotations are provided, so the description carries full burden for behavioral disclosure. The verb 'Get' implies a read operation, but there is no disclosure of potential errors, authentication requirements, rate limits, or the structure of the returned data. The description only states the basic action without additional behavioral context.

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 a single, concise sentence that front-loads the action ('Get'). Every word contributes to understanding the tool's purpose without unnecessary fluff. It is highly efficient.

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?

Despite the lack of an output schema, the description indicates the kind of information returned ('configuration' and 'live status'). For a simple one-parameter tool, this is largely sufficient. It could be more explicit about the exact fields, but overall it provides adequate context for an agent to select and invoke the tool.

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%, as the vm_id parameter includes a description ('VM identifier'). The description adds nothing beyond this, but with full coverage the baseline of 3 applies. The description does not clarify the format or constraints of vm_id, but the schema already handles that.

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 states a specific action ('Get') and resource ('detailed configuration and live status for a virtual machine'). It clearly distinguishes from sibling list tools like vm_list and vm_iplist, which focus on listing VMs or IPs rather than detailed info for a single VM.

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 usage for retrieving info about a specific VM, but it does not explicitly provide context on when to use this tool over alternatives, nor does it mention when not to use it. There is no exclusion or mention of sibling tools, leaving usage guidance implicit.

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