UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_list_fobs

Read-only

List all fobs managed by UniFi Protect and retrieve their complete configuration details, including state, button labels, and keypad settings.

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, backlightEnabled, backlightBrightness), wirelessConnectionState (7.3.47 docs).

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes	Array of items returned by the list endpoint

Schema Changelog

Changes observed during successful MCP inspections.

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

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 destructiveHint=false, so the description correctly avoids repeating safety. It adds behavioral value by specifying the return type ('Returns array'), enumerating the exact fields, and noting a version-specific detail (wirelessConnectionState in 7.3.47). This goes beyond annotations without contradicting them.

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 a single sentence that front-loads the core purpose, then lists return fields. While the field enumeration is lengthy, it is structured and informative, not redundant waste. It could be slightly shorter by relying on the output schema, but it serves as a quick reference.

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?

For a zero-parameter read-only list tool with an output schema present, the description is complete. It states what it does, what it returns, and adds a version note. Nothing an agent needs to call it correctly is missing.

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?

The tool has zero parameters and schema coverage is 100% (empty schema). Baseline for 0 params is 4, and the description correctly omits any parameter details since none exist. No additional meaning is needed.

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 'List all fobs managed by UniFi Protect' – a specific verb and resource, and the word 'all' differentiates it from the singular get_fob sibling. It also enumerates the return fields, making the purpose unambiguous.

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 implies use for retrieving all fobs, but does not explicitly name alternatives or provide when-not-to-use guidance. The existence of protect_get_fob is not referenced, so an agent must infer which to choose. The context is clear but not explicit.

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