Lancontrol

lancontrol

lancontrol reads UniFi Network controller state through a single action-router tool: connected clients, network devices, WLAN configurations, site health, active alarms, recent events, controller sysinfo, and the authenticated identity. One binary serves a command-line interface and a stdio MCP server.

This is a labelled core subset. The upstream surface defines 267 actions in total; lancontrol builds only the 8 preserved convenience actions plus help (9 action values). The generated families are omitted, on purpose and by name: official_* (78 actions), unifi_* (175 actions), and the 5 hybrid aliases (list_clients, list_devices, list_networks, list_wifi, get_system_info).

Configuration

Both variables are required for every action except help; a missing value errors before any request is made:

Never pass the API key as a tool argument; it is read from the environment only.

Install

npx @reneturcios/lancontrol help

Or run the container image:

docker run -i ghcr.io/cloudcorprecords/lancontrol

The container defaults to the MCP server (see below). Pass CLI arguments to use it as a CLI instead.

CLI

lancontrol clientslancontrol deviceslancontrol wlanslancontrol healthlancontrol alarmslancontrol events --limit 25lancontrol sysinfolancontrol melancontrol help
lancontrol --version

Action commands print the upstream JSON payload. help prints the local action documentation and needs no configuration and no network. Exit codes: 0 on success, 1 when a call fails (including a missing-config or upstream API error), 2 for usage errors.

MCP server

One bin serves both faces. The mcp subcommand starts a stdio MCP server:

npx -y @reneturcios/lancontrol mcp

MCP client configuration:

{  "mcpServers": {    "lancontrol": {      "command": "npx",      "args": ["-y", "@reneturcios/lancontrol", "mcp"],      "env": {        "UNIFI_URL": "https://unifi.local",        "UNIFI_API_KEY": "...",        "UNIFI_SITE": "default"      }    }  }}

Tool

One tool is exposed:

Upstream mapping (documented reconstruction)

The public spec names the actions but does not publish, in its convenience-action table, the exact controller path for each one. Each action is therefore implemented as a GET to a plausible documented UniFi internal endpoint under UNIFI_URL, with the X-API-KEY header:

HTTP failures surface the status plus the upstream message (meta.msg, message, or error) when present.

Development

npm installnpm run build   # tsc -> dist/npm test        # node test runner over test/*.test.ts, no network (fake fetch fixtures)npm run dev     # run the CLI from source via tsx

License

MIT — see LICENSE.