pve_ha_resources_list

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

No annotations provided, but the description states it is read-only and describes the return value structure (list of dicts with SID, type, state, group, restart settings). This provides good behavioral transparency beyond mere read-only hint.

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 sentences with no wasted words. Purpose is front-loaded, and key details are provided efficiently.

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?

Tool is simple with one optional parameter and has an output schema. Description explains what the list contains and how it differs from other HA tools. Complete enough for an agent to select and invoke correctly.

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% (only parameter is proximo_target with schema description). The description does not add additional parameter semantics beyond what the schema already provides, so baseline 3 applies.

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 it lists all guests managed by HA with current HA settings, and specifies verb, resource, and scope. It also distinguishes from sibling tools pve_ha_groups_list and pve_ha_rules_list by stating they are for placement rules, not resource enumeration.

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 alternative tools: 'Use pve_ha_groups_list or pve_ha_rules_list to view HA placement rules, not for resource enumeration.' Also implies read-only nature.

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