pve_list_vms

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

No annotations are present, so the description must disclose behavior. It mentions wildcard support in name filtering and status options, but does not disclose return format, potential side effects, or whether it includes VMs across all nodes beyond the phrase 'cluster'. The operation is inherently read-only, but this is not explicitly stated.

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 entire description is one concise sentence that front-loads the main action and includes filter details without unnecessary words.

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 list tool, the description covers the core functionality and optional filters. The output schema provides return value details, so the description does not need to explain that. It is nearly complete, though it could mention pagination or that it lists across all nodes explicitly.

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 coverage is 0%, so the description must add parameter meaning. It explains that name_filter supports * wildcards and that status_filter filters by status, adding value beyond the raw schema. However, it does not describe matching behavior or default values beyond what the schema enum/defaults provide.

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 lists QEMU VMs in the Proxmox cluster, using a specific verb and resource. It distinguishes from sibling pve_list_lxc by specifying QEMU VMs (not LXC containers).

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 this tool is for listing VMs with optional filters, but does not explicitly state when to use it over alternatives like pve_get_vm_status or pve_list_lxc. No exclusions or alternative tool names are provided.

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