Skip to main content
Glama

Get Lovelace dashboard config

dashboards_get_dashboard_config
Read-onlyIdempotent

Retrieve a Lovelace dashboard's full config or a read-only excerpt of one view. Use it to inspect views and sections before editing.

Instructions

Get one Lovelace dashboard's config, or a read-only excerpt of one view.

Calls lovelace/config for url_path as a dashboard; if that raises config_not_found, re-fetches the default dashboard and returns the matching view instead, since url_path may instead be that view's own path.

Use when: reading a dashboard's views/sections before editing it, or inspecting one view without the surrounding dashboard. Not for: passing the view-path result back into dashboards_save_dashboard_config — that excerpt is not a full dashboard config and would delete every other view. Returns: the full dashboard dict (with views) for a dashboard url_path; {"view": ..., "source": "default_dashboard_view", "path": ...} for a view path in the default dashboard. Errors: raises RuntimeError when url_path matches neither a dashboard nor a view in the default dashboard.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
url_pathNoDashboard url_path (e.g. 'map', from dashboards_list_dashboards) or a view path inside the default dashboard (e.g. 'living-room', from /lovelace/living-room). Omit for the full default dashboard.

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 / url_path / description
      Added value: +"Dashboard url_path (e.g. 'map', from dashboards_list_dashboards) or a view path inside the default dashboard (e.g. 'living-room', from /lovelace/living-room). Omit for the full default dashboard."
  2. 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 declare readOnlyHint, idempotentHint, and non-destructive, but the description goes well beyond them by disclosing the config_not_found fallback that re-fetches the default dashboard, the exact error condition (RuntimeError when url_path matches neither), and a data-safety warning about the view excerpt. That is substantive behavioral context not derivable from structured fields.

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 purpose sentence followed by labeled Returns/Errors/Use when/Not for blocks. Every sentence carries operational information (fallback path, return shapes, error condition) with no 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?

Even though an output schema exists, the description usefully names the two distinct return shapes and the failure mode. Combined with annotations and a fully documented single parameter, an agent has everything needed to call this correctly and interpret the result.

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 the schema already explains that url_path may be a dashboard url_path or a view path, so the description largely restates that. It does add value by tying each interpretation to a distinct return shape, clarifying what the single parameter actually controls.

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 ('Get one Lovelace dashboard's config') and immediately adds the dual-mode nuance ('or a read-only excerpt of one view'). This distinguishes it from siblings like dashboards_get_view_sections and dashboards_list_dashboards without the agent needing to open 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?

Contains explicit 'Use when' clauses (reading views/sections before editing, inspecting a single view in isolation) and a 'Not for' clause naming the exact alternative (dashboards_save_dashboard_config) plus the consequence of misuse. This is textbook when/when-not/alternatives 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