Skip to main content
Glama

Rename entity in registry

entities_update_entity_name
DestructiveIdempotent

Rename a Home Assistant entity's display name in the entity registry. Use it to correct or customize how an entity appears without changing its area, enabled state, or ID.

Instructions

Rename an entity in the entity registry, replacing its current display name.

Calls WS config/entity_registry/update with name=name; the previous name is not returned or preserved anywhere by this call.

Use when: correcting or customising an entity's display name. Not for: reassigning area, or enabling/disabling — use entities_assign_entity_to_area, entities_disable_entity, entities_enable_entity. Returns: the updated entity registry entry from Home Assistant.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesNew display name to store in the entity registry, replacing the current one.
entity_idYesFull entity ID whose registry entry is renamed, 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 / entity_id / description
      Added value: +"Full entity ID whose registry entry is renamed, e.g. 'light.kitchen'."
    • addedInput schema / properties / name / description
      Added value: +"New display name to store in the entity registry, replacing the current one."
  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 readOnlyHint=false, destructiveHint=true, and idempotentHint=true, so the agent knows this mutates and is repeatable. The description adds genuinely new context by disclosing the underlying WS endpoint and that the previous name is not returned or preserved, which is what makes this destructive. It stops short of describing auth or rate constraints, but coverage is strong.

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 with the action, then structured Use when / Not for / Returns sections that make it scannable. The trailing 'Returns' line is mildly redundant given an output schema exists, but the format is otherwise efficient and every section earns its place.

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 two-parameter mutation with full schema coverage, annotations covering the safety profile, and a separate output schema, the description supplies everything else an agent needs: scope, prerequisites, exclusions, and the loss of the prior name.

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% with only two well-documented parameters ('name' replacement semantics, 'entity_id' format example), so the schema carries the burden. The description's 'name=name' mapping adds little beyond that. 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+resource ('Rename an entity in the entity registry') and clarifies the scope is the display name only. An agent can distinguish it from siblings like entities_assign_entity_to_area or entities_disable_entity 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' and 'Not for' sections, with the not-for cases routed to three named alternatives (entities_assign_entity_to_area, entities_disable_entity, entities_enable_entity). Nothing is left to inference.

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