Skip to content

Commit df70a00

Browse files
chore(internal): sync tool docs after merge [skip ci]
1 parent a8d258b commit df70a00

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

site/src/data/tools.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2820,7 +2820,7 @@
28202820
{
28212821
"name": "ha_get_overview",
28222822
"title": "Get System Overview",
2823-
"description": "Get AI-friendly system overview with intelligent categorization.\n\nReturns comprehensive system information at the requested detail level,\nincluding Home Assistant base_url, version, location, timezone, entity overview,\nand active persistent notifications (if any).\nUse 'minimal' (default) for most queries. Domain counts and states_summary\nare always complete regardless of entity pagination.\nStandard/full modes paginate entities (default 200 per page) — use offset\nto fetch more. Use 'domains' filter to narrow scope.\n\nUse fields= to project the response to only the keys you need — a\nsignificantly smaller payload when fetching a single sub-section (e.g.\nfields=[\"system_info\"] returns just that section instead of the full overview).\n\nWhen (and only when) the ha-mcp settings-UI sidecar is running\n(stdio mode, e.g. Claude Desktop / Claude Code), the response\nincludes a ``settings_url`` field — the local URL to the\ntool-configuration page. Hand this URL to the user when they\nask how to enable or disable tools or change server settings.\n``settings_url`` is emitted regardless of ``fields=``\nprojection (so it stays discoverable even when callers\nminimize the response) but only when the sidecar URL file\nactually exists.\n\nIn HTTP / Docker / OAuth modes there is no sidecar URL file and the\nserver can't know its externally reachable host, so the response\ninstead carries a ``settings_url_hint`` string telling the user where\nthe page is mounted and to read the full URL from the startup logs.\nHand whichever of the two fields is present to the user.\n\nThe response also carries an ``ha_mcp_update`` object\n``{current, latest, update_available}`` reporting whether a newer ha-mcp\nrelease is available (PyPI for pip/Docker, the Supervisor add-on store\nfor the add-on) — proactively tell the user when ``update_available`` is\ntrue. Emitted regardless of ``fields=``; omitted only for the\n``unknown`` version and when ``HA_MCP_DISABLE_UPDATE_CHECK`` is set.",
2823+
"description": "Get AI-friendly system overview with intelligent categorization.\n\nReturns comprehensive system information at the requested detail level,\nincluding Home Assistant base_url, version, location, timezone, entity overview,\nand active persistent notifications (if any).\nUse 'minimal' (default) for most queries. Domain counts and states_summary\nare always complete regardless of entity pagination.\nStandard/full modes paginate entities (default 200 per page) — use offset\nto fetch more. Use 'domains' filter to narrow scope.\n\nUse fields= to project the response to only the keys you need — a\nsignificantly smaller payload when fetching a single sub-section (e.g.\nfields=[\"system_info\"] returns just that section instead of the full overview).\n\nWhen (and only when) the ha-mcp settings-UI sidecar is running\n(stdio mode, e.g. Claude Desktop / Claude Code), the response\nincludes a ``settings_url`` field — the local URL to the\ntool-configuration page. Hand this URL to the user when they\nask how to enable or disable tools or change server settings.\n``settings_url`` is emitted regardless of ``fields=``\nprojection (so it stays discoverable even when callers\nminimize the response) but only when the sidecar URL file\nactually exists.\n\nIn standalone HTTP / Docker modes, when an HTTP settings prefix is\nadvertised, there is no sidecar URL file and the server can't know its\nexternally reachable host. The response instead carries a\n``settings_url_hint`` string telling the user where the page is mounted\nand how to find or construct the full URL.\nHand whichever of the two fields is present to the user.\n\nThe response also carries an ``ha_mcp_update`` object\n``{current, latest, update_available}`` reporting whether a newer ha-mcp\nrelease is available (PyPI for pip/Docker, the Supervisor add-on store\nfor the add-on) — proactively tell the user when ``update_available`` is\ntrue. Emitted regardless of ``fields=``; omitted only for the\n``unknown`` version and when ``HA_MCP_DISABLE_UPDATE_CHECK`` is set.",
28242824
"inputSchema": {
28252825
"properties": {
28262826
"detail_level": {
@@ -2860,7 +2860,7 @@
28602860
"default": false
28612861
},
28622862
"fields": {
2863-
"type": "Annotated[str | list[str] | None, JSON_STRING_COERCION, Field(default=None, description='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`` (HTTP/Docker/OAuth 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.')]",
2863+
"type": "Annotated[str | list[str] | None, JSON_STRING_COERCION, Field(default=None, description='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.')]",
28642864
"default": null
28652865
}
28662866
}

0 commit comments

Comments
 (0)