pve_list_vms

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

'List' conveys a read-only operation, and 'from cluster resources' identifies the data source. However, with no annotations, the description carries the behavioral burden and does not mention read-only status explicitly, pagination, permissions, or what exactly 'cluster resources' includes.

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 direct sentence with the verb and object front-loaded. It has no wasted words, though it is a bit terse.

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?

With zero parameters and an output schema present, the description clearly identifies the tool's intent and source. It is sufficient for an agent to decide to call it; only the lack of usage guidance keeps it from being fully 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 input schema has zero parameters, and schema description coverage is 100%. No parameter explanation is needed; the baseline of 4 applies as no parameters exist.

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 uses the specific verb 'List' and names exact resource types ('QEMU VMs and LXC containers') drawn from 'cluster resources'. This clearly differentiates it from broader list tools like pve_list_resources and from single-VM tools such as pve_get_vm_status.

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?

No guidance is given on when to use this tool versus alternatives like pve_list_resources or pve_api_request. The description is purely declarative and leaves the choice to inference.

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