Skip to main content
Glama
owine

UniFi Protect MCP

by owine

Get speaker

protect_get_speaker
Read-only

Fetch complete details for a specific UniFi Protect speaker by ID, including volume, mic status, state, and feature flags.

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.70 docs).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSpeaker ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoDevice ID
macNoMAC address
guidNoHardware MODEL GUID, shared by every unit of the same model. NOT a per-device identifier — use `id` to identify a device.
nameNoDevice name
typeNoHardware model name, e.g. "UVC G6 Turret", "UP Chime PoE", "UNVR-PRO"
stateNoCONNECTED | DISCONNECTED | ...
volumeNoSpeaker volume (number)
modelKeyNoResource kind
micVolumeNoMicrophone volume (number)
featureFlagsNoFeature flags (object: hasMic)
isMicEnabledNoMicrophone enabled (boolean)
speakerStateNoSpeaker state (object: status, mode)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.15.0
    • addedInput schema / properties / id / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
  2. Changed2 schema fields changedv2.13.0
    • 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"
      +  ]
      +}
  3. Changed8 schema fields changedv2.11.5
    • 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"
      +]
  4. Changed5 schema fields changedv2.7.5
    • 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)"
      +}
  5. First observedv2.7.4

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, and destructiveHint=false. The description only lists return fields, which are already covered by the output schema, and adds no behavioral context such as auth needs, rate limits, or error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence is front-loaded and efficient. The second sentence enumerates many return fields that are redundant with the existing output schema, adding length without new value.

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 getter with an output schema and safety annotations, the description covers the operation, the required ID, and the returned fields. It lacks usage routing to sibling tools, but that is a minor gap for an obvious single-item retrieval.

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 description coverage is 100%, and the schema already documents the sole 'id' parameter as 'Speaker ID'. The description's 'by ID' adds no syntax or format detail beyond what the schema provides, 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 speaker by ID'), making the operation clear. It does not differentiate from sibling tools like protect_list_speakers, 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 Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides no explicit when-to-use, prerequisites, or alternative tools. 'By ID' is a parameter constraint, not guidance on choosing this tool over protect_list_speakers or other getters.

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