Skip to main content
Glama
owine

UniFi Protect MCP

by owine

List arm profiles

protect_list_arm_profiles
Read-only

List arm profiles from the local UniFi Protect alarm manager, showing IDs, names, schedules, automations, and activation delays. Supports limit and offset for paging large sites.

Instructions

List all arm profiles (only available when using the local alarm manager — the standalone NVR alarm system, not Protect cloud alerts). Returns array; each profile (7.3.70 docs): id, name, automations[], creator, schedules[], recordEverything, activationDelay (0 | 60000 | 300000 | 600000), createdAt, updatedAt. On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

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

Output Schema

TableJSON 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. Changed4 schema fields changedv2.11.5
    • removedOutput schema / properties / result / items / properties / creator / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / items / properties / creator / 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"
      +]
  3. Addedv2.10.0
  4. Removedv2.9.0
  5. Changed8 schema fields changedv2.7.5
    • addedOutput schema / properties / result / items / properties / activationDelay
      Added value: +{
      +  "description": "Activation delay in ms: 0 | 60000 | 300000 | 600000 (number)"
      +}
    • addedOutput schema / properties / result / items / properties / automations
      Added value: +{
      +  "description": "Associated automation IDs (array of strings)"
      +}
    • addedOutput schema / properties / result / items / properties / createdAt
      Added value: +{
      +  "description": "Creation timestamp in epoch ms (number)"
      +}
    • addedOutput schema / properties / result / items / properties / creator
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "ID of the user who created the profile"
      +}
    • removedOutput schema / properties / result / items / properties / modelKey
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Resource kind"
      -}
    • addedOutput schema / properties / result / items / properties / recordEverything
      Added value: +{
      +  "description": "Record everything while active (boolean)"
      +}
    • addedOutput schema / properties / result / items / properties / schedules
      Added value: +{
      +  "description": "Arm schedules (array of objects)"
      +}
    • addedOutput schema / properties / result / items / properties / updatedAt
      Added value: +{
      +  "description": "Last update timestamp in epoch ms (number)"
      +}
  6. First observedv2.7.4

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), so the bar is lower; the description still adds real context about the returned array shape, the effect of paging (totalCount and offset appear), and the discrete activationDelay values. It omits permission/auth requirements and default page size, which keeps it out of the top band.

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?

One dense paragraph, front-loaded with purpose and scope, then return shape, then paging guidance — a sensible order with no filler sentences. Slightly overstuffed for a two-parameter list tool, and the '(7.3.70 docs)' citation is incidental metadata that does not help invocation.

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?

Covers purpose, availability constraint, return fields, and paging behavior; an output schema exists so return values need not be spelled out (though it does so usefully). The remaining gap is default behavior when no limit is supplied — an agent cannot tell whether the call returns everything or is capped.

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?

Schema coverage is 100%, so limit/offset are already documented, giving a baseline of 3. The description adds operational meaning beyond the schema by explaining that these are the paging knobs to use on a large site and that using them changes the response shape (adds totalCount/offset).

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+resource ('List all arm profiles') and immediately disambiguates the scope: local alarm manager / standalone NVR, explicitly not Protect cloud alerts. An agent can tell what this returns and which system it applies to without opening the schema.

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?

Gives an explicit when-not condition (only available with the local alarm manager, not cloud alerts) and directs the agent to use limit/offset for paging on large sites. It does not name an alternative tool, but with no sibling arm-profile tools there is no meaningful alternative to route to.

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