Skip to main content
Glama

Get VM details

proxmox_get_vm
Read-only

Retrieve a VM’s live status, configuration summary, and pending restart-required changes to monitor health and plan maintenance.

Instructions

Get a VM's live status (run state, CPU, memory, disk/network I/O, uptime, HA, lock, guest agent, QEMU version) together with a summary of its configuration (CPU, memory, disks, NICs, boot order, firmware, cloud-init, tags, notes) and any pending changes that need a restart. Use proxmox_get_vm_config for the raw config.

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": {
      "vmid": "<vmid>"
    },
    "name": "proxmox_get_vm"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.1/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 the safety profile is covered; the description adds genuinely new behavioural content by disclosing the exact payload shape (live status + config summary + pending changes). The only hint at cost is 'raw ... larger' via the schema, and there is no note on whether fields are omitted when the guest is stopped or the node is unreachable.

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 no filler, and the disambiguation against the sibling is placed last where it reads naturally. The parenthetical enumerations run long (roughly twenty field names), which aids scope recognition but makes it dense to scan.

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 no output schema, the description carries the burden of explaining returns and does so thoroughly by enumerating the status, configuration and pending-change sections. For a 3-parameter read-only tool with full schema coverage, the only meaningful omission is stated behaviour for edge cases like stopped VMs or inaccessible nodes.

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 description coverage is 100%, so vmid, node auto-lookup and the raw flag are fully documented in the schema. The description adds nothing about parameters — not even that omitted node triggers an automatic lookup, which is the one behaviour most worth surfacing. Baseline 3 applies.

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

Purpose5/5

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

States a specific verb (Get) and enumerates precisely what resource is returned: live status fields (run state, CPU, memory, I/O, uptime, HA, lock, guest agent, QEMU version) plus a config summary and pending restart-requiring changes. It explicitly contrasts itself with proxmox_get_vm_config ('for the raw config'), so the agent can distinguish it from the nearest sibling without opening a schema.

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

Usage Guidelines4/5

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

Clear context for use (a combined overview of runtime state plus configuration) and an explicit alternative with the condition that selects it (proxmox_get_vm_config for raw config). It does not address other plausible near-neighbours such as proxmox_get_vm_stats or proxmox_get_vm_cloudinit, so routing guidance is clear but not exhaustive.

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