Skip to main content
Glama

List alarms

unifi_list_alarms
Read-only

Lists controller alarms newest first with time, key, subsystem and message, excluding archived alerts by default. Network 10.6+ returns filtered v2 system log entries by severity and time window.

Instructions

List controller alarms (alerts), newest first, with time, key, subsystem and message; archived alarms are left out unless include_archived. On Network 10.6+, where the classic alarm list is gone, returns the v2 system log's entries of min_severity (default high) from the last hours (default 168) instead. For the full event history use unifi_list_events.

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_list_alarms"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
hoursNoLook back this many hours (system log; default 168)
limitNoMaximum items to return (default 100)
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar
min_severityNoLowest severity to include (system log; default high)
include_archivedNoInclude archived alarms (classic alarm list)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / hours
      Added value: +{
      +  "description": "Look back this many hours (system log; default 168)",
      +  "exclusiveMinimum": 0,
      +  "maximum": 2160,
      +  "type": "number"
      +}
    • changedInput schema / properties / include_archived / description
      Previous value: -"Include archived alarms"New value: +"Include archived alarms (classic alarm list)"
    • changedInput schema / properties / limit / description
      Previous value: -"Default 100"New value: +"Maximum items to return (default 100)"
    • addedInput schema / properties / min_severity
      Added value: +{
      +  "description": "Lowest severity to include (system log; default high)",
      +  "enum": [
      +    "low",
      +    "medium",
      +    "high",
      +    "very_high"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, and the description goes well beyond that with a version-conditional behavior branch: on Network 10.6+ the classic list is gone and v2 system-log entries filtered by min_severity and hours are returned instead. It omits pagination/limit defaults and mentions nothing about result volume or response envelope, which keeps it from a 5.

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?

Three sentences, each load-bearing: what is returned and in what order, the archived default, the version fallback, and the sibling alternative. Front-loaded with the primary behavior and 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 7-parameter read-only listing tool with no output schema, the description covers scope, ordering, defaults, and the awkward dual-backend behavior an agent would otherwise be surprised by. Nothing critical to correct invocation is missing.

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 the baseline is 3, but the description adds real meaning by binding hours and min_severity to the system-log code path and include_archived to the classic alarm list — telling the agent these parameters are conditional no-ops on some controllers rather than universal filters.

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?

Specific verb and resource ('List controller alarms (alerts)'), plus the exact per-item shape returned (time, key, subsystem, message) and the sort order. It also names a sibling, unifi_list_events, so an agent can distinguish it 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit routing: use this for alarms, use unifi_list_events for the full event history. It also states the archived-alarm default and the include_archived opt-in, so the agent knows which variant of the result it is asking for.

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