Skip to main content
Glama

List devices

unifi_list_devices
Read-only

List UniFi gateways, switches, and access points with state, model, firmware, IP, uptime, CPU/memory load, and client counts; filter by device type or state.

Instructions

List the site's UniFi devices (gateways, switches, access points...) with state, model, firmware, IP, uptime, CPU and memory load and client counts; filter by type or state. For one device's ports, radios and uplink use unifi_get_device.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "unifi_list_devices"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full controller objects (large)
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
typeNoOnly devices of this type
limitNoMaximum items to return (default 500)
stateNoOnly this state: connected, disconnected, upgrading...
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • changedInput schema / properties / limit / description
      Previous value: -"Default 500"New value: +"Maximum items to return (default 500)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds value beyond them by enumerating the returned attributes (state, model, firmware, IP, uptime, CPU/memory load, client counts), which substitutes for the absent output schema. It does not flag the cost of the `raw` large-payload option or any pagination behavior, so it is not 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?

A single front-loaded sentence whose clauses (scope, returned fields, filtering, alternative tool) each earn their place. No redundant restatement of the title or name.

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?

With no output schema, the description usefully compensates by listing what each device record contains, and it routes detail lookups to unifi_get_device. Minor gaps remain around the large `raw` mode and result-size expectations, but 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 description coverage is 100%, so all seven parameters are already documented with defaults, bounds and enum. The description only restates the type/state filtering that the schema already explains, adding no syntax or interaction detail (e.g. how search combines with type/state, or when to prefer `fields` over `raw`). 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?

Specific verb and resource ("List the site's UniFi devices") plus an enumeration of the returned fields and filtering capability. It explicitly contrasts itself with unifi_get_device, so an agent can distinguish the two 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 Guidelines5/5

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

States the filtering use case ("filter by type or state") and names the alternative plus the exact condition that selects it: use unifi_get_device for one device's ports, radios and uplink. 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.