List Helpers
ha_config_list_helpersLists Home Assistant helpers by type with their configurations and pagination, helping you inspect existing helpers or learn config fields before creating or updating one.
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 configuration for its helper:
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, and area and label
assignments. A flow helper record carries entry_id and options instead of
id; a custom helper integration's options are withheld, marked
options_withheld.
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).
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.
Listing flow types requires the ha_mcp_tools custom component (>= 1.1.0); without it, such a listing returns a COMPONENT_NOT_INSTALLED error.
With helper_type="all", 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.
describe=True returns each field's name, type, required flag, options, default and (with helper_id) current value, or the menu_options a menu-based helper needs a menu_choice from. Call it before ha_config_set_helper to learn the config keys for a type.
EXAMPLES:
List all counters: ha_config_list_helpers("counter")
List every helper type at once: ha_config_list_helpers("all")
Next page: ha_config_list_helpers("input_boolean", offset=100)
Fields for a template sensor: ha_config_list_helpers("template", describe=True, menu_choice="sensor")
For detailed helper documentation, use ha_get_skill_guide.
list all helpers input_boolean input_number input_text counter timer input_datetime input_select
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"helper_type": "<helper_type>"
},
"name": "ha_config_list_helpers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max helpers to return per page | |
| offset | No | Number of helpers to skip for pagination | |
| describe | No | Instead of listing, return the fields ha_config_set_helper accepts in config for helper_type, as Home Assistant reports them (the form the HA UI shows). | |
| helper_id | No | describe only: an existing helper (config entry id for flow helpers, entity_id or id otherwise); each field then carries its current value. | |
| helper_type | Yes | Helper type to list: a storage type (input_boolean, counter, timer, ...), a helper flow Home Assistant lists (template, group, utility_meter, ...), or 'all' for every type in one call. | |
| menu_choice | No | describe only: sub-type of a menu-based helper (template, group), e.g. 'sensor'. A choice that finishes the flow saves the helper: flow_type create_entry. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||