Skip to main content
Glama

pve_backup_job_update

Update a Proxmox VE cluster backup job configuration. Dry-run mode returns a plan; use confirm=true to apply changes.

Instructions

MUTATION: update a PVE cluster backup job. Dry-run by default — the PLAN captures current config so you can revert manually; confirm=True to execute and returns synchronously (no task UPID). Config-only; no impact on existing backups. To create a new job use pve_backup_job_create; to remove one use pve_backup_job_delete.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoNew backup mode: snapshot | suspend | stop; omit to leave unchanged.
vmidNoNew CSV of guest IDs the job covers; omit to leave unchanged.
job_idYesID of the existing PVE backup job to update.
commentNoNew free-text note; omit to leave unchanged.
confirmNoGate: false returns a dry-run PLAN, true executes the update.
enabledNoWhether the job is active; omit to leave unchanged.
storageNoNew storage ID for the job's backups; omit to leave unchanged.
compressNoNew compression algorithm, e.g. zstd, gzip, lzo, or 0 (no compression); omit to leave unchanged.
scheduleNoNew Proxmox calendar-event schedule string; omit to leave unchanged.
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses mutation, dry-run behavior, synchronous return, config-only nature, and no impact on existing backups. Lacks mention of auth requirements or rate limits, but overall thorough.

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?

Description is concise, front-loaded with purpose, then behavior, then alternatives. No wasteful sentences.

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?

Covers purpose, behavior, alternatives, and dry-run nuance. Could mention that only provided parameters are updated, but schema infers that. Output schema is separate.

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 coverage is 100%, and the description does not add significant meaning beyond the schema's parameter descriptions. The description mentions confirm and dry-run, but these are already in schema.

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?

The description explicitly states 'update a PVE cluster backup job' and distinguishes it from create and delete siblings, making the purpose very clear.

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

Usage Guidelines5/5

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

Provides clear guidance on when to use (to update), alternative tools for create/delete, and explains the dry-run default and confirm=true execution.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server