Skip to main content
Glama
owine

UniFi Protect MCP

by owine

List lights

protect_list_lights
Read-only

List all lights managed by UniFi Protect, including state, motion, and settings. Use limit and offset to page large sites.

Instructions

List all lights managed by UniFi Protect. Returns array; each light includes: id, modelKey, name, mac, state, type, guid, lightModeSettings (mode, enableAt), lightDeviceSettings (isIndicatorEnabled, pirDuration, pirSensitivity, ledLevel), isDark, isLightOn, isLightForceEnabled, lastMotion, isPirMotionDetected, camera (7.3.70 docs). On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

NameRequiredDescriptionDefault
limitNoReturn at most this many items
offsetNoSkip this many items first (default 0)

Output Schema

NameRequiredDescriptionDefault
offsetNoPaged results only: the index of the first item returned
resultYesArray of items returned by the list endpoint
totalCountNoPaged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.15.0
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Return at most this many items",
      +  "maximum": 9007199254740991,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Skip this many items first (default 0)",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedOutput schema / properties / offset
      Added value: +{
      +  "description": "Paged results only: the index of the first item returned",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / totalCount
      Added value: +{
      +  "description": "Paged results only: the number of items in the whole list",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
  2. Changed2 schema fields changedv2.13.0
    • addedOutput schema / properties / result / items / 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 / result / items / properties / type
      Added value: +{
      +  "description": "Hardware model name, e.g. \"UVC G6 Turret\", \"UP Chime PoE\", \"UNVR-PRO\"",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  3. Changed10 schema fields changedv2.11.5
    • removedOutput schema / properties / result / items / properties / camera / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / camera / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / mac / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / mac / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / modelKey / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / modelKey / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / items / properties / state / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / state / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  4. Changed8 schema fields changedv2.7.5
    • addedOutput schema / properties / result / items / properties / camera
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Paired camera ID"
      +}
    • addedOutput schema / properties / result / items / properties / isDark
      Added value: +{
      +  "description": "Whether it is currently dark out (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / isLightForceEnabled
      Added value: +{
      +  "description": "Main LED force-enabled (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / isLightOn
      Added value: +{
      +  "description": "Whether the light is currently on (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / isPirMotionDetected
      Added value: +{
      +  "description": "PIR motion currently detected (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / lastMotion
      Added value: +{
      +  "description": "Last motion timestamp in epoch ms (number)"
      +}
    • addedOutput schema / properties / result / items / properties / lightDeviceSettings
      Added value: +{
      +  "description": "Hardware settings (object: isIndicatorEnabled, pirDuration, pirSensitivity, ledLevel)"
      +}
    • addedOutput schema / properties / result / items / properties / lightModeSettings
      Added value: +{
      +  "description": "Activation settings (object: mode, enableAt)"
      +}
  5. First observedv2.7.4

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without the description. The description does add one genuinely behavioral detail — that a paged result also returns totalCount and offset — but the long field enumeration duplicates the existing output schema rather than adding traits.

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 purpose is correctly front-loaded in the first sentence, but the following field-by-field enumeration is a long, low-value block that largely restates what the output schema already provides. The paging note at the end is the only additional sentence that earns its place.

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?

With annotations covering safety and an output schema covering return shape, the description only needs to add operational context — which it does via the paging/totalCount note. Nothing essential for calling the tool correctly is missing, though the list-vs-get routing is left implicit.

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%, so both parameters and their bounds are already documented, making the baseline 3. The description's note that limit/offset are for paging on large sites reinforces intent but adds no syntax or constraint detail beyond the schema.

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 with scope ('List all lights managed by UniFi Protect'), which is unambiguous against the parallel protect_get_light tool. It does not explicitly name or contrast a sibling, so it falls just short of the top mark.

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 only usage guidance is conditional paging advice ('On a large site, use limit and offset to page'), which is really parameter behavior rather than a when-to-use rule. It never states when to prefer this over protect_get_light, leaving the list-vs-single distinction to be inferred from the name.

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