Skip to main content
Glama

Restart an add-on

supervisor_restart_addon
DestructiveIdempotent

Restart a Home Assistant add-on to apply new options or recover from a stuck state. Briefly stops then starts the add-on, making it unavailable during the process.

Instructions

Restart an add-on (stop, then start).

Calls POST /addons/<slug>/restart. The add-on — which could be this nexus add-on itself — is briefly unavailable during the restart.

Use when: an add-on needs to pick up new options or recover from a stuck state. Not for: a one-way stop — use supervisor_stop_addon; for restarting Core instead — use supervisor_restart_core. Returns: Supervisor's restart-job result. Errors: {"error": "invalid_slug"} for a bad slug; {"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 is unknown. Limits: briefly interrupts the add-on's availability.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesAdd-on slug to restart, e.g. from `supervisor_list_addons`.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / slug / description
      Added value: +"Add-on slug to restart, e.g. from `supervisor_list_addons`."
  2. First observedv0.3.0

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 and idempotentHint=true, but the description adds substantial context beyond them: the add-on may be this nexus add-on itself, it is briefly unavailable during restart, the underlying endpoint (POST /addons/<slug>/restart), the return value, and three distinct error shapes including a missing-token condition. No contradiction with annotations.

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?

Well front-loaded with labeled sections (Use when / Not for / Returns / Errors / Limits) so an agent can scan quickly. The verbose inline error strings are slightly long but each carries actionable information, so little is wasted.

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 single-parameter mutation tool with annotations and an output schema, the description covers purpose, alternatives, side effects, return value, and failure modes. Nothing an agent needs to invoke it correctly is missing.

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?

Only one parameter (slug) with 100% schema description coverage, so the baseline is 3. The description adds only indirect value via the 'invalid_slug' error example; the schema already documents the slug format and its source.

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 and resource ('Restart an add-on (stop, then start)') and immediately clarifies the semantics of what restart means. It explicitly distinguishes itself from the two nearest siblings (supervisor_stop_addon for one-way stop, supervisor_restart_core for Core), so an agent can disambiguate without opening schemas.

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' (picking up new options, recovering from a stuck state) and 'Not for' clauses that name the correct alternative tools by name. This is exactly the routing information an agent needs to choose among supervisor_* tools.

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