Skip to main content
Glama

List connected clients

unifi_list_clients
Read-only

List currently connected UniFi clients with IP, network, AP or switch port, signal, rates, usage, and uptime; filter by wired/wireless, guests, network, or access point.

Instructions

List the clients connected now, with IP, network, AP or switch port, signal, rates, usage and uptime; filter by connection type, guests, network or AP. For offline clients and stored settings (alias, fixed IP, blocked) use unifi_list_known_clients. For connection history use unifi_list_client_sessions.

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_clients"
  }
}

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.
limitNoMaximum items to return (default 200)
ap_macNoOnly clients of this access point
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar
networkNoOnly clients on this network (name)
connectionNoFilter by connection type (default all)
guests_onlyNoOnly guest clients

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 200"New value: +"Maximum items to return (default 200)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4.5/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 the key behavioral scoping fact that results are limited to currently connected clients and lists the returned fields. It omits pagination/truncation behavior and any permission requirements, a minor gap given the annotations already carry the read-only signal.

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?

Two dense sentences: the first front-loads what the tool returns and its filter axes, the second handles disambiguation. No filler, no repetition of the title.

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?

With nine optional parameters and no output schema, the description compensates by enumerating the returned fields and bounding the result set to live connections. Combined with fully documented schema params, an agent has everything needed to select and call it correctly.

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 every one of the nine parameters is already documented in the schema. The description restates the filter dimensions (connection type, guests, network, AP) without adding syntax, format, or interaction detail beyond that, 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 ('List the clients connected now') and enumerates the returned attributes (IP, network, AP or switch port, signal, rates, usage, uptime), so the agent knows exactly what it gets. It also names the two sibling tools it is not, making it distinguishable 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?

Explicitly routes: offline clients and stored settings to unifi_list_known_clients, connection history to unifi_list_client_sessions. Both the when-to-use and the when-not-to-use cases are covered with named alternatives, leaving nothing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.