UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

List NVRs

protect_list_nvrs

Read-only

Retrieve UniFi Protect NVR console details, including model, GUID, MAC, doorbell settings, and arm mode status. Returns a single NVR object, not an array.

Instructions

Get the NVR (Network Video Recorder) console info. NOTE: despite the name, the Protect Integration API's /nvrs endpoint returns a SINGLE NVR object, not an array. Returns: id, modelKey, name, type (e.g. UNVR-PRO), guid, mac, doorbellSettings (defaultMessageText, defaultMessageResetTimeoutMs, customMessages[], customImages[] (preview, sprite)), armMode (status, armProfileId, armedAt, willBeArmedAt, breachDetectedAt, breachEventCount, breachTriggerEventId, breachEventId).

Input Schema

Name	Required	Description	Default
No arguments

Output Schema

Name	Required	Description
`id`	No	NVR ID
`mac`	No	MAC address, added in 7.3.x
`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	NVR name
`type`	No	Hardware model name, e.g. "UVC G6 Turret", "UP Chime PoE", "UNVR-PRO"
`armMode`	No
`modelKey`	No	Always "nvr"
`doorbellSettings`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv2.15.0Oct 14, 2026

changedOutput schema / additionalProperties
```
Previous value: -falseNew value: +{}
```
removedOutput schema / properties / armMode / additionalProperties
```
Removed value: -{}
```

addedOutput schema / properties / armMode / anyOf

Added value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "armProfileId": {
+        "description": "Active arm profile ID (present when arming/armed)",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "armedAt": {
+        "description": "Unix epoch ms when armed, or null (number|null)"
+      },
+      "breachDetectedAt": {
+        "description": "Unix epoch ms of last breach, or null"
+      },
+      "breachEventCount": {
+        "description": "Count of breach events (number)"
+      },
+      "breachEventId": {
+        "description": "Breach event ID, or null (string|null)"
+      },
+      "breachTriggerEventId": {
+        "description": "Triggering event ID, or null (string|null)"
+      },
+      "status": {
+        "description": "disabled | arming | armed | ...",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "willBeArmedAt": {
+        "description": "Scheduled arm time, or null (number|null)"
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / armMode / properties

Removed value: -{
-  "armProfileId": {
-    "description": "Active arm profile ID (present when arming/armed)",
-    "type": [
-      "string",
-      "null"
-    ]
-  },
-  "armedAt": {
-    "description": "Unix epoch ms when armed, or null (number|null)"
-  },
-  "breachDetectedAt": {
-    "description": "Unix epoch ms of last breach, or null"
-  },
-  "breachEventCount": {
-    "description": "Count of breach events (number)"
-  },
-  "breachEventId": {
-    "description": "Breach event ID, or null (string|null)"
-  },
-  "breachTriggerEventId": {
-    "description": "Triggering event ID, or null (string|null)"
-  },
-  "status": {
-    "description": "disabled | arming | armed | ...",
-    "type": [
-      "string",
-      "null"
-    ]
-  },
-  "willBeArmedAt": {
-    "description": "Scheduled arm time, or null (number|null)"
-  }
-}

removedOutput schema / properties / armMode / type
```
Removed value: -"object"
```
removedOutput schema / properties / doorbellSettings / additionalProperties
```
Removed value: -{}
```

addedOutput schema / properties / doorbellSettings / anyOf

Added value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "customImages": {
+        "description": "Configured custom LCD images (array of objects: preview, sprite)"
+      },
+      "customMessages": {
+        "description": "Configured custom LCD messages (array of strings)"
+      },
+      "defaultMessageResetTimeoutMs": {
+        "description": "Reset timeout in ms (number)"
+      },
+      "defaultMessageText": {
+        "description": "Default doorbell LCD message",
+        "type": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / doorbellSettings / properties

Removed value: -{
-  "customImages": {
-    "description": "Configured custom LCD images (array)"
-  },
-  "customMessages": {
-    "description": "Configured custom LCD messages (array of strings)"
-  },
-  "defaultMessageResetTimeoutMs": {
-    "description": "Reset timeout in ms (number)"
-  },
-  "defaultMessageText": {
-    "description": "Default doorbell LCD message",
-    "type": [
-      "string",
-      "null"
-    ]
-  }
-}

removedOutput schema / properties / doorbellSettings / type
```
Removed value: -"object"
```

Changed3 schema fields changedv2.13.0Sep 20, 2026

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

Added value: +{
+  "description": "MAC address, added in 7.3.x",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedOutput schema / properties / type

Added value: +{
+  "description": "Hardware model name, e.g. \"UVC G6 Turret\", \"UP Chime PoE\", \"UNVR-PRO\"",
+  "type": [
+    "string",
+    "null"
+  ]
+}

Changed10 schema fields changedv2.11.5Sep 13, 2026
- removedOutput schema / properties / armMode / properties / armProfileId / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / armMode / properties / armProfileId / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / armMode / properties / status / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / armMode / properties / status / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / doorbellSettings / properties / defaultMessageText / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / doorbellSettings / properties / defaultMessageText / 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"
+]
```
Addedv2.10.0Jul 29, 2026
Removedv2.9.0Jul 23, 2026

Changed2 schema fields changedv2.7.5Jun 21, 2026

addedOutput schema / properties / armMode / properties / armProfileId

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Active arm profile ID (present when arming/armed)"
+}

changedOutput schema / properties / armMode / properties / status / description

Previous value: -"disabled | armed | ..."New value: +"disabled | arming | armed | ..."

First observedv2.7.4Jun 11, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already cover the read-only, non-destructive, closed-world safety profile, so the bar is lower. The description adds real context beyond structured fields: the single-object return behavior that contradicts the 'list' naming, which prevents a caller from misparsing the response.

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?

Front-loaded with purpose followed by the important naming caveat. The trailing field enumeration is somewhat redundant given an output schema exists, but the overall text is compact and earns most of its space.

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 zero-parameter read tool with an output schema and clear annotations, the description covers everything needed to call it correctly. The return-field list duplicates the output schema rather than adding new information.

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 takes zero parameters, so per the rubric the baseline is 4. There is nothing for the description to disambiguate.

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?

States a specific verb ('Get') and resource ('NVR console info'). Critically, it resolves the naming ambiguity against the sibling list/get pattern by noting that despite the 'list' name, the endpoint returns a single NVR object, so an agent knows no separate get_nvr sibling exists.

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 implied - it is the only route to NVR info and the note discourages array expectations - but there is no explicit when-to-use, when-not-to-use, or alternative-tool guidance. Adequate but with a clear gap.

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