Skip to main content
Glama

Get client details

unifi_get_client
Read-only

Retrieve a UniFi client by MAC to view stored settings merged with live connection details and an online flag; returns an error if the controller has never seen the MAC.

Instructions

Get one client by MAC: its stored settings (alias, note, fixed IP, blocked) merged with live connection details when it is connected, and an online flag. Errors if the controller has never seen the MAC.

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": {
      "mac": "<mac>"
    },
    "name": "unifi_get_client"
  }
}

Input Schema

NameRequiredDescriptionDefault
macYesMAC address, e.g. aa:bb:cc:dd:ee:ff
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=true, openWorldHint=false), the description discloses two genuinely useful behaviors: the response merges stored configuration with live connection data plus an online flag, and it errors when the MAC is unknown. This also implicitly explains the idempotentHint=false, since live fields vary between calls, though the description never says so directly.

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 that leads with the verb and identifier, then layers on the return shape and the error condition. Every clause carries information; nothing is redundant.

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 three-parameter read tool with no output schema, the description covers the identity key, what is returned, and the failure mode. The remaining gap is minor: it does not mention the raw flag's effect of returning large full controller objects, but the schema documents that.

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 mac, raw and site parameters are already documented in the schema. The description reinforces that the MAC is the identifying key but adds no format, validation, or behavioral nuance for raw or site beyond what the schema provides; 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 ("Get one client by MAC") and immediately clarifies the scope as a single client, which implicitly distinguishes it from the sibling unifi_list_clients. It further spells out the payload shape (stored settings merged with live connection details) so an agent knows exactly what it retrieves.

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?

Usage context is only implied: the requirement of a MAC and the error on unknown MAC suggest the caller must already have a MAC, but the description never says to use unifi_list_clients to discover one first. It also gives no explicit when-not guidance versus unifi_list_client_sessions or unifi_list_clients.

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