Skip to main content
Glama

List devices (slim fields)

devices_list_devices
Read-onlyIdempotent

Lists all Home Assistant devices with slimmed fields—id, name, area, manufacturer, model—so you can inspect the registry without raw data.

Instructions

List all devices with a slimmed set of common fields.

Calls WS config/device_registry/list and projects each entry down to id, name_by_user, name, area_id, manufacturer, model, entry_type, plus config_entries and disabled_by when present.

Use when: you need the device registry without every raw field. Not for: the full unfiltered registry — use areas_list_devices; devices scoped to one area — use devices_list_devices_in_area; fuzzy name-based search — use search_search_devices. Returns: list of slimmed device dicts as described above.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds real value beyond that by disclosing the underlying WS call (`config/device_registry/list`) and the projection behavior, including which fields are conditionally present (config_entries, disabled_by when present). It omits pagination/size behavior, which keeps it below a 5.

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-loads the core purpose, then the field projection, then routing guidance, then returns. Every sentence earns its place and the structure maps cleanly onto how an agent reads a 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?

An output schema exists, so return values need no elaboration beyond the field list given. For a zero-parameter read tool with annotations and an output schema, nothing an agent needs to call it correctly is missing.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate; the baseline of 4 applies. No parameter guidance is required or expected here.

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 ("List all devices") and immediately scopes it ("slimmed set of common fields"). It enumerates the projected fields and explicitly distinguishes itself from the three closest siblings by name, so an agent can select it 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?

Provides an explicit "Use when" condition and a "Not for" list naming three alternatives (`areas_list_devices`, `devices_list_devices_in_area`, `search_search_devices`) with the condition that routes to each. Nothing is left to inference.

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