Skip to main content
Glama

Get site health

unifi_get_site_health
Read-only

Retrieve a UniFi site's health by subsystem (WAN, LAN, WLAN, VPN, WWW), including ISP, WAN IP, latency, throughput, and device/client counts for a quick overall check.

Instructions

Get a site's status per subsystem (wan, lan, wlan, vpn, www): status, ISP, WAN IP, latency, throughput, and device and client counts. The quickest overall check of a site. For WAN quality over time use unifi_get_dashboard.

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

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.1

TDQS

A4.3/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, so the safety profile is covered. The description adds useful substance beyond that by listing the concrete fields returned (status, ISP, WAN IP, latency, throughput, device and client counts) and framing it as a summary snapshot rather than a time-series source. It does not mention auth requirements or the significance of idempotentHint=false, so it is strong but not complete.

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 short sentences, front-loaded with purpose and return contents, then the usage hint, then the alternative. Every clause carries information; nothing is redundant with the title.

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?

With no output schema present, the description compensates by enumerating the returned data per subsystem, which is exactly what an agent needs to decide whether to call it or fetch a time-series elsewhere. For a single optional-parameter read tool with annotations, nothing material is missing.

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?

Only one optional parameter (site) exists and schema description coverage is 100%, with the schema itself pointing to unifi_list_sites for discovery. The description adds no syntax or default behavior detail beyond the schema, so the baseline of 3 is appropriate.

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 and resource (get a site's status) and enumerates the subsystem breakdown (wan, lan, wlan, vpn, www) plus the returned fields, so the agent knows exactly what comes back. It also explicitly distinguishes itself from a sibling by name (unifi_get_dashboard).

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?

Provides clear when-to-use guidance ('The quickest overall check of a site') and redirects to the correct alternative for a related need ('For WAN quality over time use unifi_get_dashboard'). It does not state explicit exclusions versus tools like unifi_get_site_settings or unifi_get_system_info, so it falls short of full when/when-not coverage.

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