Skip to content

Commit 085bd8a

Browse files
chore(internal): sync tool docs after merge [skip ci]
1 parent ac7628a commit 085bd8a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

site/src/data/tools.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1422,18 +1422,18 @@
14221422
{
14231423
"name": "ha_config_set_helper",
14241424
"title": "Create or Update Helper",
1425-
"description": "Create or update Home Assistant helper entities (27 types, unified interface).\n\nCreates new helper if helper_id is omitted, updates existing if helper_id is provided.\n\nSIMPLE types (structured params, WebSocket API): input_boolean, input_button,\ninput_select, input_number, input_text, input_datetime, counter, timer, schedule,\nzone, person, tag.\n\nFLOW types (pass `config` dict, Config Entry Flow API): template, group,\nutility_meter, derivative, min_max, threshold, integration, statistics, trend,\nrandom, filter, tod, generic_thermostat, switch_as_x, generic_hygrostat.\nNote: `tod` is the purpose-built \"is-current-time-in-range\" indicator\n(supports cross-midnight ranges, unlike `schedule`).\n\nFor flow-type updates, pass the existing entry_id as `helper_id`. Options flows\nreject the `name` key on update — to rename a flow helper, delete and recreate.\n\nEXAMPLES (menu-based types + tod, where first-call payload is non-obvious):\n- template sensor:\n ha_config_set_helper(helper_type=\"template\", name=\"Room Temp\",\n config={\"next_step_id\": \"sensor\",\n \"state\": \"{{ states('sensor.x')|float }}\",\n \"unit_of_measurement\": \"°C\"})\n- group (light):\n ha_config_set_helper(helper_type=\"group\", name=\"Kitchen Lights\",\n config={\"group_type\": \"light\",\n \"entities\": [\"light.a\", \"light.b\"]})\n- tod (time-of-day indicator, cross-midnight OK):\n ha_config_set_helper(helper_type=\"tod\", name=\"Quiet Hours\",\n config={\"after_time\": \"22:00:00\", \"before_time\": \"07:00:00\"})\n\nFor complex schemas and per-type parameter details, use ha_get_helper_schema.",
1425+
"description": "Create or update Home Assistant helper entities (27 types, unified interface).\n\nCreate requires `name`; update requires `helper_id`.\n\nSIMPLE types (structured params, WebSocket API): input_boolean, input_button,\ninput_select, input_number, input_text, input_datetime, counter, timer, schedule,\nzone, person, tag.\n\nFLOW types (pass `config` dict, Config Entry Flow API): template, group,\nutility_meter, derivative, min_max, threshold, integration, statistics, trend,\nrandom, filter, tod, generic_thermostat, switch_as_x, generic_hygrostat.\nNote: `tod` is the purpose-built \"is-current-time-in-range\" indicator\n(supports cross-midnight ranges, unlike `schedule`).\n\nFor flow-type updates, pass the existing entry_id as `helper_id`. Options flows\nreject the `name` key on update — to rename a flow helper, delete and recreate.\n\nEXAMPLES (menu-based types + tod, where first-call payload is non-obvious):\n- template sensor:\n ha_config_set_helper(helper_type=\"template\", name=\"Room Temp\",\n config={\"next_step_id\": \"sensor\",\n \"state\": \"{{ states('sensor.x')|float }}\",\n \"unit_of_measurement\": \"°C\"})\n- group (light):\n ha_config_set_helper(helper_type=\"group\", name=\"Kitchen Lights\",\n config={\"group_type\": \"light\",\n \"entities\": [\"light.a\", \"light.b\"]})\n- tod (time-of-day indicator, cross-midnight OK):\n ha_config_set_helper(helper_type=\"tod\", name=\"Quiet Hours\",\n config={\"after_time\": \"22:00:00\", \"before_time\": \"07:00:00\"})\n\nFor complex schemas and per-type parameter details, use ha_get_helper_schema.",
14261426
"inputSchema": {
14271427
"properties": {
14281428
"helper_type": {
14291429
"type": "Annotated[Literal['counter', 'derivative', 'filter', 'generic_hygrostat', 'generic_thermostat', 'group', 'input_boolean', 'input_button', 'input_datetime', 'input_number', 'input_select', 'input_text', 'integration', 'min_max', 'person', 'random', 'schedule', 'statistics', 'switch_as_x', 'tag', 'template', 'threshold', 'timer', 'tod', 'trend', 'utility_meter', 'zone'], Field(description='Type of helper entity to create or update')]"
14301430
},
14311431
"name": {
1432-
"type": "Annotated[str | None, Field(description=\"Display name for the helper. Required on create; optional on update (pass helper_id to skip). For flow-based helper types on update (template, group, utility_meter, ...), this is typically ignored — options flows don't expose renaming. Rename a flow helper by deleting and recreating instead.\", default=None)]",
1432+
"type": "Annotated[str | None, Field(description=\"REQUIRED when creating (no helper_id provided). Display name for the helper. Optional on update pass helper_id instead. For flow-based helper types on update (template, group, utility_meter, ...), this is typically ignored — options flows don't expose renaming. Rename a flow helper by deleting and recreating instead.\", default=None)]",
14331433
"default": null
14341434
},
14351435
"helper_id": {
1436-
"type": "Annotated[str | None, Field(description=\"Helper ID for updates (e.g., 'my_button' or 'input_button.my_button'). If not provided, creates a new helper.\", default=None)]",
1436+
"type": "Annotated[str | None, Field(description=\"REQUIRED when updating an existing helper. Bare ID ('my_button') or full entity ID ('input_button.my_button'). Omit to create a new helper.\", default=None)]",
14371437
"default": null
14381438
},
14391439
"icon": {

0 commit comments

Comments
 (0)