Skip to main content
Glama
Fistacho

ha-nexus-agent

by Fistacho
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Restore a full backup

supervisor_restore_backup
DestructiveIdempotent

Restore a full Home Assistant backup after explicit confirmation to revert to a known-good state after a failed update or misconfiguration. Set confirm=True; changes since the backup are lost.

Instructions

Restore a full backup after an explicit confirmation.

Calls POST /backups/<slug>/restore/full, which replaces the HA configuration, every add-on with its data, and the backed-up folders with the backup's contents; anything changed since the backup was taken is lost. Core and this nexus add-on restart as part of the restore, so the call may drop the connection before it can reply. Without confirm=True nothing is restored.

Use when: reverting to a known-good state after a failed update or misconfiguration. Not for: restoring only some add-ons/folders — Supervisor's partial restore is not exposed by this tool. Returns: Supervisor's restore-job result when confirmed; the reply may never arrive because the add-on restarts mid-call. Errors: {"error": "invalid_slug"} for a bad slug; returns {"error": "confirmation_required", "message": ..., "action": ...} when confirm is false; {"error": "HTTP <status>", "detail": ...} if the slug or password is wrong. Limits: WARNING: discards every change made since the backup; requires confirm=True.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesBackup slug to restore, from `supervisor_list_backups`.
confirmNoSet true to actually restore the backup. False (default) performs no action.
passwordNoPassword for an encrypted backup. Omit for an unencrypted one.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.25.1
    • addedInput schema / properties / confirm / description
      Added value: +"Set true to actually restore the backup. False (default) performs no action."
    • addedInput schema / properties / password / description
      Added value: +"Password for an encrypted backup. Omit for an unencrypted one."
    • addedInput schema / properties / slug / description
      Added value: +"Backup slug to restore, from `supervisor_list_backups`."
  2. First observedv0.3.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations: it enumerates exactly what is replaced (HA configuration, every add-on with its data, backed-up folders), warns that all post-backup changes are lost, and discloses that core and the nexus add-on restart mid-call so the reply may never arrive. This is exactly the extra context a destructiveHint=true flag cannot convey.

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?

Front-loaded summary followed by clean labeled sections (Use when / Not for / Returns / Errors / Limits) makes it easy to scan. Minor redundancy: the confirm requirement and the destructive warning each appear more than once across body, Errors, and Limits.

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 destructive operation it covers scope of data loss, restart/connection-drop behavior, the confirmation gate, expected job result, and distinct error shapes. With an output schema present, no return-value detail is missing.

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 100%, so the baseline is 3, but the description adds real meaning: it ties slug to the supervisor_list_backups source, stresses that confirm=False performs no action, and describes the password's role for encrypted backups with matching error replies.

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 (restore) plus resource (a FULL backup) and even names the underlying endpoint. It distinguishes itself from siblings like supervisor_list_backups/supervisor_create_backup and explicitly rules out the partial-restore variant.

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?

Explicit 'Use when' (reverting to a known-good state after a failed update/misconfiguration) and 'Not for' (partial add-on/folder restore, which is not exposed) leave no inference for the agent. The confirm prerequisite is stated up front as a gating condition.

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