Skip to main content
Glama

List entities with label

labels_list_entities_with_label
Read-onlyIdempotent

List all entities assigned a specific label to find everything tagged with that label, useful before bulk actions. Requires a label ID from the label registry.

Instructions

List entities that currently have a given label assigned.

Reads the entity registry over WebSocket and keeps rows whose labels list contains label_id.

Use when: finding everything tagged with one label, e.g. before a bulk action. Returns: list of entity registry dicts that have the label. Errors: on a WS failure, returns [{"error": "<message>"}] instead of raising.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
label_idYesLabel registry ID to filter by; obtain it from labels_list_labels.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds real value: it discloses the WebSocket read path, the row-filtering logic, the return shape (entity registry dicts), and notably that WS failures return an error object rather than raising. That error contract is the kind of detail annotations cannot convey.

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 summary sentence followed by tight Use when / Returns / Errors blocks. Every line carries information and there is no padding.

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 one-parameter read tool with full annotation coverage and an output schema, the description covers purpose, trigger, mechanism, and failure mode. Nothing an agent needs to invoke 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 coverage is 100% and the single label_id parameter is already documented in-schema, including its source (labels_list_labels). The description only restates that rows are filtered by label_id, adding no new syntax or format detail, so the 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 ('List entities that currently have a given label assigned') and distinguishes itself from sibling label tools such as labels_list_labels and labels_list_devices_with_label by naming the entity registry as the target.

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?

'Use when: finding everything tagged with one label, e.g. before a bulk action' gives a clear positive trigger. It does not name the closest alternative (labels_list_devices_with_label) or state when not to use it, so it stops short of 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