unifi-mcp-server

top-clients-by-bandwidth

Read-only

Identify top clients consuming bandwidth on a UniFi site. Supports combined, transmit-only, or receive-only metrics to pinpoint heavy users.

Instructions

Top N clients by bandwidth on a site (combined / tx-only / rx-only). Requires Cloud Connector (UNIFI_API_KEY_OWNER).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "top-clients-by-bandwidth"
  }
}

Input Schema

Name	Required	Description	Default
`name`	Yes	Site host name (e.g., 'USM')
`topN`	No	Number of top clients to return (default: 10)
`metric`	No	Bandwidth metric: combined (tx+rx), tx-only, rx-only	combined
`limit`	No	Max clients to fetch from API (default: 200)

Schema Changelog

Changes observed during successful MCP inspections.

Addedv1.12.4May 22, 2026
Removedv1.12.3May 15, 2026
First observedv1.11.1May 6, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is clear. The description adds the important behavioral constraint of requiring a Cloud Connector key, which is beyond what annotations provide. It does not contradict annotations.

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?

The description is two short, information-dense sentences. The first sentence conveys the core function, and the second provides an important prerequisite. No wasted words.

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 simple data retrieval tool with no output schema, the description adequately covers the main purpose, metric options, and access requirement. It could explicitly mention sorting or the purpose of the 'limit' parameter, but the schema already describes that. Overall, it is sufficient for an agent to use correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value by interpreting the 'metric' parameter options ('combined / tx-only / rx-only') and stating the Cloud Connector requirement, which is not in the schema. It reinforces the meaning of 'top N' and the site host name parameter.

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 clearly states it retrieves top N clients by bandwidth for a site, with options for combined/tx-only/rx-only metrics. The verb is implied (list/get). It distinguishes itself from sibling tools which focus on other aspects like site health, firmware, or ISP metrics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The description specifies a prerequisite ('Requires Cloud Connector (UNIFI_API_KEY_OWNER)'), giving a clear condition for use. However, it does not provide explicit guidance on when to use this tool versus alternatives, nor does it mention when not to use it. No sibling tool comparisons are made.

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