Skip to main content
Glama

Browse files in a PBS backup

proxmox_list_backup_files
Read-only

Browse files inside a Proxmox Backup Server backup to locate and restore individual files or disks, starting at / and drilling into directories.

Instructions

Browse the files inside a Proxmox Backup Server backup (single-file restore): start at path "/" to see the archives (disk images/filesystem archives), then drill into directories. Only works for PBS storages. Opening VM disk images starts a temporary restore VM on the node and can take a while on first access.

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

Input Schema

NameRequiredDescriptionDefault
nodeNoNode to run the file restore on (default: any node with the storage)
pathNoPath to list, as shown in earlier results (default "/")
limitNoMaximum number of results (default 500)
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
fieldsNo
searchNo
storageYesPBS storage ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.4/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, but the description adds a non-obvious side effect the annotations cannot convey: opening VM disk images spawns a temporary restore VM on the node and can be slow on first access. It omits other operational details such as permissions, timeouts, or result paging behavior.

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 sentences, front-loaded with what the tool does, followed by the traversal workflow and the performance/side-effect warning. 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?

For a 7-parameter tool with no output schema, the description covers the call ritual, storage constraint, and cost of first access, which is what an agent needs to invoke it safely. It leaves the fields and search parameters unexplained, a minor remaining gap.

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 71%, so several parameters (fields, search) carry no description anywhere. The description compensates for the most important one by explaining path traversal semantics (start at "/", drill into directories) and by clarifying that volid must be a PBS backup, adding meaning beyond the schema text.

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 and resource ("Browse the files inside a Proxmox Backup Server backup") with the scope qualifier "Only works for PBS storages," and names the parent listing tool proxmox_list_backups in the volid schema. An agent can separate this from proxmox_list_backups without opening either 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?

Gives concrete usage workflow: start at "/" to enumerate archives, then drill into directories, and restricts applicability to PBS storages. It stops short of explicitly naming an alternative for non-PBS storages or stating when to prefer a full-restore tool instead.

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