pdm_pve_lxc_config

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

No annotations provided, so description carries burden. Discloses that state is required (PDM 400s if omitted) and that node is not required. Does not explicitly state read-only nature or side effects, but is adequate for a diagnostic tool.

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?

Compact and front-loaded with purpose. Uses a structured parameter list. Every sentence adds value; no waste. Minor room for improvement in grouping.

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?

Covers purpose, key parameters, and one behavioral note. Output schema exists, so return values are handled. Lacks sibling comparison, but overall adequate for a focused read 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 low (17%), but description explains 5 of 6 parameters: remote, vmid, node, snapshot, state. Highlights state requirement and default, and node not required. Missing only proximo_target, which has its own schema description.

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?

Description clearly states verb 'get' and resource 'LXC config' from a 'PDM-registered PVE remote'. Differentiates from sibling tools like pdm_pve_lxc_list (list) and pdm_pve_lxc_power (power actions).

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?

Implies usage via 'DIAGNOSE (LOW)' and notes that state defaults to 'active' and is required by PDM. No explicit when-to-use vs alternatives, nor exclusions or prerequisites beyond config.

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