UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

List liveviews

protect_list_liveviews

Read-only

List all UniFi Protect live views (camera grid layouts) with their slots, owner, and layout settings. Page large sites using limit and offset.

Instructions

List all live views (camera grid layouts shown on viewers / in the Protect UI). Returns array; each liveview includes (Integration API 7.3.70-verified): id, modelKey, name, isDefault, isGlobal, layout (number, slot count), owner (user ID), slots (array of {cameras: string[], cycleMode, cycleInterval}). NOTE: slots use a cameras string-array, not a single cameraId. On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

Name	Required	Description	Default
`limit`	No	Return at most this many items
`offset`	No	Skip this many items first (default 0)

Output Schema

Name	Required	Description
`offset`	No	Paged results only: the index of the first item returned
`result`	Yes	Array of items returned by the list endpoint
`totalCount`	No	Paged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv2.15.0Oct 14, 2026

addedInput schema / $schema

Added value: +"http://json-schema.org/draft-07/schema#"

addedInput schema / properties / limit

Added value: +{
+  "description": "Return at most this many items",
+  "maximum": 9007199254740991,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / offset

Added value: +{
+  "description": "Skip this many items first (default 0)",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}

changedOutput schema / additionalProperties
```
Previous value: -falseNew value: +{}
```

addedOutput schema / properties / offset

Added value: +{
+  "description": "Paged results only: the index of the first item returned",
+  "maximum": 9007199254740991,
+  "minimum": -9007199254740991,
+  "type": "integer"
+}

addedOutput schema / properties / result / items / properties / slots / anyOf

Added value: +[
+  {
+    "items": {
+      "additionalProperties": {},
+      "properties": {
+        "cameras": {
+          "description": "Camera IDs shown in this slot (array of strings)"
+        },
+        "cycleInterval": {
+          "description": "Cycle interval in seconds (number)"
+        },
+        "cycleMode": {
+          "description": "Slot cycle mode, e.g. \"time\"",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "type": "array"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / result / items / properties / slots / items

Removed value: -{
-  "additionalProperties": {},
-  "properties": {
-    "cameras": {
-      "description": "Camera IDs shown in this slot (array of strings)"
-    },
-    "cycleInterval": {
-      "description": "Cycle interval in seconds (number)"
-    },
-    "cycleMode": {
-      "description": "Slot cycle mode, e.g. \"time\"",
-      "type": [
-        "string",
-        "null"
-      ]
-    }
-  },
-  "type": "object"
-}

removedOutput schema / properties / result / items / properties / slots / type
```
Removed value: -"array"
```

addedOutput schema / properties / totalCount

Added value: +{
+  "description": "Paged results only: the number of items in the whole list",
+  "maximum": 9007199254740991,
+  "minimum": -9007199254740991,
+  "type": "integer"
+}

Changed8 schema fields changedv2.11.5Sep 13, 2026
- 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 / owner / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / owner / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / slots / items / properties / cycleMode / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / slots / items / properties / cycleMode / type
```
Added value: +[
+  "string",
+  "null"
+]
```
First observedv2.7.4Jun 11, 2026

TDQS

A3.9/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds behavior the annotations do not: the array return shape, the paging behavior on large sites, and the explicit gotcha that slots use a `cameras` string-array rather than a single `cameraId` — a real tripwire for callers.

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 the one-line purpose, then richer detail, then the caveat and paging note; the ordering is sensible. It is somewhat dense, and the enumerated liveview fields partly duplicate the existing output schema, but nothing is truly wasteful.

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?

With annotations covering the safety profile, a full output schema, and 100% schema description coverage, the description supplies only the extra bits an agent actually needs: the definition of a liveview, the string-array slots gotcha, and paging/totalCount behavior. Nothing required to call or interpret the tool 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?

Schema coverage is 100%, so limit/offset are already documented in the schema, but the description adds real semantics: that paging is the mechanism on large sites and that a paged response also carries totalCount and offset. That is genuinely new information about how the parameters behave.

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 ('List all live views') and even defines what a live view is (camera grid layouts shown on viewers / in the Protect UI), which disambiguates it from unrelated Protect resources. It does not name or contrast the sibling protect_get_liveview, so the list-vs-single routing is left to inference.

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?

The paging advice ('On a large site, use limit and offset to page') is conditional usage guidance, but there is no explicit statement of when to use this tool versus protect_get_liveview or the other protect_list_* tools. Usage context is implied rather than stated.

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