You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`enable_custom_component_integration`*(beta)*| Enables `ha_install_mcp_tools` installer tool for the `ha_mcp_tools` custom component. |`false`|
23
+
|`tool_search_max_results`| Max results from `ha_search_tools` (range 2-10) |`5`|
24
+
|`disabled_tools`| Comma-separated list of tool names to disable (seed value; web UI is primary) | empty |
25
+
|`pinned_tools`| Comma-separated list of tool names to pin when tool search is enabled (seed value; web UI is primary) | empty |
20
26
21
27
Beta options are hidden under "Show unused optional configuration options" in the add-on Configuration tab. See [beta.md](https://github.com/homeassistant-ai/ha-mcp/blob/master/docs/beta.md) for details.
22
28
29
+
## Tool Settings Web UI
30
+
31
+
The add-on exposes a web-based settings page for managing which tools are available to AI assistants. Click **"Open Web UI"** on the add-on info page to access it.
32
+
33
+
Features:
34
+
-**Enable/disable individual tools** — toggle each tool on or off
35
+
-**Pin tools** — keep tools always visible when `enable_tool_search` is on
36
+
-**Per-group master toggle** — enable/disable all tools in a group (HACS, System, etc.) with one click
37
+
-**Search** — filter tools by name or title
38
+
-**Mandatory tools** — `ha_search_entities`, `ha_get_overview`, `ha_get_state`, `ha_report_issue` are always enabled and cannot be disabled
39
+
-**Feature-gated tools** — `ha_config_set_yaml` (requires `enable_yaml_config_editing`), filesystem tools (require `enable_filesystem_tools`), and `ha_install_mcp_tools` (requires `enable_custom_component_integration`) appear in the list with a note if their feature flag is off
40
+
-**In-UI restart** — a "Restart Add-on" button appears after saving to apply changes with one click
41
+
42
+
**Important:** Tool configuration changes require an add-on restart to take effect. The UI will prompt you to restart after saving.
43
+
44
+
### Non-add-on installations
45
+
46
+
In Docker (`ha-mcp-web`) and standalone HTTP installations, the settings UI is mounted under your MCP secret path. Open `http://<host>:<port>/<secret_path>/settings` (the same URL prefix that protects your MCP endpoint). This keeps the auth posture consistent — anyone who can reach your MCP endpoint can also use the settings UI; anyone who can't, can't.
47
+
48
+
### Text-field fallback
49
+
50
+
If you prefer not to use the web UI (or want to set these before first start), the `disabled_tools` and `pinned_tools` options accept comma-separated tool names as seed values. On first start, the add-on creates `/data/tool_config.json` from these values. After that, the web UI is the source of truth.
51
+
23
52
## Updates
24
53
25
54
The dev channel updates automatically with every commit to master. You may receive multiple updates per day.
0 commit comments