Skip to main content
Glama
Sign In
Home Assistant MCP Server

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Delete Dashboard

ha_config_delete_dashboard
DestructiveIdempotent

Delete a storage-mode Home Assistant dashboard and its configuration; resolves URL paths or internal IDs, while YAML-mode dashboards cannot be deleted via the API.

Instructions

Delete a storage-mode dashboard completely.

WARNING: This deletes the dashboard and all its configuration; with auto-backup on, ha_manage_backup(scope='edits', action='restore') re-creates it. YAML-mode dashboards are defined in configuration.yaml and cannot be deleted via the API.

HA internal IDs may differ from url_path (e.g. hyphens → underscores); the tool resolves either form to the actual registry ID before deletion. 'default' is an alias for 'lovelace'.

EXAMPLES:

  • Delete dashboard: ha_config_delete_dashboard("mobile-dashboard")

If a Claude Desktop user gets a 4-minute timeout with no result on this call, read the target back before repeating it, and tell them to wait a few seconds before clicking the manual-approve button, as clicking it too quickly is known to cause hangs in Claude Desktop. This workaround is specific to Claude Desktop.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "url_path": "<url_path>"
    },
    "name": "ha_config_delete_dashboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
url_pathYesDashboard URL path or internal ID to delete (e.g., 'my-dashboard' or 'my_dashboard'). Both forms are accepted.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv7.14.2

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, and the description goes well beyond them: it states that all configuration is destroyed, that an auto-backup can re-create it, that YAML-mode dashboards are immune, and that IDs are resolved to a registry ID before deletion. This is exactly the context a caller needs before firing a destructive, irreversible-looking operation.

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?

The warning is correctly front-loaded ahead of examples, and the examples block is tight. The closing Claude Desktop timeout paragraph is long and harness-specific rather than tool semantics, which dilutes an otherwise efficient description.

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 destructive tool with an output schema, the description covers the destructive blast radius, the backup recovery route, the YAML-mode limitation, ID/alias resolution, and a concrete example. Nothing an agent needs in order to call it safely is left implicit.

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% and already notes that both ID and url_path forms are accepted, so the description's added value is the nuance: hyphens may map to underscores internally, either form is resolved to the real registry ID, and 'default' is an alias for 'lovelace'. That meaning is genuinely absent from the schema, though the failure mode when neither form resolves is unstated.

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 ('Delete a storage-mode dashboard completely') and immediately narrows the scope to storage-mode, which distinguishes it from the sibling read/set dashboard tools and from the YAML-mode case. An agent can identify exactly what this operates on 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear conditions: storage-mode only, YAML-mode dashboards cannot be deleted via the API, and 'default' aliases 'lovelace'. It also points to a recovery path via ha_manage_backup(scope='edits', action='restore') and tells the agent to read the target back after a timeout. It stops short of naming the direct alternative for editing (ha_config_set_dashboard) or stating an explicit 'do not use this to update' exclusion, so not a full 5.

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