Skip to main content
Glama

Get firmware status

unifi_get_firmware_status
Read-only

List each UniFi device's model, firmware version, upgrade availability and target version, plus how many devices can upgrade; optionally include installable firmware images.

Instructions

List each device's model and firmware version, whether an upgrade is available (and to which version) or running, with the number of upgradable devices; include_available adds the firmware images the controller can install. Availability is as of the controller's last check with Ubiquiti. unifi_check_updates also covers Network application updates.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
include_availableNoAlso list firmware images available to the controller (cmd/firmware list-available)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

TDQS

A4.1/5.0
Behavior4/5

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

The readOnlyHint annotation already establishes safety, so the description correctly avoids restating read-only status. It adds material context beyond annotations: availability is only as fresh as the controller's last check with Ubiquiti, and include_available expands the results to firmware images the controller can install. That freshness caveat is valuable for an agent deciding whether to trust the data.

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?

The definition is three short sentences and front-loads the primary output description and the include_available effect before the freshness caveat and sibling note. Every sentence carries information, though the first sentence is dense with clauses and the sibling note could be slightly tighter.

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?

This is a simple read-only listing tool with no nested parameters and full schema coverage, so the description does not need to re-document parameters. It gives the agent the returned fields, the optional image-list behavior, a data-freshness caveat, and a sibling distinction. The only minor gap is that it does not explicitly mention the default-site behavior, though the schema covers it.

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 the schema already documents both parameters, making 3 the baseline. The description reiterates that include_available adds firmware images the controller can install, but adds little beyond the schema text. The site parameter is handled entirely by the schema.

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?

The description uses a specific verb ('List') and resource ('each device's model and firmware version') and enumerates the exact status fields returned. It also distinguishes itself from the sibling unifi_check_updates by noting that sibling covers Network application updates, so an agent can tell the two apart without inspecting schemas.

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?

The description makes clear this is for per-device firmware upgrade status and highlights that unifi_check_updates handles Network application updates, which implicitly routes the agent. It also explains when to set include_available. It stops short of an explicit 'use this instead of X when Y' statement, so it is clear context rather than full when/when-not guidance.

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