Skip to main content
Glama
owine

UniFi Protect MCP

by owine

protect_get_alarm_hub

Read-only

Get detailed alarm hub info by ID: model, state, LED settings, tamper status, and Thread network details.

Instructions

Get full details for a specific alarm hub by ID. Returns: id, modelKey ("linkstation"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (object), deviceTamperStatus, threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.3.47 docs).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesAlarm hub 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 | ...
alarmHubNoAlarm hub status (object: armed, battery, connector, cover, output, input, …)
modelKeyNoResource kind
lastEventNoLast event timestamp in epoch ms (number)
isAlarmHubNoWhether this device is an alarm hub (boolean)
ledSettingsNoLED settings (object: isEnabled)
threadStateNoThread radio state, added in 7.3.x (object: network — status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt)
deviceTamperStatusNoTamper status, added in 7.3.x, e.g. "tampered"

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.13.0
    • addedOutput schema / properties / deviceTamperStatus
      Added value: +{
      +  "description": "Tamper status, added in 7.3.x, e.g. \"tampered\"",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • 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 / threadState
      Added value: +{
      +  "description": "Thread radio state, added in 7.3.x (object: network — status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt)"
      +}
    • addedOutput schema / properties / type
      Added value: +{
      +  "description": "Hardware model name, e.g. \"UVC G6 Turret\", \"UP Chime PoE\", \"UNVR-PRO\"",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. 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"
      +]
  3. Changed4 schema fields changedv2.7.5
    • addedOutput schema / properties / alarmHub
      Added value: +{
      +  "description": "Alarm hub status (object: armed, battery, connector, cover, output, input, …)"
      +}
    • addedOutput schema / properties / isAlarmHub
      Added value: +{
      +  "description": "Whether this device is an alarm hub (boolean)"
      +}
    • addedOutput schema / properties / lastEvent
      Added value: +{
      +  "description": "Last event timestamp in epoch ms (number)"
      +}
    • addedOutput schema / properties / ledSettings
      Added value: +{
      +  "description": "LED settings (object: isEnabled)"
      +}
  4. First observedv2.7.4

TDQS

A4/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 safety profile is covered. The description adds a detailed enumeration of returned fields, including nested threadState and alarmHub, but it does not disclose error behavior, authentication needs, or edge cases.

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?

The first sentence is a crisp, front-loaded purpose statement. The long return-field list is dense but organized and serves as a useful summary, though some of it duplicates the output schema and the docs-version parenthetical adds minor noise.

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 simple one-param read tool with annotations and an output schema, the description is sufficient: it names the resource, retrieval key, and the shape of returned data. No critical invocation information appears 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?

Schema coverage is 100% and the only parameter, id, already describes itself as 'Alarm hub ID' with required=true. The description reiterates that retrieval is 'by ID' but adds no format, precedence, or additional semantic detail beyond the schema.

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?

The description opens with a specific action and target: 'Get full details for a specific alarm hub by ID.' The mention of 'full details' and the specific resource distinguishes it from list_alarm_hubs and other get_* siblings without relying on inference.

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?

It clearly positions the tool as the single-entity retrieval variant ('by ID'), implying use when an ID is already known rather than for listing alarm hubs. It does not explicitly name the alternative list_alarm_hubs or state when not to use it, so it stops short of a perfect 5.

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