Skip to main content
Glama

Get an HA group

proxmox_get_ha_group
Read-only

Retrieve a Proxmox VE high-availability group's configuration by name to inspect its nodes and settings on PVE 8; PVE 9 replaces HA groups with HA rules.

Instructions

Get one HA group's configuration (PVE 8; deprecated in PVE 9 in favour of HA rules).

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": {
      "group": "<group>"
    },
    "name": "proxmox_get_ha_group"
  }
}

Input Schema

NameRequiredDescriptionDefault
groupYesHA group name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds genuine behavioral context the annotations cannot: the tool targets PVE 8 semantics and is deprecated on PVE 9 in favour of HA rules, which affects whether an agent should call it at all. It does not say what happens when the group name is unknown.

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?

One compact sentence with the action up front and the version/deprecation caveat parenthetically attached. No filler or redundancy.

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

Completeness4/5

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

For a one-parameter read tool with annotations and no output schema, the description covers purpose, version applicability, and migration guidance. Minor gaps remain around the returned configuration fields and failure behavior for a nonexistent group.

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?

There is a single parameter with 100% schema description coverage ('HA group name'), so the schema already carries the meaning. The description adds no format, naming convention, or lookup behavior beyond it, making the baseline 3 appropriate.

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 group's configuration'), and the singular 'one' implicitly distinguishes it from proxmox_list_ha_groups. It does not name the sibling explicitly, so it stops short of the top mark.

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 implied: fetch a single group's config by name, and the deprecation note hints that HA rules are the preferred path on PVE 9. There is no explicit guidance on when to choose this over proxmox_get_ha_rule or proxmox_list_ha_groups beyond that hint.

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