Skip to main content
Glama

UniFi Protect: List PTZ Patrols

unifi_protect_list_ptz_patrols
Read-only

Retrieve a PTZ camera's saved patrol routes by camera ID so you can inspect available patrol configurations.

Instructions

List a PTZ camera's saved patrol routes. See unifi_protect_list_ptz_presets for why there is no tool to start or stop one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "cameraId": "<cameraId>"
    },
    "name": "unifi_protect_list_ptz_patrols"
  }
}

Input Schema

NameRequiredDescriptionDefault
cameraIdYesCamera id — the `id` from unifi_protect_list_cameras, a 24-character hex string. Not the camera's name and not its MAC address.

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/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, so the description adds value beyond it: it discloses that patrols are 'saved' routes and preempts the common agent mistake of hunting for a patrol control tool. It does not describe the shape of returned routes or whether results are per-camera scoped, but the annotations carry the main burden.

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, zero waste, with the core action front-loaded and the routing note second. Nothing to trim.

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-only lister with no output schema, the description covers purpose, safety implication, and the missing-control caveat. A brief note on what a patrol route object contains would fully close the gap.

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 cameraId description already specifies the exact source, format (24-char hex), and common confusions (name, MAC). The description adds nothing about the single parameter, so baseline 3 applies.

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: list a PTZ camera's saved patrol routes. It is distinguishable from the sibling unifi_protect_list_ptz_presets by naming 'patrol routes' rather than presets, though it never explicitly contrasts the two.

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?

Clear context for when to call it (retrieve saved patrol routes for a given camera), and it usefully closes off a dead end by noting there is no start/stop tool and pointing to the presets tool for the explanation. No explicit exclusions or alternative-selection criteria beyond that.

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