Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Get Entity Exposure

ha_get_entity_exposure
Read-onlyIdempotent

Check if a Home Assistant entity is exposed to voice assistants like Alexa, Google Assistant or Assist, or list all entities with custom exposure settings.

Instructions

Get entity exposure settings - list all or get settings for a specific entity.

Without an entity_id: lists the entities that have explicit exposure settings for voice assistants (Alexa, Google Assistant, Assist) as exposed_entities, plus a per-assistant summary count. An entity absent from that list uses the default exposure settings.

With an entity_id: returns exposed_to (assistant -> True/False from the entity's explicit settings), is_exposed_anywhere, and has_custom_settings. When has_custom_settings is False the defaults apply and exposed_to is all False; the default values themselves are not computed.

EXAMPLES:

  • Filter by assistant: ha_get_entity_exposure(assistant="cloud.alexa")

  • Get specific entity: ha_get_entity_exposure(entity_id="light.living_room")

When the ha_mcp_tools component advertises the exposure capability, each record is additively enriched with the entity's name/area so no second ha_search is needed to identify it: friendly_name, domain, area, floor, and labels (plus state for entities that have one) on a single-entity lookup, and a parallel entity_info map keyed by entity_id when listing. These fields are absent when the component is unavailable.

Input Schema

NameRequiredDescriptionDefault
assistantNoFilter by assistant: 'conversation', 'cloud.alexa', or 'cloud.google_assistant'.
entity_idNoEntity ID to check exposure settings for.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv8.6.0
    • changedInput schema / properties / assistant / description
      Previous value: -"Filter by assistant: 'conversation', 'cloud.alexa', or 'cloud.google_assistant'. If not specified, returns all."New value: +"Filter by assistant: 'conversation', 'cloud.alexa', or 'cloud.google_assistant'."
    • changedInput schema / properties / entity_id / description
      Previous value: -"Entity ID to check exposure settings for. If omitted, lists all entities with exposure settings."New value: +"Entity ID to check exposure settings for."
  2. First observedv7.14.2

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare this a safe, idempotent read, and the description adds genuinely non-obvious semantics on top: an absent entity means defaults apply, has_custom_settings=False implies exposed_to is all False, and default values are deliberately not computed. It also discloses the conditional enrichment behavior tied to the ha_mcp_tools component advertising the exposure capability.

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 core list-vs-single distinction, then examples, then the enrichment caveat, so an agent gets the essentials in the first sentence. It is verbose in places (a full paragraph on enrichment fields) but each section carries distinct information.

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?

Given an output schema already documents the return structure, the description still explains the semantics of the returned fields (exposed_to, is_exposed_anywhere, has_custom_settings) and the list-mode summary/entity_info shape. Nothing needed to invoke or interpret the tool 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 the baseline is 3; the description goes beyond it by explaining that entity_id acts as a mode switch that changes the entire return shape, and by enumerating the assistant filter values. It adds useful meaning without documenting syntax the schema already covers.

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 exposure settings) and immediately splits the behavior into two distinct modes keyed on the entity_id parameter. An agent can tell exactly what it returns in each case 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly describes when to call it without entity_id (list all entities with explicit settings) versus with entity_id (inspect a single entity), and notes that a second ha_search is unnecessary when the capability is advertised. It does not name sibling alternatives like ha_get_entity or ha_set_entity for comparison, so it stops short of full 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