UISP

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.