UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

Get viewer

protect_get_viewer

Read-only

Retrieve full details for a specific UniFi Protect viewer by ID, including model, name, MAC, state, type, liveview, and stream limit.

Instructions

Get full details for a specific viewer by ID. Returns: id, modelKey, name, mac, state, type, guid, liveview, streamLimit (7.3.70 docs).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes	Viewer 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 \| ...
`liveview`	No	Assigned live view ID, or null
`modelKey`	No	Resource kind
`streamLimit`	No	Max concurrent streams (number)

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 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: +{}
```

Changed2 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 / 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 / liveview / anyOf

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

addedOutput schema / properties / liveview / 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"
+]
```

Changed2 schema fields changedv2.7.5Jun 21, 2026

addedOutput schema / properties / liveview

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

addedOutput schema / properties / streamLimit

Added value: +{
+  "description": "Max concurrent streams (number)"
+}

First observedv2.7.4Jun 11, 2026

TDQS

A3.5/5.0

Behavior3/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 error behavior for an unknown ID); its field list is return-shape information, not behavior.

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?

Two short sentences, front-loaded with the purpose and free of filler. The enumerated return fields are slightly wasteful given an output schema exists, but the whole description is brief enough that it doesn't harm readability.

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 simple read-by-ID tool with full annotation coverage and an output schema, the description covers what an agent needs to select and invoke it. Nothing essential is missing, though it could note the read-only nature or behavior on an invalid 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?

With a single parameter at 100% schema description coverage ("Viewer ID" plus a pattern constraint), the schema already carries the semantics. The description's "by ID" adds nothing beyond the schema, so the baseline 3 applies.

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 viewer by ID"), which cleanly separates it from the sibling protect_list_viewers. It does not name the sibling explicitly, but "by ID" versus listing makes the distinction inferable.

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: an agent can infer this is the follow-up call after obtaining an ID from protect_list_viewers. There is no explicit when-to-use, when-not-to-use, or named alternative, so it lands at minimum viable.

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