Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Get Todo

ha_get_todo
Read-onlyIdempotent

Retrieve all Home Assistant todo lists or get items from a specific list, with optional filtering by completion status.

Instructions

Get todo lists or items - list all todo lists or get items from a specific list.

Without an entity_id: lists every entity in the 'todo' domain (shopping lists and other todo-type integrations) with entity_id, friendly_name and state (number of incomplete items or current status).

With an entity_id: returns that list's items — uid, summary, status (needs_action or completed), description, and due date where supported — optionally filtered by status (None returns all).

EXAMPLES:

  • List all todo lists: ha_get_todo()

  • Get incomplete items: ha_get_todo("todo.shopping_list", status="needs_action")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNoFilter items by status: 'needs_action' for incomplete, 'completed' for done. Only applies when entity_id is provided.
entity_idNoTodo list entity ID (e.g., 'todo.shopping_list').

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv8.6.0
    • changedInput schema / properties / entity_id / description
      Previous value: -"Todo list entity ID (e.g., 'todo.shopping_list'). If omitted, lists all todo list entities."New value: +"Todo list entity ID (e.g., 'todo.shopping_list')."
  2. First observedv7.14.2

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description goes beyond them by disclosing what is actually returned in each mode (entity_id/friendly_name/state; uid/summary/status/description/due date 'where supported') and the status filter's interaction with entity_id, which is genuine added context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the tool's purpose, then the two modes in parallel structure, then two compact examples. Every sentence carries information; nothing is restated from the title or annotations.

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?

Although an output schema exists (so return values need not be described), the description nonetheless covers both branches of behavior, the meaning of the optional filter, and the returned fields, leaving no ambiguity about how to invoke the tool in either mode.

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 still adds value by explaining the two parameters as a coupled switch (entity_id selects the mode, status only filters items and 'None returns all') and by showing the pairing in the examples. It does not add format or syntax detail beyond that.

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 and resource ('get todo lists or items') and immediately splits the two operating modes: domain-wide listing without entity_id vs. item retrieval with entity_id. An agent can distinguish this read tool from the mutation siblings ha_set_todo_item and ha_remove_todo_item without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly defines when each mode applies ('Without an entity_id... With an entity_id...') and the worked examples show concrete call shapes. It stops short of naming alternatives or exclusions (e.g., pointing at ha_set_todo_item for modifications), so it is clear context rather than full routing guidance.

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