Skip to main content
Glama

Show config inside a backup

proxmox_get_backup_config
Read-only

Read a backup archive's guest configuration (CPU, memory, disks, network) without restoring it to verify backup contents or required storage; secrets are redacted.

Instructions

Show the guest configuration stored inside a backup archive (cores, memory, disks, network...) without restoring it, e.g. to check what a backup contains or which storage its disks need. Secrets are redacted.

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": {
      "volid": "<volid>"
    },
    "name": "proxmox_get_backup_config"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the config file text as stored (secrets redacted)
nodeNoNode to access the storage from. Needed for node-local storages present on several nodes (use the node shown by proxmox_list_backups); looked up automatically otherwise
volidYesBackup volume ID as listed by proxmox_list_backups, e.g. local:backup/vzdump-qemu-100-2025_01_01-02_00_00.vma.zst or pbs:backup/vm/100/2025-01-01T02:00:00Z

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4/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 structurally. The description still earns credit for adding two pieces of behavior not in the annotations: the operation is non-destructive to the archive ('without restoring it') and output is sanitized ('Secrets are redacted'), which matters because an agent may otherwise hesitate or misreport credential data.

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 sentence that front-loads the verb and resource, then the scope constraint, then the use case, then the security caveat. No filler, no repetition of the title, and it terminates rather than trailing off.

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?

There is no output schema, so the description must convey the return shape, and the parenthetical '(cores, memory, disks, network...)' does sketch it along with the redaction caveat. It is not fully complete — the distinction between the parsed summary and the raw config text is left to the schema — but for a three-parameter read tool it covers what an agent needs to decide and call correctly.

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 volid, node, and raw are all documented in the schema itself, establishing a baseline of 3. The description adds nothing parameter-specific — it does not explain what 'raw' returns versus the parsed view, nor reinforce the node-lookup nuance — so it sits at the baseline.

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 pairs a specific verb ('Show') with a precise resource ('the guest configuration stored inside a backup archive') and qualifies the scope with 'without restoring it'. That scope word does implicitly separate it from live-config siblings such as proxmox_get_vm_config, but no alternative is named, so the differentiation is inferred rather than stated.

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?

It gives a concrete use case: 'e.g. to check what a backup contains or which storage its disks need', which tells an agent exactly when this tool earns its call. There are no exclusions or named alternatives (e.g. 'use proxmox_list_backup_files to browse archives'), so it stops short of full routing guidance.

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