Skip to main content
Glama
owine

UniFi Protect MCP

by owine
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

protect_get_chime

Read-only

Retrieve complete chime information by ID, including MAC address, state, type, and camera ring settings. Use this to inspect a chime's configuration and linked cameras.

Instructions

Get full details for a specific chime by ID. Returns: id, modelKey, name, mac, state, type, guid, cameraIds (array of camera IDs), ringSettings (array of objects: cameraId, volume, ringtoneId, repeatTimes) — verified live 7.3.47.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesChime 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 | ...
modelKeyNoResource kind
cameraIdsNoPaired camera IDs (array of strings)
ringSettingsNoPer-camera ring config (array of objects: cameraId, volume, ringtoneId, repeatTimes)

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
+  ]
+}
  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. Changed2 schema fields changedv2.7.5
    • addedOutput schema / properties / cameraIds
      Added value: +{
+  "description": "Paired camera IDs (array of strings)"
+}
    • addedOutput schema / properties / ringSettings
      Added value: +{
+  "description": "Per-camera ring config (array of objects: cameraId, volume, ringtoneId, repeatTimes)"
+}
  4. First observedv2.7.4

TDQS

A4.1/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, covering the safety profile. The description adds response-shape detail and a 'verified live 7.3.47' reliability signal, but no additional behavioral or error context beyond that.

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?

The description is a single front-loaded sentence that identifies the operation before listing return fields. The field list is compact, and the version note is a short reliability cue with no filler.

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 lookup with annotations and an output schema, the description provides everything needed to invoke the tool correctly and understand the response. No critical guidance 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?

The only parameter, id, is already fully documented in the schema as 'Chime ID' with 100% coverage. The description adds no new semantic meaning beyond 'by ID', so the schema does the heavy lifting and 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 a specific verb ('Get'), a concrete resource ('chime'), and the selection criterion ('by ID'). It also enumerates the returned fields, making it easy to distinguish from list_chimes and other sibling get_* tools.

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?

The phrase 'for a specific chime by ID' clearly implies use when an ID is already known and full details are needed, while list_chimes would cover enumeration. It does not explicitly name alternatives or exclusions, so it falls short of a 5.

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

Deploy Server

Other Tools