Skip to main content
Glama

Get entities in area

areas_get_area_entities
Read-onlyIdempotent

Retrieve all entity registry rows for a specific area, including entities linked via devices, to enable bulk editing of labels or categories.

Instructions

Get every entity registered in a given area, directly or via its device.

Reads the entity and device registries over WebSocket, then keeps entity-registry rows whose own area_id matches, or whose device_id belongs to a device assigned to the area.

Use when: you need the entity registry rows for one area, e.g. before bulk-editing labels or categories. Not for: current state values — use areas_get_area_states, or a combined view — use snapshot_get_area_snapshot. Returns: list of entity registry dicts (entity_id, device_id, area_id, labels, …) belonging to the area. Limits: an unknown area_id returns an empty list rather than an error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
area_idYesArea registry ID whose entities to return; obtain it from areas_list_areas.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / area_id / description
      Added value: +"Area registry ID whose entities to return; obtain it from areas_list_areas."
  2. First observedv0.3.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so safety is covered. The description adds real value beyond them: it discloses the underlying read path (entity and device registries over WebSocket), the matching rule (own area_id OR device_id of a device assigned to the area), and the limit that an unknown area_id yields an empty list rather than an error. Missing only return-format/pagination detail, which the output schema likely covers.

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?

Front-loads the core action, then uses compact labeled sections (Use when / Not for / Returns / Limits). Every sentence carries unique information; nothing restates the name or title.

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 one-parameter read tool with full schema coverage, annotations, and an output schema, the description covers purpose, routing, semantics, and edge-case behavior. Nothing needed 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.

Parameters3/5

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

Schema description coverage is 100% and the single area_id parameter is fully documented in the schema, including where to obtain it (areas_list_areas). The description adds no syntax or format beyond 'given area', so the baseline 3 applies when the schema does the heavy lifting.

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 entity registry rows for an area) and immediately clarifies the scope: direct area members plus entities reached via their device. It explicitly separates itself from areas_get_area_states and snapshot_get_area_snapshot, so the agent can disambiguate without reading any 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?

Contains an explicit 'Use when' clause (need entity registry rows for one area, e.g. before bulk-editing labels/categories) and a 'Not for' clause naming the two siblings to use instead for state values or combined views. When-to-use, when-not, and alternatives are all present.

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