Skip to main content
Glama
ffleurey

ha-analytics-mcp

by ffleurey

ha_history_list_areas

List the rooms and locations defined in Home Assistant, optionally search by name, to obtain exact area names for querying device history.

Instructions

Lists the areas (rooms and locations) defined in Home. Use when the user wants to explore areas or when you need the exact area name for ha_history_list_devices. Narrow by name with search. Returns area names to reuse with area="" in ha_history_list_devices, which also surfaces ready entity_ids.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNoOptional search term matched against area names (case-insensitive substring match). E.g. "kitchen", "outdoor", "bedroom". Leave empty to list all areas.
max_resultsNoMaximum number of results to return. Default: all areas.
Behavior4/5

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

With no annotations provided, the description carries the burden. It discloses that the tool lists areas, supports search narrowing, and returns area names to be reused with area="<name>" in ha_history_list_devices. It stops short of explicitly stating the read-only nature or output format, but 'Lists' implies read-only, and the downstream usage hints at the return structure.

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

Conciseness5/5

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

Three sentences, each essential. The first states the purpose, the second gives usage context, and the third explains filtering and downstream integration. No wasted words; the description is front-loaded and scannable.

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?

For a simple list tool with full schema coverage and no output schema, this description is complete. It covers purpose, usage scenarios, parameter semantics, and the relationship to a key sibling tool, giving the agent everything it needs to understand the tool's role and pick it correctly.

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

Parameters4/5

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

The input schema already covers 100% of parameters, so baseline is 3. The description adds value by explaining the search parameter's purpose ('Narrow by name with search') and clarifying how the returned names will be used with the area='<name>' field in ha_history_list_devices, which gives semantic context beyond the schema.

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?

The description opens with 'Lists the areas (rooms and locations) defined in Home', a specific verb and resource. It clearly distinguishes itself from sibling ha_history_list_devices by mentioning areas vs devices, making the tool's scope unambiguous.

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?

Explicit usage guidance is provided: 'Use when the user wants to explore areas or when you need the exact area name for ha_history_list_devices.' This not only states when to use but also references the alternative tool, giving the agent clear decision criteria.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ffleurey/ha-analytics-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server