Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Set Todo Item

ha_set_todo_item
Destructive

Create or update a Home Assistant todo item to add tasks, mark them completed, rename items, or set status, description, and due dates.

Instructions

Create or update a todo item in Home Assistant.

Without item (create mode): creates a new item; summary is required. With item (update mode): updates that item; at least one of rename, status, description, due_date or due_datetime is required.

EXAMPLES:

  • Add item: ha_set_todo_item("todo.tasks", summary="Pay bills", due_date="2024-12-31")

  • Complete item: ha_set_todo_item("todo.shopping_list", item="Buy milk", status="completed")

  • Rename item: ha_set_todo_item("todo.tasks", item="Old task", rename="New task name")

Not all todo integrations support all features: the Shopping List integration supports summary and status but not descriptions or due dates.

If a Claude Desktop user gets a 4-minute timeout with no result on this call, read the target back before repeating it, and tell them to wait a few seconds before clicking the manual-approve button, as clicking it too quickly is known to cause hangs in Claude Desktop. This workaround is specific to Claude Desktop.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemNoExisting item to update - can be the item UID or the exact item summary/name.
renameNoNew name/summary for an existing item. Only used in update mode.
statusNoItem status: 'completed' to mark done, 'needs_action' to mark incomplete. Only used in update mode.
summaryNoItem text/name. Ignored in update mode — use 'rename' to change the item name.
due_dateNoDue date in YYYY-MM-DD format (e.g., '2024-12-25')
entity_idYesTodo list entity ID (e.g., 'todo.shopping_list')
descriptionNoDetailed description for the item
due_datetimeNoDue datetime in ISO format (e.g., '2024-12-25T14:00:00'). Overrides due_date if both provided.

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 / item / description
      Previous value: -"Existing item to update - can be the item UID or the exact item summary/name. When provided, operates in update mode. When omitted, creates a new item."New value: +"Existing item to update - can be the item UID or the exact item summary/name."
    • changedInput schema / properties / summary / description
      Previous value: -"Item text/name. Required when creating a new item. Ignored in update mode — use 'rename' to change the item name."New value: +"Item text/name. Ignored in update mode — use 'rename' to change the item name."
  2. First observedv7.14.2

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=false, so the mutation profile is covered. The description adds value beyond that with mode semantics, integration-dependent feature support, and a concrete Claude Desktop timeout/hang workaround — though it never explains why the tool is flagged destructive or whether updates are reversible.

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?

Front-loads the mode distinction, then examples, then integration caveats, then the Desktop workaround — a sensible priority order. Slightly penalized because the final Claude Desktop timeout paragraph is long and environment-specific, diluting an otherwise tight definition.

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?

With an output schema present, return values need no explanation. For an 8-parameter mutation tool with 100% schema coverage, the description supplies the remaining decision-relevant context: mode selection, per-mode requirements, integration limitations, and worked examples.

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 description coverage is 100%, so the baseline is 3. The description exceeds that by documenting cross-parameter constraints the schema cannot express: summary is required in create mode and ignored in update mode, and update mode needs at least one of five specific fields. The worked examples further anchor argument 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?

States a specific verb+resource ('Create or update a todo item in Home Assistant') and immediately splits the operation into two named modes (create vs update), which lets an agent distinguish it from siblings like ha_get_todo and ha_remove_todo_item without opening a schema.

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?

Explicitly states the trigger condition for each mode: without `item` it creates (summary required), with `item` it updates (one of rename/status/description/due_date/due_datetime required). It also adds a real exclusion — the Shopping List integration does not support descriptions or due dates — so the agent knows when a feature will silently not apply.

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