Get HA config via WebSocket
ws_get_configRetrieve Home Assistant config over WebSocket to read location, unit system, version, and component list.
Instructions
Get Home Assistant's own configuration over WebSocket.
Sends get_config and waits up to timeout seconds for the matching
result message.
Use when: reading HA's location, unit system, version and component
list over the WebSocket transport.
Not for: the same data over HTTP — use history_get_ha_config.
Returns: HA's config dict from result.result (location, unit_system,
version, components, ...).
Errors: raises RuntimeError when the WebSocket handshake or the
result message does not arrive within timeout, or when a result
message arrives but is not successful.
Limits: blocks for up to timeout seconds (default 10), including the
initial handshake.
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": "ws_get_config"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout | No | Maximum seconds to wait for the WebSocket handshake and the result message before raising an error; must be between 1 and 300. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||