# UISP [Health: Active]

**Category:** 📊 Monitoring  
**Repository:** https://github.com/WYRE-AI/uisp-mcp  
**GitHub Stars:** 0  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/uisp

## Description
MCP server for Ubiquiti UISP's REST API - network/ISP infrastructure monitoring for MSPs.

## Tools
Capabilities this server exposes over MCP:

- **uisp_list_sites** — list sites (network locations - sites, endpoints, and clients - each optionally tied to a UCRM client/service record).
- **uisp_get_site** — get a single site's detail.
- **uisp_search_sites** — search sites/endpoints/clients by name, address, MAC address, or IP address.
- **uisp_list_site_clients** — list all client sites belonging to a given (parent) site.
- **uisp_get_site_statistics** — get upload/download traffic between a site and its parent site.
- **uisp_get_site_traffic_summary** — get a site's total upload/download for a given interval up to now.
- **uisp_list_devices** — list devices (hostname/IP/MAC, status, parent site).
- **uisp_get_device** — get a single device's status overview.
- **uisp_get_device_detail** — get a device's detail, optionally including interfaces and/or connected stations.
- **uisp_get_device_statistics** — get device telemetry (CPU/RAM/signal/temperature/throughput).
- **uisp_list_device_interfaces** — list a device's network interfaces, including configured IP addresses.
- **uisp_get_device_by_mac** — look up a device by its MAC address.
- **uisp_list_discovered_devices** — list devices discovered on the network but not yet added.
- **uisp_list_outages** — list network outages - UISP's alerting surface - filterable by device, type, and in-progress state.
- **uisp_list_logs** — list the UISP event/audit log (logins, device state changes, backups, upgrades).
- **uisp_list_data_links** — list data links (the wireless/wired links UISP has mapped between devices and sites).
- **uisp_get_data_link** — get a single data link's detail.
- **uisp_list_site_data_links** — list data links attached to a given site.
- **uisp_list_gateways** — list gateways (routers configured as network gateways) and their NetFlow/QoS/suspend configuration.
- **uisp_get_gateway** — get a single gateway's detail.
- **uisp_list_tasks** — list background tasks (firmware upgrades, backups, mass operations) and their status.
- **uisp_get_tasks_in_progress** — get the number of tasks currently in progress.
- **uisp_list_firmwares** — get the firmware versions available to UISP for its supported device models.
- **uisp_get_speed_tests** — get detail about running and recent speed tests.
- **uisp_get_version** — get the UISP version, deployment type, and build info. Useful as a credential/connectivity sanity check.
- **uisp_get_network_statistics** — get network-wide statistics (client/site counts, network health, signal/link/ISP scores, outage counts).
- **uisp_get_summary** — get badge-count-like values across the instance (unread logs/outages/firmwares, active client/site counts).

## Claude Desktop Quick Installation
No confirmed install details yet, so no config is published. Follow the setup steps in the repository above.

## Documentation

## What the UISP MCP server does

The UISP MCP server gives an MCP client read access to a Ubiquiti UISP deployment. It covers the monitoring data most useful for a network operations or managed service workflow: sites and customer-linked endpoints, device inventory, device status, telemetry, outages, event logs, mapped data links, gateways, background tasks, firmware availability, and speed-test results.

The tool surface also includes network-wide statistics and summary counts. These can expose client and site totals, network health, signal and link scores, ISP scores, outage counts, unread events, active records, and related instance status. Site tools support searching by names, addresses, MAC addresses, or IP addresses, while device tools support MAC-based lookup and interface inspection.

## How it works

The UISP MCP server calls the UISP REST API under `/nms/api/v2.1`. Authentication uses an account token sent as the `x-auth-token` header, together with the URL of the specific UISP instance. UISP deployments are instance-specific, including hosted deployments, so one shared service URL is not assumed.

All exposed operations are reads. The connector issues `GET` requests and does not provide tools for provisioning, configuration changes, user administration, token management, credential-vault access, backups, server administration, CRM or billing changes, or other write-oriented functions. Several site results may include linked UCRM customer or service information, so access should be treated as potentially containing customer data.

## Setup and configuration

Create an account token in the UISP console under Settings, Users, and API tokens. A read-only token is the appropriate choice for this connector. Set `UISP_API_KEY` to that token and `UISP_BASE_URL` to the base URL of the UISP instance, such as `https://uisp.example.com`.

The default transport is stdio. Set `MCP_TRANSPORT` to `http` to use the HTTP transport. `AUTH_MODE` defaults to `env`, where credentials are loaded from the two UISP environment variables. In `gateway` mode, credentials arrive on each request through `X-UISP-Api-Key` and `X-UISP-Base-URL`. `CONDUIT_S2S_SECRET` can require a valid `X-Gateway-S2S` header for HTTP requests, and `LOG_LEVEL` controls logging verbosity.

## Tools and capabilities

The UISP MCP server organizes its tools around these operational areas:

- Sites: list, inspect, search, enumerate child client sites, and retrieve site traffic.
- Devices: list and inspect devices, interfaces, connected stations, telemetry, and discovered hardware.
- Monitoring: list outages, audit events, network links, gateways, tasks, and available firmware.
- Validation and status: inspect speed tests, UISP version details, network statistics, and instance summary counts.

Use `uisp_get_version` as a basic connectivity and credential check before investigating network data. Device statistics can include CPU, memory, signal, temperature, and throughput values when UISP provides them.

## Limitations and notes

The UISP MCP server was built against UISP's generated OpenAPI specification and the listed operations were checked against that specification, but the provided material notes that it was not exercised against a live UISP instance in the build environment. Results therefore depend on the target deployment, its available data, and the token's permissions.

This is a deliberately narrow monitoring surface, not a complete wrapper for the UISP API. It excludes sensitive credential stores, identity and access administration, backups, support bundles, server settings, and configuration or provisioning actions. Use a read-only token to keep the connector aligned with its read-only design.

_Full upstream README: https://allmcps.com/mcp/uisp/readme_