Get System Overview
ha_get_overviewFetch a categorized Home Assistant system overview—version, location, entities, notifications, and repairs—with adjustable detail and domain filters for efficient AI analysis.
Instructions
Get AI-friendly system overview with intelligent categorization.
Returns comprehensive system information at the requested detail level, including Home Assistant base_url, version, location, timezone, entity overview, and active persistent notifications (if any). Use 'minimal' (default) for most queries. Domain counts and states_summary are always complete regardless of entity pagination. Standard/full modes paginate entities (default 200 per page) — use offset to fetch more. Use 'domains' filter to narrow scope.
Use fields= to project the response to only the keys you need — a significantly smaller payload when fetching a single sub-section (e.g. fields=["system_info"] returns just that section instead of the full overview).
When (and only when) the ha-mcp settings-UI sidecar is running
(stdio mode, e.g. Claude Desktop / Claude Code), the response
includes a settings_url field — the local URL to the
tool-configuration page. Hand this URL to the user when they
ask how to enable or disable tools or change server settings.
settings_url is emitted regardless of fields=
projection (so it stays discoverable even when callers
minimize the response) but only when the sidecar URL file
actually exists.
In standalone HTTP / Docker modes, when an HTTP settings prefix is
advertised, there is no sidecar URL file and the server can't know its
externally reachable host. The response instead carries a
settings_url_hint string telling the user where the page is mounted
and how to find or construct the full URL.
Hand whichever of the two fields is present to the user.
The response also carries an ha_mcp_update object
{current, latest, update_available} reporting whether a newer ha-mcp
release is available (PyPI for pip/Docker, the Supervisor add-on store
for the add-on) — proactively tell the user when update_available is
true. Emitted regardless of fields=; omitted only for the
unknown version and when HA_MCP_DISABLE_UPDATE_CHECK is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max total entities across all domains (default: unlimited for minimal, 200 for standard/full). Counts and states always complete. Use with offset for pagination. | |
| fields | No | Return only the specified top-level response keys to reduce response size (e.g. ["system_info", "domains"]). None = full response (default). Available keys: success, system_summary, domain_stats, area_analysis, ai_insights, pagination, partial, warnings, device_types, service_availability, system_info, notification_count, notifications, repair_count, dismissed_repair_count, repairs, repairs_error, tool_discovery, settings_url, settings_url_hint, read_only_mode, read_only_mode_hint, ha_mcp_update. Note: ``settings_url`` (stdio mode), ``settings_url_hint`` (standalone HTTP/Docker mode), the ``read_only_mode`` / ``read_only_mode_hint`` pair (only while Read Only Mode is on), and ``ha_mcp_update`` (when an update check applies) are emitted regardless of ``fields=`` projection so the settings page, the active mode, and a newer ha-mcp release stay discoverable; see the tool description. | |
| offset | No | Number of entities to skip for pagination (default: 0) | |
| domains | No | Filter to specific domains (e.g. 'light,sensor' or ['light','sensor']). None = all domains. Useful to avoid context window overload. | |
| detail_level | No | 'minimal': 10 entities/domain, top-5 states (default); 'standard': 200 entities/page, top-10 states (use offset for more); 'full': 200 entities/page + entity_id + state + full states. Use 'domains', 'limit', or max_entities_per_domain to control size | minimal |
| include_state | No | Include state field for entities (None = auto based on level). Full defaults to True. | |
| include_entity_id | No | Include entity_id field for entities (None = auto based on level). Full defaults to True. | |
| include_notifications | No | Include active persistent notifications (default: True). Set False to skip. | |
| max_entities_per_domain | No | Override default entity cap per domain (minimal=10, standard/full=unlimited). 0 = no limit on entities or states. | |
| include_dismissed_repairs | No | Include user-dismissed/ignored repairs (default: False). Matches the HA Repairs UI which hides dismissed items by default. To dismiss/ignore a repair, call ha_call_service with ws_command="repairs/ignore_issue" and data={"domain": ..., "issue_id": ..., "ignore": true}. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||