UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_get_fob

Read-only

Fetch complete details for a UniFi Protect fob by its ID, covering name, MAC, state, keypad settings, button labels, and wireless connection status.

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, backlightEnabled, backlightBrightness), wirelessConnectionState (7.3.47 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"
`hasKeypad`	No	Whether this fob has a keypad, added in 7.3.x (boolean)
`buttonLabels`	No	Button label preset, e.g. "securityActions"
`featureFlags`	No	Feature flags (object: buttons[])
`keypadSettings`	No	Keypad config, added in 7.3.x (object: beepEnabled, beepVolume, backlightEnabled, backlightBrightness)
`armControlSettings`	No	Arm-control config, added in 7.3.x (object: enabled, armProfileId, nightProfileId)
`wirelessConnectionState`	No	Wireless link state (object)

Schema Changelog

Changes observed during successful MCP inspections.

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

A3.7/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds value by enumerating the returned fields, including nested objects and a version reference for wirelessConnectionState. However, it does not disclose behavior on missing IDs, error conditions, or any rate limits. Given the annotation coverage, this is acceptable but not outstanding.

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 concise and front-loaded with the core action and resource. It lists the return fields in a structured manner, which is informative without being excessively verbose. The mention of a documentation version for one field is a minor extra that could be omitted, but overall the structure is efficient.

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?

The tool is a straightforward get-by-ID operation with a single parameter and a detailed output schema. The description covers the purpose and the expected return content, making it complete for an agent to call correctly. The only missing element is explicit error handling behavior, but the presence of an output schema mitigates this.

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?

The schema already describes the single 'id' parameter with 100% coverage, so the baseline is 3. The description does not add any additional semantic detail about the ID (e.g., format, length, or validation rules) beyond what the schema provides, which is sufficient for a simple parameter.

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 the tool's purpose: 'Get full details for a specific fob by ID.' It specifies the resource (fob) and the action (get details), and the list of returned fields adds specificity. It is easily distinguished from the sibling protect_list_fobs which lists all fobs, and from other get_* tools by naming the 'fob' resource.

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 usage context is implied: you need a specific fob ID to retrieve full details. However, it does not explicitly state when to prefer this over protect_list_fobs (e.g., when you already have an ID and need detailed attributes) or mention any exclusions or alternatives. The guidance is adequate for a simple get-by-ID tool but relies on the standard pattern.

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