Skip to main content
Glama

Assign entity to area

entities_assign_entity_to_area
DestructiveIdempotent

Assign an entity to a new area in Home Assistant, replacing its current area assignment. Use when moving an entity to a different area in the registry.

Instructions

Assign an entity to an area, replacing its current area assignment.

Calls WS config/entity_registry/update with area_id=area_id; any previous area assignment is overwritten and not returned.

Use when: moving an entity to a different area in the registry. Not for: renaming it, or toggling exposure — use entities_update_entity_name or entities_set_entity_exposure. Returns: the updated entity registry entry from Home Assistant.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
area_idYesArea registry ID to assign the entity to, replacing any current area.
entity_idYesFull entity ID to reassign, e.g. 'light.kitchen'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.25.1
    • addedInput schema / properties / area_id / description
      Added value: +"Area registry ID to assign the entity to, replacing any current area."
    • addedInput schema / properties / entity_id / description
      Added value: +"Full entity ID to reassign, e.g. 'light.kitchen'."
  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 destructiveHint=true and idempotentHint=true, so the safety profile is covered. The description still adds real context the annotations don't: the previous assignment is overwritten and not returned, and the underlying WS call. It stops short of stating any permission or failure behavior.

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-loaded with the action, then Use when / Not for / Returns in labeled clauses. Every sentence carries information an agent needs; nothing is padding.

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?

Output schema exists, so the brief 'Returns' note is sufficient and non-redundant. With full schema coverage, clear routing, and the overwrite caveat stated, an agent has everything needed to invoke this correctly.

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%, so both parameters (entity_id, area_id) are already documented in the schema. The description restates the overwrite semantics for area_id but adds no format or syntax detail beyond it. Baseline 3 is correct.

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 (assign), resource (entity), and target (area), and immediately qualifies it with 'replacing its current area assignment.' The agent can distinguish it from name/exposure siblings without opening 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?

Explicit 'Use when: moving an entity to a different area in the registry' and 'Not for: renaming it, or toggling exposure,' with the two correct alternative tools named. This is textbook when/when-not/alternative routing.

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