UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

Get liveview

protect_get_liveview

Read-only

Fetch a live view by ID to get its layout, owner, and full camera slots. Use the returned slot list when updating, since PATCH replaces the entire slots array.

Instructions

Get details for a specific live view by ID. Returns: id, modelKey, name, isDefault, isGlobal, layout, owner, slots (each slot: cameras string[], cycleMode, cycleInterval). The full slot list is needed when updating because PATCH replaces the slots array.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes	Liveview ID

Output Schema

TableJSON Schema

Name	Required	Description
`id`	No	Liveview ID
`name`	No	Liveview name
`owner`	No	Owning user ID
`slots`	No	Camera slots
`layout`	No	Grid layout / slot count (number)
`isGlobal`	No	Whether shared across all users (boolean)
`modelKey`	No	Always "liveview"
`isDefault`	No	Whether this is the default liveview (boolean)

Schema Changelog

Changes observed during successful MCP inspections.

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

addedOutput schema / 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 / 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 / slots / type
```
Removed value: -"array"
```

Changed8 schema fields changedv2.11.5Sep 13, 2026

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 / owner / anyOf

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

addedOutput schema / properties / owner / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / slots / items / properties / cycleMode / anyOf

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

addedOutput schema / 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=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: the PATCH-replaces-slots semantics, which affects how an agent orders calls. It omits error/not-found behavior for an invalid ID.

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 purpose, then the return shape, then the PATCH caveat in three tight sentences. The enumerated return fields are somewhat redundant given the tool has an output schema, costing a little efficiency.

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 read-only, single-parameter tool with an output schema, the description covers the essentials and adds the one non-obvious workflow detail (slots must be fully supplied on PATCH because it replaces the array). No pagination or failure-mode notes, but nothing critical is missing.

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?

There is a single required parameter with 100% schema description coverage and a documented pattern, so the schema carries the parameter meaning. The description's 'by ID' adds nothing beyond it, which is the expected baseline 3 when schema coverage is complete.

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 details for a specific live view by ID'), which is enough to separate it from the sibling list tool protect_list_liveviews, since 'by ID' implies single-item retrieval. It never names that sibling explicitly, so it stops short of a 5.

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?

Gives a concrete usage condition: fetch the full slot list when updating because PATCH replaces the slots array, which tells the agent when this call is required. It does not explicitly contrast with protect_list_liveviews as the alternative for enumerating views, so there is no exclusion guidance.

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