Get System Overview
ha_get_overviewGet a categorized Home Assistant system overview with version, location, timezone, entity counts, and active notifications for quick diagnostics and environment checks.
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.
Requests whose fields= are composed only of system_info, notification, repair, or server metadata fields skip the unrelated state, service, and registry reads.
Do not use this tool to inspect a known entity or a narrow set of entities. Use ha_get_state for one entity, ha_get_entity for registry metadata, or ha_search with a domain or area filter. An unprojected overview collects system-wide state, service, and registry data and can be expensive on large Home Assistant installations.
When the ha-mcp settings-UI sidecar is running (stdio mode, e.g. Claude
Desktop / Claude Code) the response carries settings_url, the local
URL of the tool-configuration page; in standalone HTTP / Docker modes
with an HTTP settings prefix it instead carries settings_url_hint,
saying where the page is mounted and how to construct the full URL. Hand
whichever is present to the user when they ask how to enable or disable
tools or change server settings.
The response also carries ha_mcp_update {current, latest, update_available} (PyPI for pip/Docker, the Supervisor store for the
app) — proactively tell the user when update_available is true.
If it carries python_required, the release needs that Python: give
the user upgrade_command.
Omitted for the unknown version, when HA_MCP_DISABLE_UPDATE_CHECK
is set, or when the update check itself failed.
mcp_client reports the MCP protocol version, client info and
client capabilities this call arrived with, for diagnosing
client-specific behaviour. capabilities: null means the request
carried none to read, not that the client declared none.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ha_get_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max total entities across all domains (default: unlimited for minimal, 200 for standard/full). | |
| fields | No | Return only the specified top-level response keys to reduce response size (e.g. ["system_info", "domain_stats"]). None = full response. 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, mcp_client. 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), ``ha_mcp_update`` (when an update check applies) and ``mcp_client`` are emitted regardless of ``fields=`` projection. | |
| offset | No | Number of entities to skip for pagination | |
| domains | No | Filter to specific domains (e.g. 'light,sensor' or ['light','sensor']). None = all domains. | |
| detail_level | No | 'minimal': 10 entities/domain, top-5 states; 'standard': 200 entities/page, top-10 states (use offset for more); 'full': 200 entities/page + entity_id + state + full states. | 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. | |
| 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. Dismiss or restore one with ha_manage_updates(action='ignore_repair' / 'unignore_repair'). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||