pdm_pve_qemu_config

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

No annotations provided, so description carries full burden. It declares read-only, no state change, return type, and critical behavior of state parameter. Could be more explicit about auth requirements beyond vague 'Needs PROXIMO_PDM_* config'.

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?

Concise: three sentences plus a note. Front-loaded with 'READ-ONLY'. No wasted words; every sentence adds value.

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 tool with 6 params (100% schema coverage), output schema exists, and complexity is modest, the description is complete. It covers purpose, usage, behavioral traits, parameter nuances, and alternative 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 100%, so baseline is 3. Description adds value by clarifying that state is required by API despite schema having default, and node/snapshot are optional. This goes beyond schema descriptions.

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 it retrieves a VM's config via PDM proxy, with verb 'get' and specific resource 'VM's config from a PDM-registered PVE remote'. It distinguishes from sibling pve_guest_config_get by noting the proxied vs. direct access.

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 mentions when to use this tool vs. alternative: 'To query the cluster directly without PDM, use pve_guest_config_get'. Also warns about the state parameter being required by the API despite schema default, guiding correct usage.

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