UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

Get fob

protect_get_fob

Read-only

Retrieve complete details for a specific UniFi Protect fob by ID to inspect its state, battery, signal, buttons, and keypad settings.

Instructions

Get full details for a specific fob by ID. Returns: 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).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes	Fob ID

Output Schema

TableJSON Schema

Name	Required	Description
`id`	No	Device ID
`mac`	No	MAC address
`guid`	No	Hardware MODEL GUID, shared by every unit of the same model. NOT a per-device identifier — use `id` to identify a device.
`name`	No	Device name
`type`	No	Hardware model name, e.g. "UVC G6 Turret", "UP Chime PoE", "UNVR-PRO"
`state`	No	CONNECTED \| DISCONNECTED \| ...
`modelKey`	No	Resource kind
`awayState`	No	Away state, e.g. "ONLINE"
`buttonLabels`	No	Button label preset, e.g. "securityActions"
`featureFlags`	No	Feature flags (object: buttons[], hasKeypad — hasKeypad added in 7.3.x)
`keypadSettings`	No	Keypad config, added in 7.3.x (object: beepEnabled, beepVolume). The backlightEnabled/backlightBrightness fields were dropped in 7.3.70.
`armControlSettings`	No	Arm-control config, added in 7.3.x (object: enabled, armProfileId, nightProfileId)
`wirelessConnectionState`	No	Wireless link state (object: signalState { signalQuality, signalStrength }, batteryStatus { percentage, isLow }, bridge)

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv2.15.0Oct 14, 2026

addedInput schema / properties / id / pattern
```
Added value: +"^[A-Za-z0-9_-]{1,64}$"
```
changedOutput schema / additionalProperties
```
Previous value: -falseNew value: +{}
```

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

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

changedOutput schema / 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 / wirelessConnectionState / description

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

Changed5 schema fields changedv2.13.0Sep 20, 2026

addedOutput schema / properties / armControlSettings

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

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

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

addedOutput schema / properties / keypadSettings

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

addedOutput schema / 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 / awayState / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / awayState / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / buttonLabels / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / buttonLabels / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / mac / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / mac / type

Added value: +[
+  "string",
+  "null"
+]

removedOutput schema / properties / modelKey / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / modelKey / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / name / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / name / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / state / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / 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 / awayState

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

addedOutput schema / properties / buttonLabels

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

addedOutput schema / properties / featureFlags

Added value: +{
+  "description": "Feature flags (object: buttons[])"
+}

addedOutput schema / properties / wirelessConnectionState

Added value: +{
+  "description": "Wireless link state (object)"
+}

First observedv2.7.4Jun 11, 2026

TDQS

B3.2/5.0

Behavior2/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds no behavioral context beyond that — no auth requirements, no behavior on an invalid/unknown ID, no note on whether the response is cached or live — and its one added element, the return-field list, is redundant with the output schema.

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 sentence is front-loaded and efficient, but the second sentence is a sprawling nested enumeration of return fields that duplicates the output schema and roughly doubles the length without adding selection value. The trailing '(7.3.70 docs)' citation is noise for an invoking agent.

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?

With read-only annotations, a fully documented single required parameter, and an existing output schema, the description covers what an agent needs to invoke the tool correctly. The main residual gap is the absence of any routing hint to protect_list_fobs for obtaining a valid ID.

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?

There is a single parameter with 100% schema description coverage ('Fob ID' plus a format pattern), so the schema fully documents it. The description adds no syntax, source, or format guidance for the id, making the baseline 3 appropriate.

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?

States a specific verb and resource ('Get full details for a specific fob by ID'), which is unambiguous and implies the get-vs-list distinction against protect_list_fobs. However, it never names the sibling or explicitly contrasts single-fetch with enumeration, so an agent must infer the relationship from naming convention alone.

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 is only implied: the 'by ID' phrasing suggests calling this when you already hold a fob ID and need its full record. There is no explicit when-to-use, when-not-to-use, or pointer to protect_list_fobs for discovering IDs, which is the natural precondition for this tool.

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