Skip to main content
Glama

Restart Home Assistant

system_restart_ha
DestructiveIdempotent

Restart Home Assistant after a config change that requires a full restart. Requires confirm=true; causes about 30 seconds of downtime.

Instructions

Restart Home Assistant after an explicit confirmation.

Calls the homeassistant.restart service, which causes roughly 30 seconds of downtime for the whole instance, including this add-on. Without confirm=True nothing is restarted; the call only returns a safety prompt describing how to confirm.

Use when: a config change requires a full restart, e.g. after system_check_config reports the config is valid. Not for: a no-downtime reload — use system_reload_all; stopping HA without restarting it — use system_stop_ha; restarting only Core under Supervisor — use supervisor_restart_core. Returns: the homeassistant.restart service-call result when confirmed, otherwise a confirmation prompt. Errors: returns {"error": "confirmation_required", "message": ..., "action": ...} when confirm is false. Limits: interrupts Home Assistant for about 30 seconds; requires confirm=True.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
confirmNoSet true to actually restart HA. False (default) performs no restart and instead returns a confirmation prompt.

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 / confirm / description
      Added value: +"Set true to actually restart HA. False (default) performs no restart and instead returns a confirmation prompt."
  2. Changed1 schema field changedv0.18.1
    • addedInput schema / properties / confirm
      Added value: +{
      +  "default": false,
      +  "type": "boolean"
      +}
  3. 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 mark this destructive/non-read-only, and the description adds substantially more: ~30 seconds of whole-instance downtime including the add-on itself, the fact that `confirm=False` performs no restart and only returns a prompt, and the exact error payload shape. That is the kind of consequence detail annotations cannot express.

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-loaded with the action and its precondition, then segmented into Use when / Not for / Returns / Errors / Limits. Dense but every line carries operational information; nothing is redundant filler.

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 high-impact, single-parameter mutation tool, the description covers trigger conditions, exclusions, downtime, confirmation semantics, return values and error shapes. An agent has everything needed to decide and to call it safely.

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 goes beyond the schema by spelling out the two distinct execution paths (no-op safety prompt vs. actual restart) and the `confirmation_required` error contract tied to `confirm`.

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 Home Assistant') and immediately pins the scope with 'after an explicit confirmation' and the underlying `homeassistant.restart` service call. It is clearly distinguishable from the sibling restart/reload tools without opening any 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 gives a 'Use when' trigger (a config change requiring a full restart, e.g. after `system_check_config` validates), a 'Not for' list, and names three concrete alternatives (`system_reload_all`, `system_stop_ha`, `supervisor_restart_core`) with the condition that selects each. This is textbook routing guidance.

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