Skip to main content
Glama

Update config entry properties

integrations_update_integration_entry
DestructiveIdempotent

Update an existing Home Assistant config entry's title or polling/discovery preferences without using the options flow. Only specified fields are changed; others remain unchanged.

Instructions

Update selected properties of an existing config entry.

Calls the config_entries/update WebSocket command with only the fields given here (title, pref_disable_new_entities, pref_disable_polling) — omitted fields keep their previous stored value, but any field that is given replaces the previous one, which is then lost.

Use when: renaming an integration's entry or changing its entity-discovery/polling preferences without going through its options flow. Not for: settings specific to the integration itself (its actual options schema) — use integrations_start_options_flow. Returns: the config_entries/update result. Errors: raises RuntimeError if the underlying WebSocket call fails (e.g. entry_id unknown).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoNew display title for the entry. Omit to leave the current title unchanged.
entry_idYesConfig entry ID to update, from `system_list_integrations` or `system_get_all_integrations`.
pref_disable_pollingNoWhether HA should skip polling for this integration's entities. Omit to leave the current preference unchanged.
pref_disable_new_entitiesNoWhether newly discovered entities from this integration should start disabled. Omit to leave the current preference unchanged.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.25.1
    • addedInput schema / properties / entry_id / description
      Added value: +"Config entry ID to update, from `system_list_integrations` or `system_get_all_integrations`."
    • addedInput schema / properties / pref_disable_new_entities / description
      Added value: +"Whether newly discovered entities from this integration should start disabled. Omit to leave the current preference unchanged."
    • addedInput schema / properties / pref_disable_polling / description
      Added value: +"Whether HA should skip polling for this integration's entities. Omit to leave the current preference unchanged."
    • addedInput schema / properties / title / description
      Added value: +"New display title for the entry. Omit to leave the current title unchanged."
  2. Addedv0.4.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds real value beyond them: partial-update semantics (omitted fields keep prior values; given fields overwrite and lose the previous one) and the error contract (RuntimeError on unknown entry_id). This is exactly the mutation risk detail an agent needs.

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 core action, then cleanly sectioned into Use when / Not for / Returns / Errors. Every sentence carries distinct information; the 'which is then lost' clause is functional, not filler.

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 destructive single-entry mutation, the description covers purpose, alternatives, partial-update semantics, error behavior, and return, while annotations carry the safety profile and an output schema exists. 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 coverage is 100%, so baseline is 3, but the description adds meaning beyond per-parameter docs by clarifying the wholesale-replacement behavior of supplied fields versus omitted ones. It does not add syntax/format specifics, so it stops short of 5.

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 ('Update selected properties of an existing config entry') and explicitly distinguishes itself from the sibling options-flow path. An agent can identify what this does and what it does not do without opening the 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 explicit 'Use when' (renaming an entry, changing entity-discovery/polling prefs) and 'Not for' (integration-specific options schema) guidance, naming `integrations_start_options_flow` as the alternative. 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