Skip to main content
Glama
owine

UniFi Protect MCP

by owine

List link stations

protect_list_link_stations
Read-only

List all UniFi Protect link stations (non-alarm-hub gateways) with state, model, and settings. Page large sites using limit and offset.

Instructions

List all link stations managed by UniFi Protect. Link stations are non-alarm-hub gateways (use protect_list_alarm_hubs for alarm hubs). Returns array; each link station includes: id, modelKey ("linkstation"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. "tampered"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.3.70 docs). On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

NameRequiredDescriptionDefault
limitNoReturn at most this many items
offsetNoSkip this many items first (default 0)

Output Schema

NameRequiredDescriptionDefault
offsetNoPaged results only: the index of the first item returned
resultYesArray of items returned by the list endpoint
totalCountNoPaged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv2.15.0
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Return at most this many items",
      +  "maximum": 9007199254740991,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Skip this many items first (default 0)",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedOutput schema / properties / offset
      Added value: +{
      +  "description": "Paged results only: the index of the first item returned",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
    • changedOutput schema / properties / result / items / properties / alarmHub / description
      Previous value: -"Alarm hub status (object: armed, battery, connector, cover, output, input, …)"New value: +"Alarm hub status (object: armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. \"tampered\", added in 7.3.x), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus)"
    • removedOutput schema / properties / result / items / properties / deviceTamperStatus
      Removed value: -{
      -  "description": "Tamper status, added in 7.3.x, e.g. \"tampered\"",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedOutput schema / properties / totalCount
      Added value: +{
      +  "description": "Paged results only: the number of items in the whole list",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
  2. Changed4 schema fields changedv2.13.0
    • addedOutput schema / properties / result / items / properties / deviceTamperStatus
      Added value: +{
      +  "description": "Tamper status, added in 7.3.x, e.g. \"tampered\"",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / result / items / properties / guid
      Added value: +{
      +  "description": "Hardware MODEL GUID, shared by every unit of the same model. NOT a per-device identifier — use `id` to identify a device.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / result / items / properties / threadState
      Added value: +{
      +  "description": "Thread radio state, added in 7.3.x (object: network — status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt)"
      +}
    • addedOutput schema / properties / result / items / properties / type
      Added value: +{
      +  "description": "Hardware model name, e.g. \"UVC G6 Turret\", \"UP Chime PoE\", \"UNVR-PRO\"",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  3. Changed8 schema fields changedv2.11.5
    • removedOutput schema / properties / result / items / properties / mac / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / mac / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / modelKey / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / modelKey / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / state / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / state / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  4. Addedv2.10.0
  5. Removedv2.9.0
  6. Changed4 schema fields changedv2.7.5
    • addedOutput schema / properties / result / items / properties / alarmHub
      Added value: +{
      +  "description": "Alarm hub status (object: armed, battery, connector, cover, output, input, …)"
      +}
    • addedOutput schema / properties / result / items / properties / isAlarmHub
      Added value: +{
      +  "description": "Whether this device is an alarm hub (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / lastEvent
      Added value: +{
      +  "description": "Last event timestamp in epoch ms (number)"
      +}
    • addedOutput schema / properties / result / items / properties / ledSettings
      Added value: +{
      +  "description": "LED settings (object: isEnabled)"
      +}
  7. First observedv2.7.4

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile requires no prose. The description does add one genuinely behavioral detail beyond that: paged results return totalCount and offset. However, the bulk of the remaining text is a field-by-field dump of the return payload, which the output schema already owns, and no auth/permission or freshness caveats are given.

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 opening sentence and the closing pagination sentence are tight and front-loaded, and the alarm-hub exclusion is correctly placed early. The long parenthetical enumeration of nested alarmHub/threadState fields is bulky and largely redundant given that an output schema exists, so not every clause earns its place.

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 two-parameter read-only list tool with a full output schema and complete schema descriptions, the description covers dataset scope, sibling routing, and pagination semantics — everything needed to call it correctly. It loses a point mainly for spending completeness budget restating return fields instead of, say, whether results are site/NVR-scoped.

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% (limit = 'Return at most this many items', offset = 'Skip this many items first'), so the schema fully documents both parameters and the baseline is 3. The description only repeats the paging intent and adds that paged output includes totalCount/offset, which is marginal added meaning.

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?

Specific verb (list) + resource (link stations), with an explicit scoping definition: 'non-alarm-hub gateways'. It names the sibling that handles the other case (protect_list_alarm_hubs) and identifies the single-item sibling implicitly. An agent can distinguish this from protect_list_alarm_hubs and protect_get_link_station 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?

Gives an explicit when-not/alternative rule: alarm hubs belong to protect_list_alarm_hubs. It also states the condition for using the alternative invocation mode ('On a large site, use limit and offset to page'), so both the tool choice and the parameter choice are routed for the agent.

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