Skip to main content
Glama

Get VM configuration

proxmox_get_vm_config
Read-only

Retrieve a VM's Proxmox-stored configuration, including pending or snapshot values, and get the digest needed for safe concurrent edits.

Instructions

Get a VM's configuration as Proxmox stores it (key → value, secrets redacted). By default pending changes are shown applied; current=true shows the running values instead, pending=true lists every key with its current and pending value, and snapshot reads the config saved in a snapshot. The digest can be passed to proxmox_update_vm_config for safe concurrent edits.

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_config"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100
currentNoShow the current (running) values instead of values with pending changes applied
pendingNoList each key with its current value, pending value and pending deletion
snapshotNoRead the configuration stored in this snapshot

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.2/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 context — that secrets are redacted and that the returned digest supports concurrency-safe edits. It could still say more about pagination or size, but for a read tool this is solid added value.

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?

Three dense sentences, zero filler. The return format and the mode behavior are front-loaded before the concurrency note, which is the least urgent detail.

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

Completeness5/5

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

No output schema exists, and the description compensates by describing the returned structure and redaction. With all five parameters documented and the three modes explained, an agent has everything needed to call this correctly.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description goes beyond it by stating the default behavior (pending changes shown applied) and by tying the returned digest to a downstream update call, which the schema cannot express. The mutual exclusivity of current and pending is still not stated.

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 a VM's configuration") and even characterizes the return shape (key → value, secrets redacted). It does not explicitly name a sibling such as proxmox_get_vm or proxmox_get_container_config, so differentiation from adjacent reads is left to the resource noun alone.

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?

Clearly explains the mode selection: default shows pending changes applied, current=true shows running values, pending=true lists both values, snapshot reads a saved config. It also flags the digest hand-off to proxmox_update_vm_config. No explicit when-not-to-use or named alternative, which keeps it below a 5.

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