Skip to content

Commit bcaf590

Browse files
julienldclaude
andauthored
docs(tools): recommend description field for automations (#111)
Add guidance to ha_config_set_automation tool documentation suggesting users fill the description field with their intent. This allows safe modification of automation implementation later without risk of losing the original purpose. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 1d7aecb commit bcaf590

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

src/ha_mcp/tools/tools_config_automations.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ async def ha_config_set_automation(
108108
- action: List of actions to execute
109109
110110
OPTIONAL CONFIG FIELDS:
111-
- description: Detailed description
111+
- description: Detailed description of the user's intent (RECOMMENDED: helps safely modify implementation later)
112112
- condition: Additional conditions that must be met
113113
- mode: 'single' (default), 'restart', 'queued', 'parallel'
114114
- max: Maximum concurrent executions (for queued/parallel modes)
@@ -120,6 +120,7 @@ async def ha_config_set_automation(
120120
Simple time-based automation:
121121
ha_config_set_automation({
122122
"alias": "Morning Lights",
123+
"description": "Turn on bedroom lights at 7 AM to help wake up",
123124
"trigger": [{"platform": "time", "at": "07:00:00"}],
124125
"action": [{"service": "light.turn_on", "target": {"area_id": "bedroom"}}]
125126
})

0 commit comments

Comments
 (0)