Skip to main content
Glama
Fistacho

ha-nexus-agent

by Fistacho
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Get HA config via WebSocket

ws_get_config
Read-onlyIdempotent

Retrieve 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.

Input Schema

NameRequiredDescriptionDefault
timeoutNoMaximum seconds to wait for the WebSocket handshake and the result message before raising an error; must be between 1 and 300.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / timeout
      Added value: +{
+  "default": 10,
+  "description": "Maximum seconds to wait for the WebSocket handshake and the result message before raising an error; must be between 1 and 300.",
+  "maximum": 300,
+  "minimum": 1,
+  "type": "number"
+}
  2. First observedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely useful context beyond that: the blocking nature, the default and max timeout, and the precise failure conditions (handshake or result not arriving -> RuntimeError, unsuccessful result). This is richer than annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded summary sentence followed by clearly labeled Use when/Not for/Returns/Errors/Limits blocks. Each line carries information; the structured form is slightly heavier than needed but not padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Even though an output schema exists (so return shape is documented structurally), the description names the return path and fields, documents error modes and timing limits. Nothing an agent needs to invoke this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the schema already documents the timeout with default, min and max. The description repeats the default (10) and adds that blocking includes the initial handshake, but adds little beyond the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get Home Assistant's own configuration over WebSocket') and pins the underlying command (`get_config`). It explicitly distinguishes itself from the HTTP sibling that returns the same data.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit 'Use when' (reading location, unit system, version, components over WebSocket) and 'Not for' ('the same data over HTTP — use history_get_ha_config'). Both the condition and the alternative are named directly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools