UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_list_viewers

Read-only

List all viewers managed by UniFi Protect, including id, name, mac, state, type, and liveview details. Quickly retrieve an overview of viewers for monitoring or configuration.

Instructions

List all viewers managed by UniFi Protect. Returns array; each viewer includes: id, modelKey, name, mac, state, type, guid, liveview, streamLimit (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.

Changed2 schema fields changedv2.13.0Sep 20, 2026

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 / 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 / result / items / properties / liveview / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / liveview / 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

Changed2 schema fields changedv2.7.5Jun 21, 2026

addedOutput schema / properties / result / items / properties / liveview

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Assigned live view ID, or null"
+}

addedOutput schema / properties / result / items / properties / streamLimit
```
Added value: +{
+  "description": "Max concurrent streams (number)"
+}
```

First observedv2.7.4Jun 11, 2026

TDQS

A4.3/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 that the call returns an array with specific fields, which is useful, but it does not mention pagination, ordering, or any additional behavioral details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence that states the operation, the resource, the return type, and the relevant fields. The documentation version note adds useful provenance without padding.

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 provides everything needed: what is listed, the scope, and the expected return shape. Nothing essential 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 takes zero parameters, and the schema coverage is effectively 100% for that empty parameter set. There is no parameter semantic burden for the description to carry, so the baseline of 4 applies.

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 uses the specific verb 'List' with the resource 'viewers' and explicitly scopes to 'all viewers managed by UniFi Protect.' This clearly distinguishes it from sibling tools like protect_get_viewer and other list_* variants.

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 'List all viewers' phrasing makes the enumeration use case clear, especially alongside the singular protect_get_viewer sibling. It does not explicitly state when not to use it or name an alternative, but the context is unambiguous.

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