Skip to main content
Glama

Search areas

search_search_areas
Read-onlyIdempotent

Fuzzy-rank Home Assistant areas by name fragment to find an area's id when the exact name is unknown. Returns top scored matches, dropping zero-score results.

Instructions

Fuzzy-rank areas by name.

Scores every area from the area registry against query, keeps only scores above 0, and returns the top limit matches sorted descending.

Use when: you don't know an area's exact id and want a ranked guess from a name fragment. Not for: an exact, unranked area list — use areas_list_areas. Returns: list of dicts (area_id, name, floor_id, icon, score) up to limit entries. Limits: areas that score exactly 0 are dropped entirely; a WS failure yields an empty list rather than an error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of ranked results to return; defaults to 20.
queryYesSearch text to fuzzy-match against area names.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.25.1
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of ranked results to return; defaults to 20."
    • addedInput schema / properties / query / description
      Added value: +"Search text to fuzzy-match against area names."
  2. First observedv0.3.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds non-obvious behavioral traits: zero-score areas are dropped entirely and a WebSocket failure returns an empty list instead of raising an error. That failure-degradation detail is exactly the kind of context annotations cannot convey and prevents misreading an empty result as 'no matches'.

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 one-line summary followed by clearly labeled Use when / Not for / Limits sections; every sentence carries information except the 'Returns' line, which restates the output schema that already exists. Minor redundancy, not bloat.

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 two-parameter read tool with a full schema, complete annotations, and an output schema, the description covers selection criteria, ranking semantics, and failure behavior. Nothing an agent needs to invoke it correctly is missing.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds meaning beyond the schema by explaining that `limit` caps a descending-sorted, zero-filtered result set, clarifying that limit applies after score filtering rather than to the raw registry.

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 operation on a specific resource: 'Fuzzy-rank areas by name.' It also names the sibling it is not (areas_list_areas) and describes the ranking/filtering pipeline (scores above 0, top-N sorted descending), so an agent can distinguish it from the exact-list tool without opening either schema.

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 'Use when' clause ('you don't know an area's exact id and want a ranked guess from a name fragment') and an explicit 'Not for' clause routing to areas_list_areas for an exact, unranked list. Both the trigger and the alternative are spelled out.

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