Skip to main content
Glama

Get dashboard metrics

unifi_get_dashboard
Read-only

Retrieve the aggregated UniFi dashboard showing WAN/ISP quality history—latency, packet loss, availability, throughput—plus WiFi experience and client mix for a site and time window.

Instructions

Get the aggregated dashboard the UniFi UI shows: WAN/ISP quality history (latency, packet loss, availability, throughput), WiFi experience and client mix. v2 API, Network 7.4+; large response.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
hoursNoHistory window in hours (default 24)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description usefully adds the v2 API / Network 7.4+ prerequisite and warns that the response is large, which annotations cannot convey. It stops short of saying how large, whether the window is bounded server-side, or any rate-limit/cost implications of pulling a big payload.

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?

One front-loaded sentence with a colon-delimited content list, then a terse clause for version and response-size caveats. No filler, and the most decision-relevant facts (what you get, version floor, big payload) arrive first.

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 read-only aggregate with no output schema, two optional fully-documented params and no nesting, the description gives enough: content categories, version requirement, and a size warning. Minor gaps are the absence of any statement about response shape granularity (per-WAN vs aggregate) or how the hours window affects returned series.

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%, with both 'site' (including a pointer to unifi_list_sites) and 'hours' (default 24, max 720) documented in the schema, so the baseline is 3. The description's 'quality history' phrasing loosely ties to the hours window but adds no format or semantics beyond the schema.

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 ('Get') and resource ('aggregated dashboard') and enumerates the payload categories: WAN/ISP quality history with latency, packet loss, availability and throughput, plus WiFi experience and client mix. An agent knows exactly what data comes back, though it never contrasts itself with near-neighbors like unifi_get_site_health or unifi_get_traffic_report.

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 only implied: 'the aggregated dashboard the UniFi UI shows' suggests a broad overview call, and 'large response' hints at not calling it casually. There is no explicit when-to-use, no when-not-to-use, and no named alternative for narrower needs such as speedtest results or site health.

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