Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official

Get Entity Exposure

ha_get_entity_exposure
Read-onlyIdempotent

Check which Home Assistant entities are exposed to voice assistants like Alexa, Google Assistant, or Assist, or retrieve exposure settings for a specific entity.

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

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

Output Schema

TableJSON 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?

With annotations already covering read-only, idempotent, and closed-world behavior, the description adds substantial operational detail: what the list output contains, how defaults apply to absent entities, what fields a single-entity lookup returns, and what happens when has_custom_settings is False. It also discloses conditional enrichment with entity name/area fields when the ha_mcp_tools component advertises the capability, which is valuable beyond structured annotations.

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?

The description is front-loaded with the core purpose and mode distinction, then uses examples and a conditional enrichment note. Every sentence carries useful information, though the final paragraph about ha_mcp_tools enrichment is somewhat verbose and could be slightly tighter without losing meaning.

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 the tool's moderate complexity, the presence of an output schema, and full annotation coverage, the description is complete: it explains both operational modes, return semantics, default behavior, and conditional enrichment. An agent has everything needed to invoke the tool correctly without consulting other documentation.

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, but the description adds meaningful semantics: it explains that omitting entity_id changes the tool from a single-entity lookup to a list operation, and it illustrates the assistant filter with a concrete example. This goes beyond the schema's brief parameter descriptions and clarifies the behavioral impact of each optional parameter.

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?

The description states a specific verb and resource ('Get entity exposure settings') and clearly distinguishes the two operational modes: listing all entities with explicit exposure settings versus retrieving settings for a specific entity. An agent can tell this apart from siblings like ha_get_entity or ha_search based on the focus on exposure configuration.

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?

The description gives clear context for when to omit entity_id to list exposed entities and when to include it to inspect a specific entity, reinforced by two examples. However, it does not explicitly state when to prefer this tool over alternatives such as ha_get_entity or ha_set_entity, leaving some routing inference to the agent.

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