UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

List fobs

protect_list_fobs

Read-only

List all UniFi Protect fobs with details such as state, model, battery, and signal. Use limit and offset to page through large sites.

Instructions

List all fobs managed by UniFi Protect. Returns array; each fob includes: id, modelKey, name, mac, state, type, guid, awayState, buttonLabels, featureFlags (buttons[], hasKeypad), armControlSettings (enabled, armProfileId, nightProfileId), keypadSettings (beepEnabled, beepVolume), wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs). On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`limit`	No	Return at most this many items
`offset`	No	Skip this many items first (default 0)

Output Schema

TableJSON Schema

Name	Required	Description
`offset`	No	Paged results only: the index of the first item returned
`result`	Yes	Array of items returned by the list endpoint
`totalCount`	No	Paged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

Changed10 schema fields changedv2.15.0Oct 14, 2026

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 / featureFlags / description

Previous value: -"Feature flags (object: buttons[])"New value: +"Feature flags (object: buttons[], hasKeypad — hasKeypad added in 7.3.x)"

removedOutput schema / properties / result / items / properties / hasKeypad

Removed value: -{
-  "description": "Whether this fob has a keypad, added in 7.3.x (boolean)"
-}

changedOutput schema / properties / result / items / properties / keypadSettings / description

Previous value: -"Keypad config, added in 7.3.x (object: beepEnabled, beepVolume, backlightEnabled, backlightBrightness)"New value: +"Keypad config, added in 7.3.x (object: beepEnabled, beepVolume). The backlightEnabled/backlightBrightness fields were dropped in 7.3.70."

changedOutput schema / properties / result / items / properties / wirelessConnectionState / description

Previous value: -"Wireless link state (object)"New value: +"Wireless link state (object: signalState { signalQuality, signalStrength }, batteryStatus { percentage, isLow }, bridge)"

addedOutput schema / properties / totalCount

Added value: +{
+  "description": "Paged results only: the number of items in the whole list",
+  "maximum": 9007199254740991,
+  "minimum": -9007199254740991,
+  "type": "integer"
+}

Changed5 schema fields changedv2.13.0Sep 20, 2026

addedOutput schema / properties / result / items / properties / armControlSettings

Added value: +{
+  "description": "Arm-control config, added in 7.3.x (object: enabled, armProfileId, nightProfileId)"
+}

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 / hasKeypad

Added value: +{
+  "description": "Whether this fob has a keypad, added in 7.3.x (boolean)"
+}

addedOutput schema / properties / result / items / properties / keypadSettings

Added value: +{
+  "description": "Keypad config, added in 7.3.x (object: beepEnabled, beepVolume, backlightEnabled, backlightBrightness)"
+}

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"
+  ]
+}

Changed12 schema fields changedv2.11.5Sep 13, 2026
- removedOutput schema / properties / result / items / properties / awayState / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / awayState / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / buttonLabels / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / buttonLabels / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- 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"
+]
```
Addedv2.10.0Jul 29, 2026
Removedv2.9.0Jul 23, 2026

Changed4 schema fields changedv2.7.5Jun 21, 2026

addedOutput schema / properties / result / items / properties / awayState

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Away state, e.g. \"ONLINE\""
+}

addedOutput schema / properties / result / items / properties / buttonLabels

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Button label preset, e.g. \"securityActions\""
+}

addedOutput schema / properties / result / items / properties / featureFlags
```
Added value: +{
+  "description": "Feature flags (object: buttons[])"
+}
```
addedOutput schema / properties / result / items / properties / wirelessConnectionState
```
Added value: +{
+  "description": "Wireless link state (object)"
+}
```

First observedv2.7.4Jun 11, 2026

TDQS

A3.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds behavioral context: it lists the returned fob fields in detail and explains that paged results also return totalCount and offset. This extra information goes beyond the annotations and helps an agent understand the response shape and pagination behavior.

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 front-loaded with the tool's purpose, followed by return field details and a pagination note. It is somewhat lengthy due to the field enumeration, but every part serves to inform the agent. No rambling or redundant sentences.

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?

Given the presence of an output schema and safety annotations, the description is largely complete. It covers purpose, return shape, and pagination. It lacks explicit alternative-tool guidance, but for a simple list operation with structured output, this is a minor gap.

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 description coverage is 100%, so the baseline is 3. The description adds meaningful context for limit and offset by explaining they are used to page on large sites and that a paged result returns totalCount and offset. This clarifies the intended use beyond the schema's generic parameter descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'List all fobs managed by UniFi Protect.' This clearly distinguishes it from the singular sibling protect_get_fob by implying a collection, but it does not explicitly name alternatives. An agent can infer the purpose without opening the schema.

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

Usage Guidelines2/5

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

The description offers pagination guidance ('On a large site, use limit and offset to page'), which is useful for parameter usage, but it gives no guidance on when to choose this tool over alternatives like protect_get_fob or other list tools. No selection criteria or exclusions are provided.

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