UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_list_nvrs

Read-only

Retrieve the NVR console info: ID, name, type, MAC, doorbell settings, and arm mode status. Get a single object with all key UniFi Protect NVR details.

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[]), armMode (status, armedAt, willBeArmedAt, breachDetectedAt, breachEventCount, breachTriggerEventId, breachEventId).

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Output Schema

TableJSON 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.

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.4/5.0

Behavior4/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavioral context by revealing the singular response shape and enumerating the returned fields (id, modelKey, type, doorbellSettings, armMode), going beyond what annotations provide.

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 purpose and the critical singular-object caveat before listing return fields. The field enumeration is somewhat long but relevant and not padded; it remains compact enough for a zero-parameter tool.

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 tool with an output schema and annotations present, the description is complete. It covers the main purpose, the important array-vs-single-object behavior, and the expected return fields, leaving no gaps for an agent to call it correctly.

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 description coverage is 100%, so the schema fully covers parameters. A zero-parameter tool gets a baseline of 4; no additional parameter explanation 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 states a specific verb and resource: 'Get the NVR (Network Video Recorder) console info.' It also explicitly corrects the name's implication by noting the endpoint returns a SINGLE NVR object, not an array, which distinguishes it from a typical list operation and from sibling tools.

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

Usage Guidelines4/5

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

The description gives clear context for when to use the tool: to retrieve console information for the single NVR. The explicit 'not an array' caveat helps prevent misuse, though it does not name alternative sibling tools or provide explicit when-not conditions beyond that caveat.

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