pdm_pve_qemu_list

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

No annotations are provided, so the description carries full burden. It declares read-only and no state change, and mentions config requirements. However, it does not detail error conditions, rate limits, or permission specifics beyond the config note. Still, for a read-only listing, it is largely transparent.

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?

Two concise sentences plus a config requirement note. Front-loaded with 'READ-ONLY' and main action. Every sentence adds value without fluff.

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?

Given the tool's simplicity (listing, 3 params, output schema exists), the description is largely complete. It names alternatives, clarifies scope, and mentions output shape. Could mention more about pagination or sorting, but overall sufficient.

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%, so baseline is 3. The description's mention of 'node optionally filters to one PVE node' adds no new meaning beyond the schema's description. No additional parameter context provided.

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 verb ('list'), resource ('VMs'), and scope ('across a PDM-registered PVE remote, cluster-wide'). It also specifies read-only nature and distinguishes from related tools (pdm_pve_qemu_config, pve_list_guests).

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?

Explicitly tells when to use this tool vs alternatives: 'For one VM's config use pdm_pve_qemu_config; to query the cluster directly without PDM, use pve_list_guests.' Also notes config requirements ('Needs PROXIMO_PDM_* config').

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