ha-nexus-agent

Overview Schema Source Related Servers Discussions Admin

List Supervisor backups

supervisor_list_backups

Read-onlyIdempotent

List every backup managed by Home Assistant Supervisor to find a backup's slug before restoring or deleting it, or to verify a scheduled backup succeeded.

Instructions

List every backup Supervisor manages.

Calls GET /backups for the full backup catalogue Supervisor tracks.

Use when: finding a backup's slug before restoring or deleting it, or checking whether a scheduled backup succeeded. Not for: HA Core's own backup.create/backup.create_automatic backups when they were not made through Supervisor — those may not appear here under the same view. Returns: Supervisor's raw backups payload. Errors: {"error": "SUPERVISOR_TOKEN not set — Nexus must run as HA add-on for Supervisor API"} when the token env var is missing.

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.3.0May 3, 2026

TDQS

A4.7/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds real value beyond that: the underlying endpoint (GET /backups), the raw response shape, and a concrete token-missing error payload. It stops short of describing pagination or catalogue size limits, so not a full 5.

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?

Front-loads the core action, then uses labeled sections (Use when / Not for / Returns / Errors) that are easy to scan. No wasted sentences; each line earns its place.

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?

An output schema exists, yet the description still usefully notes the raw payload and the auth failure mode. Prerequisites, scope, and error conditions are all covered for a zero-arg listing tool.

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?

The tool takes zero parameters, so the baseline is 4. There is nothing for the description to disambiguate, and it correctly avoids inventing parameter detail.

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 (List) and resource (every backup Supervisor manages) and immediately clarifies the scope distinction from HA Core's own backups. An agent can tell it apart from system_create_backup, supervisor_create_backup, or supervisor_restore_backup without opening the 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?

Explicitly provides both a "Use when" list (finding a slug before restoring/deleting, checking scheduled backup success) and a "Not for" exclusion (HA Core backups not made through Supervisor). This is exactly the routing guidance an agent needs.

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

Deploy Server