Skip to main content
Glama
owine

UniFi Protect MCP

by owine

protect_get_siren

Read-only

Retrieve full details of a specific siren by ID, including state, volume, LED settings, and connection status.

Instructions

Get full details for a specific siren by ID. Returns: id, modelKey, name, mac, state, volume, ledSettings (isEnabled), sirenStatus (isActive, activatedAt, duration), connectionType, wirelessConnectionState (7.1.83 docs).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSiren ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoDevice ID
macNoMAC address
nameNoDevice name
stateNoCONNECTED | DISCONNECTED | ...
volumeNoSiren volume (number)
modelKeyNoResource kind
ledSettingsNoLED settings (object: isEnabled)
sirenStatusNoCurrent siren status (object: isActive, activatedAt, duration)
connectionTypeNoConnection type, e.g. "lora"
wirelessConnectionStateNoWireless link state (object)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.11.5
    • removedOutput schema / properties / connectionType / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / connectionType / 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"
      +]
  2. Changed5 schema fields changedv2.7.5
    • addedOutput schema / properties / connectionType
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Connection type, e.g. \"lora\""
      +}
    • addedOutput schema / properties / ledSettings
      Added value: +{
      +  "description": "LED settings (object: isEnabled)"
      +}
    • addedOutput schema / properties / sirenStatus
      Added value: +{
      +  "description": "Current siren status (object: isActive, activatedAt, duration)"
      +}
    • addedOutput schema / properties / volume
      Added value: +{
      +  "description": "Siren volume (number)"
      +}
    • addedOutput schema / properties / wirelessConnectionState
      Added value: +{
      +  "description": "Wireless link state (object)"
      +}
  3. First observedv2.7.4

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description does not add behavioral context such as error behavior for an unknown ID, staleness of state, or rate limits; its field list is return-value content, not behavior.

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 core action in one sentence, followed by a compact field enumeration. The enumeration is somewhat redundant given an output schema exists, but nothing is padded or buried.

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 one-parameter read tool with both annotations and an output schema, the definition is nearly sufficient. The remaining gap is the absence of guidance on how to obtain a valid ID and what happens on a missing/invalid one.

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% for the single 'id' parameter, so the schema already documents it fully. The description adds only the phrase 'by ID' and no format, prefix, or source guidance beyond the schema. 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 a specific verb ('Get') and resource ('siren') with the scope qualifier 'by ID', which is enough to separate it from the sibling protect_list_sirens without opening either schema.

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?

Usage is only implied: a caller who already holds a siren ID and wants full details. No explicit when-to-use, no prerequisite (e.g., obtain ID from protect_list_sirens), and no stated alternatives.

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