Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

Get device

unifi_get_device
Read-only

Retrieve full configuration for a UniFi device, including switch port and PoE state, AP radio settings, and uplink topology. Use it to inspect device setup rather than live performance metrics.

Instructions

Get full configuration for a device. Returns (in addition to list fields): adoptedAt, provisionedAt, configurationId, uplink.deviceId (absent on the ISP modem), features (object keyed by capability: switching {lags[]} / accessPoint {}), interfaces.ports[] for switches, gateways and modems ({idx, state, connector, maxSpeedMbps, speedMbps (may be omitted on DOWN ports), poe:{standard, type, enabled, state} on PoE ports only}), interfaces.radios[] for APs ({wlanStandard, frequencyGHz, channelWidthMHz, channel}). Some devices (e.g. 5G modems) return empty features/interfaces objects. NOTE: in the LIST endpoint, features/interfaces are capability-tag string arrays instead. Use for: switch port layout/PoE state, AP radio config, uplink topology. For live throughput/CPU/memory, use unifi_get_device_statistics.

Input Schema

NameRequiredDescriptionDefault
siteIdYesSite ID
deviceIdYesDevice ID

Output Schema

NameRequiredDescriptionDefault
idYes
nameNo
modelNo
stateNo
uplinkNo
featuresNo
adoptedAtNo
ipAddressNo
supportedNo
interfacesNo
macAddressNo
provisionedAtNo
configurationIdNo
firmwareVersionNo
firmwareUpdatableNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.15.0
    • addedInput schema / properties / deviceId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • addedInput schema / properties / siteId / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
  2. First observedv2.8.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive, closed-world semantics, and the description adds genuine behavioral caveats: uplink.deviceId is absent on the ISP modem, speedMbps may be omitted on DOWN ports, and some devices (5G modems) return empty features/interfaces. Much of the remaining text describes return content that the output schema already covers, so it lands just short of 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.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and usage routing are correctly front-loaded, but the middle is a dense single block of nested parenthetical field enumerations that is hard to parse and largely duplicates the declared output schema. It is information-rich yet not efficiently structured.

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?

An output schema exists, so return values need not be re-explained, and the description still covers purpose, usage routing, sibling alternative, and cross-endpoint caveats. Nothing an agent needs to select or invoke this tool 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?

Only two parameters, both required and at 100% schema description coverage ("Site ID", "Device ID"), so the baseline is 3. The description adds no format, ID-source, or lookup guidance beyond what the schema states.

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 full configuration for a device") and immediately distinguishes the detail endpoint from the list endpoint's capability-tag arrays. An agent can tell it apart from unifi_list_devices and unifi_get_device_statistics 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 enumerates use cases ("switch port layout/PoE state, AP radio config, uplink topology") and names the alternative for the excluded case ("For live throughput/CPU/memory, use unifi_get_device_statistics"). This is a textbook when-to-use / when-not-to-use split.

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