ha-nexus-agent

Overview Schema Source Related Servers Discussions Admin

Delete a Supervisor backup

supervisor_delete_backup

DestructiveIdempotent

Permanently delete a single Home Assistant backup after explicit confirmation. Use it to clean up a backup that is confirmed no longer needed; deletion has no undo.

Instructions

Permanently delete one backup after an explicit confirmation.

Calls DELETE /backups/<slug>. Without confirm=True nothing is deleted; the call only returns a confirmation prompt. There is no undo once the backup file is gone — a backup is itself the undo mechanism for every other change in this add-on.

Use when: cleaning up a backup that is confirmed to be no longer needed. Not for: any situation where the backup might still be needed — there is no recovery after this call, even with confirm=True. Returns: Supervisor's delete result when confirmed, otherwise a confirmation prompt. Errors: {"error": "invalid_slug"} for a bad slug; returns {"error": "confirmation_required", "message": ..., "action": ...} when confirm is false; {"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": ...} if the slug does not exist. Limits: requires confirm=True; deletion is immediate and permanent with no undo once confirmed.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`slug`	Yes	Backup slug to delete, from `supervisor_list_backups`.
`confirm`	No	Set true to actually delete the backup. False (default) performs no action and instead returns a confirmation prompt; the backup is not looked up or touched in that case.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.25.1Oct 4, 2026

addedInput schema / properties / confirm

Added value: +{
+  "default": false,
+  "description": "Set true to actually delete the backup. False (default) performs no action and instead returns a confirmation prompt; the backup is not looked up or touched in that case.",
+  "type": "boolean"
+}

addedInput schema / properties / slug / description

Added value: +"Backup slug to delete, from `supervisor_list_backups`."

First observedv0.3.0May 3, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already declare destructiveHint=true, so the safety profile is known, yet the description adds substantial context beyond it: the confirm gate and the fact that nothing is looked up when confirm is false, the irreversibility ('a backup is itself the undo mechanism'), and the token/add-on prerequisite. It even enumerates concrete error payloads.

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 with the single most important fact (permanent, confirmation-gated) and cleanly sectioned into Use when / Not for / Returns / Errors / Limits. Slight redundancy: the no-undo warning appears twice (opening paragraph and Limits), and Returns/Errors partially restate the output schema.

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, output-schema-bearing mutation tool, the description covers everything an agent needs: prerequisites, confirmation flow, irreversibility, return shape and specific error cases. Having an output schema means the Returns/Errors detail is a bonus rather than a necessity.

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% and both parameters (slug, confirm) are already fully documented there, including the same 'returns a confirmation prompt' behavior. The description reinforces the confirm gate but adds no syntax or value semantics beyond what the schema states, so the baseline 3 applies.

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 + resource ('Permanently delete one backup') and adds the crucial qualifier 'after an explicit confirmation'. It also names the sibling that supplies the slug (`supervisor_list_backups`), letting an agent separate it from supervisor_create_backup / supervisor_restore_backup without opening a schema.

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?

Its structured 'Use when: cleaning up a backup that is confirmed to be no longer needed' and 'Not for: any situation where the backup might still be needed' sections give explicit inclusion and exclusion criteria plus the reason (no recovery). Nothing about routing is left to inference.

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

Deploy Server