Skip to main content
Glama

getAllDeviceBySite

Read-only

Retrieve full device inventory for a site, including offline and disconnected hardware, to audit registered equipment and verify deployments.

Instructions

Get all devices in a site including offline and disconnected devices. Unlike listDevices which may filter to active-only, this returns the full device inventory. Useful for auditing what hardware is registered to a site.

Input Schema

NameRequiredDescriptionDefault
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered by structured data. The description adds real behavioral value by stating that results include offline and disconnected devices (i.e., no active-state filtering). It says nothing about pagination, result size, or ordering, which are the remaining behavioral unknowns for a full-inventory listing.

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?

Three short sentences, front-loaded with the scope, then the sibling differentiation, then the use case. The second sentence ('returns the full device inventory') partly restates the offline/disconnected clause, a minor redundancy that keeps it from a 5.

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?

For a single-parameter, optional-argument read tool with annotations covering safety, the description covers what is listed, its scope, and when to prefer it. With no output schema, a brief note on return shape or volume would have closed the last gap.

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 siteId property already documents the default-from-config behavior and the listSites discovery path. The description adds no parameter-level meaning beyond that, 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?

The description uses a specific verb and resource ('Get all devices in a site') and immediately bounds the scope with 'including offline and disconnected devices'. It explicitly distinguishes itself from a named sibling, listDevices, so an agent can pick between them without opening either 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?

It names the alternative (listDevices) and the condition that separates them ('may filter to active-only'), plus a concrete use case ('auditing what hardware is registered to a site'). The routing cue is hedged with 'may', so the exclusion is slightly softer than an explicit when-not statement.

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