pdm_pve_resources

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

Clearly marks as 'READ-ONLY', 'No state change', and describes return format ('shaped like PVE's cluster/resources'). Mentions configuration requirement (PROXIMO_PDM_* config). With no annotations, the description fully covers behavioral traits.

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?

Three concise sentences: 1) purpose and read-only, 2) return shape and filtering, 3) alternative command and config need. No redundant information.

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?

With output schema present, return values are covered. Description addresses safety, filtering, alternatives, and configuration. For a listing tool, it provides sufficient context for correct selection and invocation.

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. Description adds value by providing examples for 'kind' ('vm, storage, node, sdn, ...') and clarifying 'remote' as a name from pdm_remotes_list.

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 starts with 'READ-ONLY: list resources on ONE PDM-registered PVE remote', clearly stating the action and target. It differentiates from sibling 'pve_cluster_resources' by noting the PDM proxy.

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 states when to use (list resources via PDM) and when not (use pve_cluster_resources for direct cluster query). Also mentions the 'kind' filter, but could elaborate on scenario selection among the many PDM-related siblings.

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