Skip to main content
Glama

Get an HA resource

proxmox_get_ha_resource
Read-only

Retrieve a Proxmox VE high-availability resource's configuration, current status, and referencing HA rules by VMID or resource ID for PVE 9+ clusters.

Instructions

Get one HA resource's configuration, its current status, and the HA rules that reference it (PVE 9+).

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": {
      "sid": "<sid>"
    },
    "name": "proxmox_get_ha_resource"
  }
}

Input Schema

NameRequiredDescriptionDefault
sidYesHA resource ID like vm:100 or ct:200, or just the VMID (100) which is resolved to vm:/ct: automatically

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 real value by specifying the composite return (config + status + referencing rules) and the PVE 9+ version caveat. It does not address the surprising idempotentHint=false on an apparently read-only call, nor behavior when the SID 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?

A single front-loaded sentence that names the resource first and then the returned components; no filler or redundant restatement of the title.

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?

With one fully documented parameter and no output schema, the description carries the burden of describing the return payload, which it does. The only gap is behavior for older PVE versions where the rules portion is unavailable.

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% and the sid parameter is fully documented in the schema, including the vm:100/ct:200 versus bare VMID resolution. The description adds no parameter detail beyond that, so the baseline 3 applies.

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 states a specific verb ('Get') and resource ('one HA resource') and enumerates the payload: configuration, current status, and referencing HA rules. This distinguishes it from the plural list siblings, though it does not explicitly name a sibling to avoid.

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 by 'one' versus the list_ha_resources sibling, but there is no explicit when-to-use or when-not-to-use guidance, and no mention of what to do if the resource is not under HA management.

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