Skip to main content
Glama

Get an HA rule

proxmox_get_ha_rule
Read-only

Retrieves one Proxmox VE 9+ high-availability rule by ID and returns its digest for inspection and verification.

Instructions

Get one HA rule (PVE 9+) with its digest.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "rule": "<rule>"
    },
    "name": "proxmox_get_ha_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
ruleYesHA rule ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.5/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. The description adds two pieces of genuine context beyond that: the PVE 9+ version floor and the fact that a digest is returned. It says nothing further about what the digest is for or what the response contains.

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

Conciseness5/5

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

A single short sentence with the resource and the version qualifier front-loaded and zero filler. Nothing could be removed without losing information.

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 one-parameter read-only getter with full schema coverage and no output schema, the definition is minimally sufficient. However, it leaves the agent to guess how to obtain a valid rule ID and what an HA rule object contains, which matters more here because there is no output schema to describe the digest-bearing response.

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 100% for the single 'rule' parameter, which is already documented as 'HA rule ID'. The description adds no meaning beyond that — notably it does not tell the agent where a valid rule ID comes from (e.g., proxmox_list_ha_rules). Baseline 3 applies when the schema carries the parameter.

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?

States a specific verb and resource ('Get one HA rule') and the singular 'one' implicitly separates it from the list_ha_rules sibling. It also adds a version qualifier (PVE 9+). It stops short of naming the alternative explicitly, so it is clear but not perfectly differentiated.

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: the singular 'one' plus the 'PVE 9+' qualifier suggest this is the single-record fetch for newer Proxmox versions. There is no explicit when-to-use, no mention of proxmox_list_ha_rules as the way to discover rule IDs, and no stated prerequisites.

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