UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_get_viewer

Read-only

Retrieve complete configuration details for a specific UniFi Protect viewer by its ID, including name, MAC, state, liveview, and stream limits.

Instructions

Get full details for a specific viewer by ID. Returns: id, modelKey, name, mac, state, type, guid, liveview, streamLimit (7.3.47 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.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

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds value by enumerating the returned fields and citing the docs version. It does not contradict the annotations and gives useful context about what the call returns.

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 two concise sentences, front-loaded with the core action and resource, followed by a compact field list. No filler or redundant restatement of the tool name.

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 single-parameter read-only tool with annotations and an output schema, this description covers what the tool does, what it returns, and when to use it. Nothing critical is missing for correct invocation.

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?

Schema coverage is 100% and the single parameter 'id' is already described as 'Viewer ID'. The description adds no extra semantic detail about the parameter beyond what the schema provides, so baseline 3 is appropriate.

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 a specific verb ('Get full details') and resource ('a specific viewer by ID'), clearly distinguishing this from list_viewers and the other get_* siblings. The focus on ID-based retrieval makes the tool's purpose unmistakable.

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 clearly indicates this is the tool to use when you have a specific viewer ID and need full details. It does not explicitly mention list_viewers as the alternative for enumeration, but the context is clear enough for an agent to select it correctly.

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