Skip to main content
Glama

Create a Supervisor backup

supervisor_create_backup

Create a named Supervisor backup, full, partial, or password-protected, without deleting any existing backups.

Instructions

Create a new Supervisor backup, full or partial.

Calls POST /backups/new/full when neither addons nor folders is given, otherwise POST /backups/new/partial with those slugs/folders. Unlike system_create_backup, this never deletes older backups — it only adds a new one.

Use when: a named, partial and/or password-protected backup is needed on a Supervisor install. Not for: a quick backup using the instance's own automatic-backup settings (which may prune old ones) — use system_create_backup. Returns: Supervisor's backup-job result, including the new backup's slug on success. Errors: {"error": "SUPERVISOR_TOKEN not set — Nexus must run as HA add-on for Supervisor API"} when the token env var is missing; {"error": "HTTP <status>", "detail": ...} on a timeout or failure — check supervisor_list_backups before retrying. Limits: a full backup can take minutes; on a timeout error, check supervisor_list_backups before retrying rather than assuming failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name to store on the new backup.
addonsNoAdd-on slugs to include for a partial backup. Omit together with `folders` for a full backup of everything.
foldersNoFolder names to include for a partial backup, e.g. 'share', 'ssl', 'media', 'addons/local'. Omit together with `addons` for a full backup of everything.
passwordNoPassword to encrypt the backup with. Omit for an unencrypted backup.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.25.1
    • addedInput schema / properties / addons / description
      Added value: +"Add-on slugs to include for a partial backup. Omit together with `folders` for a full backup of everything."
    • addedInput schema / properties / folders / description
      Added value: +"Folder names to include for a partial backup, e.g. 'share', 'ssl', 'media', 'addons/local'. Omit together with `addons` for a full backup of everything."
    • addedInput schema / properties / name / description
      Added value: +"Human-readable name to store on the new backup."
    • addedInput schema / properties / password / description
      Added value: +"Password to encrypt the backup with. Omit for an unencrypted backup."
  2. First observedv0.3.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=false. The description adds substantial behavioral context beyond that: it explains the full-vs-partial endpoint selection, clarifies that older backups are never deleted, documents the required SUPERVISOR_TOKEN environment variable, describes HTTP and timeout error shapes, and warns that full backups can take minutes. This is rich operational disclosure that goes well past the annotations.

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?

The description is front-loaded with the core action, then structured into Use when, Not for, Returns, Errors, and Limits sections. Every sentence adds distinct value, and there is no redundant restatement of the schema or annotations.

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?

For a non-idempotent, mutating backup-creation tool with four parameters, this description covers the necessary context: when to use it versus system_create_backup, endpoint behavior, authentication failures, timeout handling, and expected return content. An output schema exists, but the description still helpfully notes that a new backup slug is returned on success.

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 description coverage is 100%, so the schema already documents all four parameters. The description still adds useful semantics by explaining the conditional endpoint behavior: full backup when neither addons nor folders is given, otherwise partial backup using those slugs/folders. It also frames password as enabling a password-protected backup, which reinforces the parameter's purpose.

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 (Create), resource (Supervisor backup), and scope (full or partial), and explicitly distinguishes itself from system_create_backup by noting it never deletes older backups. An agent can immediately understand what the tool does and how it differs from the closest sibling.

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 explicit 'Use when' and 'Not for' guidance, naming system_create_backup as the alternative for quick automatic backups that may prune old ones. It also tells the agent to check supervisor_list_backups before retrying after a timeout, giving clear operational context.

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