Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official

List Helpers

ha_config_list_helpers
Read-onlyIdempotent

List Home Assistant helpers by type, returning configurations with IDs, entity IDs, names, icons, and type-specific settings. Supports pagination and all helper types.

Instructions

List Home Assistant helpers of a specific type with their configurations.

Returns one page of helpers; total_count and has_more report the full set. Each record carries the complete configuration for its helper, including:

  • id (immutable storage key), entity_id (current — address the helper by this, where available), name (current display name), original_name (creation-time name), icon

  • Type-specific settings (min/max for input_number, options for input_select, etc.)

  • Area and label assignments

For a helper renamed in the UI, id/original_name keep the storage values while entity_id/name reflect the current entity registry (entity_id is the identifier ha_config_set_helper resolves against, so prefer it over id for a renamed helper). entity_id/original_name are present only for storage-collection helpers matched in the entity registry — types with no backing entity (e.g. tag), and every record when the registry read degrades, carry only id/name (a warning flags the degraded case).

SUPPORTED HELPER TYPES:

  • input_button: Virtual buttons for triggering automations

  • input_boolean: Toggle switches/checkboxes

  • input_select: Dropdown selection lists

  • input_number: Numeric sliders/input boxes

  • input_text: Text input fields

  • input_datetime: Date/time pickers

  • counter: Counters with increment/decrement/reset

  • timer: Countdown timers with start/pause/cancel

  • schedule: Weekly schedules with time ranges (on/off per day)

  • zone: Geographical zones for presence detection

  • person: Person entities linked to device trackers

  • tag: NFC/QR tags for automation triggers

EXAMPLES:

  • List all number helpers: ha_config_list_helpers("input_number")

  • List all counters: ha_config_list_helpers("counter")

  • List all zones: ha_config_list_helpers("zone")

  • List all persons: ha_config_list_helpers("person")

  • List all tags: ha_config_list_helpers("tag")

  • List every helper type at once: ha_config_list_helpers("all")

  • Next page: ha_config_list_helpers("input_boolean", offset=100)

NOTE: Storage types list what HA's {type}/list command returns: the storage-backed helpers (created via UI/API), not the YAML-defined ones. person is the exception — HA lists its YAML-configured persons alongside the storage ones, so both appear here.

Flow-based types (template / group / utility_meter / derivative / etc.) require the ha_mcp_tools custom component (>= 1.1.0) and are served only through it; storage types are listed on all installs. Requesting a flow type without the component returns a COMPONENT_NOT_INSTALLED error.

Pass helper_type="all" to enumerate every helper type in a single call. Each record carries its own helper_type. This mode is component-only (there is no single built-in command that lists all types): without the ha_mcp_tools component it returns a COMPONENT_NOT_INSTALLED error rather than a partial or empty list.

For detailed helper documentation, use ha_get_skill_guide.

list all helpers input_boolean input_number input_text counter timer input_datetime input_select

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax helpers to return per page (default: 100)
offsetNoNumber of helpers to skip for pagination (default: 0)
helper_typeYesHelper type to list. Storage types are listed on all installs; flow-based types require the ha_mcp_tools custom component. Pass 'all' to list every helper type in one call (also requires the ha_mcp_tools component).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

The description discloses behavioral traits beyond annotations: pagination behavior, that it lists storage-backed helpers (except person), flow-type requirement for custom component, and the degraded case when entity registry read fails. No contradiction with annotations (readOnlyHint, idempotentHint).

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 well-structured with clear sections and front-loaded with the main purpose. However, it is quite lengthy and contains some redundancy (e.g., repeating component requirement for 'all' mode). Still, the thoroughness is justified by the tool's complexity.

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 complexity (many helper types, pagination, storage vs flow, component dependency), the description is highly complete. It covers return values (including fields like id, entity_id, name), pagination, error cases, and cross-references. The output schema exists, so no need to detail return format further.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the description adds significant meaning: explains the difference between id and entity_id for renamed helpers, the meaning of offset/limit, and the component requirement for flow-based types and 'all' mode. The examples show concrete usage.

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 clearly states the tool lists Home Assistant helpers of a specific type with their configurations. It distinguishes itself from sibling tools by focusing on helpers, listing supported types, and providing examples.

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?

The description provides extensive usage guidelines: when to use (list helpers), differentiation between storage and flow-based types, component requirements, pagination, and references to related tools like ha_config_set_helper. It explicitly states when not to use (e.g., for flow types without the component) and gives examples for each helper type and 'all' mode.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/homeassistant-ai/ha-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server