Skip to main content
Glama

List HA rules

proxmox_list_ha_rules
Read-only

List Proxmox VE 9+ high-availability rules to inspect node-affinity and resource-affinity policies; filter by rule type or affected resource.

Instructions

List HA rules (PVE 9+): node-affinity rules (which nodes resources prefer or must run on, with priorities) and resource-affinity rules (keep resources together or apart).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proxmox_list_ha_rules"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNoOnly this rule type
fieldsNo
searchNo
resourceNoOnly rules affecting this resource (vm:100, ct:200 or a VMID)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered and the description adds the PVE 9+ availability constraint plus a conceptual taxonomy of the two rule kinds. It does not describe the shape of returned rule objects, ordering, or whether an empty result means "no rules" versus "unsupported version." Given annotations carry the read-only claim, this is adequate but thin.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with the resource name and version gate first, then the two rule categories. The parentheticals earn their place by defining domain terms an agent may not know. Slightly dense nesting of parentheses, but no wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter list tool with no output schema, the description covers what the tool returns conceptually but leaves two parameters unexplained and says nothing about the result envelope or pagination. The version gate is helpful context that a reader could not get from the schema. Adequate for a simple lister, but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: the `type` enum and the `resource` parameter already carry inline descriptions with a format example (vm:100, ct:200). The description's explanation of the two rule types loosely explains what `type` filters on, which is mild added value. It says nothing about `search` or `fields`, the two undocumented parameters, so it does not compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource ("List HA rules") and goes further to enumerate the two rule categories it returns, node-affinity and resource-affinity, with short definitions of each. That makes the scope unambiguous. It does not, however, distinguish itself from near siblings such as proxmox_get_ha_rule or proxmox_get_ha_status, so an agent must infer that this is the plural/list form.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied by the verb "List"; there is no explicit statement of when to prefer this over proxmox_get_ha_rule (single rule) or when a rule listing is appropriate versus ha_groups/ha_resources. The one genuinely useful contextual note is the "(PVE 9+)" version gate, which tells the agent the feature may not exist on older clusters. That partial hint lifts it above a bare 2 but stops short of real routing guidance.

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

Deploy Server

Other Tools