Skip to main content
Glama

Get backup job

proxmox_get_backup_job
Read-only

Retrieve a backup job's settings, included guests, and per-guest backed-up disks, including why some disks are excluded.

Instructions

Get one backup job's settings plus the guests it currently includes and, per guest, which disks are backed up (and why others are excluded, e.g. backup=0).

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": {
      "id": "<id>"
    },
    "name": "proxmox_get_backup_job"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesBackup job ID (see proxmox_list_backup_jobs)
rawNoReturn the full unprocessed objects from the API (larger)
include_volumesNoInclude the covered guests and their disks (default true)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.5/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 behavioral context by describing the response shape, including per-guest disk coverage and the reasons disks are excluded (e.g. backup=0). It does not explain the unusual idempotentHint=false on a read-only getter or what raw=true changes in practice.

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 densely packed sentence, front-loaded with the primary action and then the returned detail; nothing is padding. The nested parenthetical about excluded disks is slightly awkward but carries real information.

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 read-only getter with three fully documented parameters and no output schema, the description gives enough of the return shape to call it confidently. Minor gaps—behavior of raw, error case for an unknown id, and the idempotentHint=false oddity—are not blocking.

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 all three parameters are already documented, and the description only mildly enriches them by clarifying that 'currently includes' corresponds to the guest/volume data. It adds no format or behavioral detail about id or raw beyond the schema, so baseline 3 is correct.

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 and resource ('Get one backup job's settings') and precisely enumerates the returned scope (included guests and per-guest disk coverage). The word 'one' implicitly contrasts with the list operation, but it never names a sibling, leaving ambiguity against proxmox_get_backup_config, which sounds like it could return the same settings.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance and no alternative named; an agent must infer that this is the single-job inspection call rather than the list or config call. The only routing hint ('see proxmox_list_backup_jobs') lives in the schema for the id parameter, not in the description.

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