Skip to main content
Glama

UniFi Protect: List Sensors

unifi_protect_list_sensors
Read-only

Lists UniFi Protect sensors with current temperature, humidity, light, open/closed state, motion, and battery percentage, extracting readings from bulky history arrays.

Instructions

List UniFi Protect sensors with their current readings — temperature, humidity, light level — plus open/closed state, motion, and battery percentage. The readings are lifted out of the console's per-metric history arrays, which are far larger than the values themselves.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "unifi_protect_list_sensors"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.3.0

TDQS

A4.2/5.0
Behavior4/5

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

readOnlyHint=true already tells the agent this is a safe read. Beyond that, the description discloses a genuinely useful behavioral trait: values are 'lifted out of the console's per-metric history arrays, which are far larger than the values themselves,' which explains the response shape and why it's flattened rather than raw. It stops short of noting auth requirements or response size/pagination, but the annotation carries the safety profile.

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?

Two sentences, front-loaded with the action and the returned fields. The second sentence earns its place by explaining the data provenance, which is not derivable from any structured field.

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 no output schema, the description does the work of enumerating returned fields, which is adequate for a read-only list tool with no parameters. The only gap is operational context — whether authentication is a prerequisite and whether results are scoped to a console — but for a simple list this is close to complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the baseline is 4. The description correctly implies the call returns all sensors with no filtering, matching the empty schema, and adds no misleading parameter claims.

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 ('List') and resource ('UniFi Protect sensors') and enumerates exactly what each record contains: temperature, humidity, light level, open/closed state, motion, battery. The resource is distinct from every sibling (cameras, lights, chimes, viewers), so an agent can route correctly without opening a 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 implied: this is an unfiltered enumeration of all sensors, which an agent will naturally pick when it needs sensor state. However, there is no explicit when-to-use/when-not guidance, no mention of the auth siblings (unifi_protect_auth_login/auth_status) that this call presumably depends on, and no pointer to an alternative for a single sensor.

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