UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

protect_get_speaker

Read-only

Retrieve complete details for a speaker by ID, including volume, microphone state, and speaker status to manage audio settings.

Instructions

Get full details for a specific speaker by ID. Returns: id, modelKey, name, mac, state, type, guid, volume, micVolume, isMicEnabled, speakerState (status, mode), featureFlags (hasMic) (7.3.47 docs).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes	Speaker 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 \| ...
`volume`	No	Speaker volume (number)
`modelKey`	No	Resource kind
`micVolume`	No	Microphone volume (number)
`featureFlags`	No	Feature flags (object: hasMic)
`isMicEnabled`	No	Microphone enabled (boolean)
`speakerState`	No	Speaker state (object: status, mode)

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"
+  ]
+}

Changed8 schema fields changedv2.11.5Sep 13, 2026

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"
+]
```

Changed5 schema fields changedv2.7.5Jun 21, 2026

addedOutput schema / properties / featureFlags

Added value: +{
+  "description": "Feature flags (object: hasMic)"
+}

addedOutput schema / properties / isMicEnabled

Added value: +{
+  "description": "Microphone enabled (boolean)"
+}

addedOutput schema / properties / micVolume

Added value: +{
+  "description": "Microphone volume (number)"
+}

addedOutput schema / properties / speakerState

Added value: +{
+  "description": "Speaker state (object: status, mode)"
+}

addedOutput schema / properties / volume

Added value: +{
+  "description": "Speaker volume (number)"
+}

First observedv2.7.4Jun 11, 2026

TDQS

A3.9/5.0

Behavior3/5

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

Annotations already establish readOnlyHint=true and destructiveHint=false, so the description adds no contradiction. It contributes only a version reference and a return-field list, without disclosing extra behaviors like error handling, permissions, or latency; for a simple getter this is adequate but not rich.

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?

A single front-loaded sentence states the action and key parameter, followed by a compact return-field list and docs reference. No filler or redundant explanation.

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 one-parameter read-only getter with full schema parameter coverage and an output schema, the description is essentially complete. There are no missing details an agent needs to select and invoke this tool correctly.

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?

The only parameter, id, is 100% covered by the schema ('Speaker ID'), and the description merely restates that selection is by ID. No additional format, uniqueness, or lookup semantics are supplied, so the baseline 3 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?

States an explicit verb ('Get'), a specific resource ('full details for a specific speaker'), and the selection key 'by ID.' This cleanly contrasts with list-oriented siblings like protect_list_speakers while matching the get_* pattern across sibling tools.

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 description implies the intended use — fetch one speaker once an ID is known — but it does not explicitly say when to choose this over protect_list_speakers or state any exclusions. There is enough context to infer usage, but no direct routing guidance.

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