vsphere_get_vm

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

Annotations already declare read-only, idempotent, and non-destructive, so the description adds value by specifying what details are included (hardware, guest info, resources, snapshots). It also notes that guest filesystem usage depends on VMware Tools, providing a behavioral caveat beyond annotations.

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 succinct and front-loaded, with two concise sentences plus an Args block. Every sentence adds value without 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?

The description covers the tool's purpose, the scope of returned details, and the parameter formats. With an output schema present and annotations covering safety, the description is complete for a read-only single-VM retrieval 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?

The input schema only defines 'vm' as a string with no description. The description compensates by enumerating accepted formats: VM name, managed object ID, BIOS/instance UUID, or inventory path, giving clear guidance for the parameter.

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's function: retrieving full detail for one virtual machine. This distinguishes it from sibling tools that list VMs, get summaries, or perform changes. The verb 'get' and the resource 'VM' are explicit.

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 when a complete, detailed view of a VM is needed, but does not explicitly mention alternatives or exclusion scenarios. It would benefit from a note like 'use vsphere_get_vm_summary_by_host for summaries'.

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