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 the burden. It labels the tool as 'DIAGNOSE (LOW)', implying no destructive side effects. It also mentions 'live-proven' and config requirements. However, it does not explicitly state read-only behavior, auth needs, or rate limits. For a list operation, this is adequate but not fully 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?

The description is very concise, with each sentence providing essential information: purpose, parameters, test status, and config requirement. It is front-loaded with the main action and uses minimal text 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?

Given there is an output schema (signal indicates true), the description does not need to explain return values. It covers purpose, parameters, and prerequisites (config). The diagnostic label adds appropriate context. Complete for a straightforward list 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 coverage is only 33% (only 'proximo_target' described in schema). The description adds meaning for 'remote' and 'node' parameters ('remote name', 'OPTIONAL filter to one PVE node'), which compensates for the lack of schema descriptions. The remaining parameter is already described in the schema.

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 'DIAGNOSE (LOW): list VMs across a PDM-registered PVE remote (cluster-wide).' This provides a specific verb (list), resource (VMs), and scope (cluster-wide). It distinguishes from sibling tools like pdm_pve_qemu_config (config) and pdm_pve_qemu_power (power).

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 specifies when to use ('DIAGNOSE (LOW)') and lists required (remote) and optional (node) parameters. However, it does not explicitly mention when not to use or provide alternatives, though the sibling tool names imply context. Overall, clear usage guidance but could be more explicit about exclusions.

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