UniFi Network MCP Server

Overview Schema Source Related Servers Discussions Admin

unifi_list_clients

Read-only

Retrieve a list of clients currently connected at a UniFi site, showing device type, MAC/IP, and uplink. Resolve who is online now by filtering and limiting results.

Instructions

List currently connected clients at a site. Returns per client: id, name, type (WIRED/WIRELESS/VPN/TELEPORT), macAddress, ipAddress (frequently absent — do not rely on it being present), connectedAt, uplinkDeviceId (the switch/AP they're attached to), access.type. NOTE: verified against 10.6.106 — the Integration API client schema is minimal and identical across types; it does NOT expose signal strength, channel, or per-port binding. Use for: who's online right now. Disconnected/historical clients are NOT in the Integration API; use unifi_list_client_history and unifi_list_client_sessions for controller-retained records.

Input Schema

TableJSON Schema

Name	Required	Description
`limit`	No	Number of records to return (default: 25, max: 200)
`filter`	No	Filter expression
`offset`	No	Number of records to skip (default: 0)
`siteId`	Yes	Site ID

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes
`count`	No
`limit`	No
`offset`	No
`totalCount`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv2.13.0Sep 20, 2026
- changedInput schema / properties / limit / minimum
```
Previous value: -1New value: +0
```
First observedv2.8.0Jun 30, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses important behavioral caveats: ipAddress is frequently absent, the client schema is minimal and identical across types, and signal strength, channel, and per-port binding are not exposed. It also notes the version against which behavior was verified. This is meaningful, non-obvious context.

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?

The description is compact and information-dense, front-loading the purpose and return fields followed by caveats and alternatives. A slight redundancy exists between 'currently connected' and 'who's online right now,' but every other sentence carries unique value.

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?

Given the output schema covers return structure and the input schema covers parameters, the description fills all remaining gaps: absent fields, schema limitations, and the distinction from history/session tools. An agent has everything needed to call this tool correctly and interpret risks.

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 the schema already documents limit, filter, offset, and siteId. The description does not add parameter-level detail beyond what the schema provides, placing it at the baseline for fully covered schemas.

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?

Description opens with a precise verb and resource: 'List currently connected clients at a site.' It is immediately distinguishable from related siblings by explicitly stating that disconnected/historical clients are not in the Integration API and directing to unifi_list_client_history and unifi_list_client_sessions.

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?

The description clearly states when to use this tool ('who's online right now') and when not to use it ('Disconnected/historical clients are NOT in the Integration API'), naming specific alternative tools. This is explicit and leaves no ambiguity.

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

Deploy Server