Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official

List Groups

ha_config_list_groups
Read-onlyIdempotent

List Home Assistant entity groups and their member entities to review group names, states, icons, and membership. Supports pagination for large group sets.

Instructions

List Home Assistant entity groups with their member entities.

Returns one page of old-style groups created via the group.set service or YAML configuration (platform-specific groups such as light or cover groups are separate entities); total_count and has_more report the full set. Each group includes its entity_id, friendly name, state, member entities, icon and all mode.

EXAMPLE: ha_config_list_groups(offset=100)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax groups to return per page
offsetNoNumber of groups to skip for pagination

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 / limit / description
      Previous value: -"Max groups to return per page (default: 100)"New value: +"Max groups to return per page"
    • changedInput schema / properties / offset / description
      Previous value: -"Number of groups to skip for pagination (default: 0)"New value: +"Number of groups to skip for pagination"
  2. First observedv7.14.2

TDQS

A3.7/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 the safety profile is covered. The description adds real behavioral context beyond that: pagination semantics (one page returned, total_count and has_more report the full set) and the exact scope of what is returned versus platform-specific groups.

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-loaded with the purpose, then scope, field contents, and a concrete example in roughly four compact sentences. The field enumeration (entity_id, name, state, members, icon, all mode) is slightly list-heavy but still earns its place by telling the agent what a group record looks like.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the return-value detail is somewhat redundant, but the pagination framing (total_count/has_more) and the old-style-group scope are the key things an agent needs to call and interpret this correctly. Nothing essential is missing for a read-only paginated list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so limit and offset are already documented in the schema and the baseline is 3. The trailing EXAMPLE demonstrates offset in use, which is mildly reinforcing, but adds no format or constraint detail the schema does not already carry.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb+resource (list Home Assistant entity groups with member entities) and sharpens the scope by excluding platform-specific groups like light or cover groups, which are separate entities. It does not name a specific sibling tool (e.g. ha_config_list_helpers or ha_get_entity) as an alternative, so it falls just short of full sibling differentiation.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the note that only old-style groups from group.set/YAML are returned tells the agent the result set is narrower than all group-like entities, and the example hints at pagination. There is no explicit when-to-use, when-not, or named alternative tool, leaving the agent to infer routing.

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