Skip to main content
Glama

List devices in area

devices_list_devices_in_area
Read-onlyIdempotent

Retrieve all devices assigned to a specific area by filtering the device registry by area ID. Use when you need only devices in one area rather than the whole registry.

Instructions

List devices currently assigned to one area.

Calls WS config/device_registry/list and filters the slimmed device list (see devices_list_devices) down to entries whose area_id matches.

Use when: you need only the devices in one area rather than the whole registry. Not for: the whole device registry — use devices_list_devices or areas_list_devices; fuzzy name-based search — use search_search_devices. Returns: list of slimmed device dicts (see devices_list_devices) whose area_id equals the given area_id. Limits: devices without an area are never returned here.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
area_idYesArea registry ID to filter by; obtain it from areas_list_areas.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / area_id / description
      Added value: +"Area registry ID to filter by; obtain it from areas_list_areas."
  2. First observedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already establish the safe read-only, idempotent profile, so the bar is lower. The description still adds real behavioral context: the underlying WS call (config/device_registry/list), the client-side filtering step, and the important limit that devices with no assigned area are never returned.

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 purpose followed by clearly labelled When/Not for/Returns/Limits blocks. Slightly redundant: the Returns line largely repeats the opening sentence's filtering rule, and the return value is already covered by the output schema.

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?

For a single-parameter read tool with a full output schema, the description covers implementation source, selection guidance, return shape pointer, and the key edge case (area-less devices excluded). 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.

Parameters3/5

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

Schema description coverage is 100% and the single parameter already documents that the area ID comes from areas_list_areas. The description only restates that filtering is an exact match on area_id, adding little beyond the schema, so baseline 3 applies.

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 with scope: 'List devices currently assigned to one area.' It also names the sibling it is not (devices_list_devices, areas_list_devices, search_search_devices), so an agent can disambiguate 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 Guidelines5/5

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

Explicit 'Use when' clause plus a 'Not for' clause that routes each excluded case to a named alternative tool. Nothing about tool selection 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