unifi-mcp-server: Instructions file for Claude Code

CLAUDE.md

unifi-mcp-server CLAUDE.md is an instructions file for Claude Code from us-all/unifi-mcp-server. It costs 4,073 tokens per session, scanned A, original, MIT.

Project instructions for a read-only server that connects an AI assistant to UniFi network infrastructure through official APIs. UniFi is a system for managing network devices such as gateways, switches, and access points.

In plain words
What is it for?
Use them to install dependencies, build and run the server, perform a live smoke test, and understand which tools connect to UniFi cloud, connector, or local-controller services.
Why use it?
They give contributors the project’s technology choices, setup commands, and component map, so they can work without first reconstructing how the server is organized.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md.

This is us-all/unifi-mcp-server's own configuration. It tells Claude Code how to work on unifi-mcp-server itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything unifi-mcp-server configures →

Reuse

Borrowing it

Nothing to install: this file belongs to us-all/unifi-mcp-server. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/us-all/unifi-mcp-server/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/us-all/unifi-mcp-server

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for unifi-mcp-server CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/us-all/unifi-mcp-server/claude-md/github.svg)](https://agentmods.dev/instructions/us-all/unifi-mcp-server/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/us-all/unifi-mcp-server/claude-md"><img src="https://agentmods.dev/badge/instructions/us-all/unifi-mcp-server/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for unifi-mcp-server CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/us-all/unifi-mcp-server/claude-md"><img src="https://agentmods.dev/badge/instructions/us-all/unifi-mcp-server/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,073 This file is loaded in full into every session.
When invoked 4,073 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.04073 $0.04073
Opus 5 $0.02037 $0.02037
Sonnet 5 $0.00815 $0.00815
Haiku 4.5 $0.00407 $0.00407

Measured 8d ago against content hash 405353250d06, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

unifi-mcp-server CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 170 lines

How it starts

The opening of the file, as written. The whole thing — 170 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

Project Overview

UniFi Cloud API MCP server — semantic analysis tools + Cloud Connector integration for network infrastructure monitoring. Read-only access via official UniFi Site Manager API and Cloud Connector proxy.

Tech Stack

  • Runtime: Node.js 18+ with TypeScript
  • Package Manager: pnpm
  • MCP SDK: @modelcontextprotocol/sdk (^1.29.0)
  • Validation: zod v4
  • Config: dotenv

Build & Run Commands

pnpm install
pnpm run build
pnpm run smoke     # Live API smoke test
node dist/index.js # Start server

Architecture

Claude → MCP (stdio) → index.ts
                        ├── tools/analysis.ts    → Site Manager API (UNIFI_API_KEY)
                        ├── tools/*.ts (raw)      → Site Manager API (UNIFI_API_KEY)
                        ├── tools/connector.ts    → Cloud Connector  (UNIFI_API_KEY_OWNER)
                        └── tools/local-ports.ts  → Local Controller (UNIFI_LOCAL_URL + LAN access)
                        helpers/resolver.ts       → hostName ↔ ID mapping

Layers

  • Analysis tools (tools/analysis.ts): Semantic tools returning judgments (status/summary/issues)
  • Connector tools (tools/connector.ts): Cloud Connector proxy to local APIs (requires owner key)
  • Local tools (tools/local-ports.ts): Direct LAN access to controller legacy /api/s/{site}/* for data Integration API does not expose (port errors, SFP DDM, flap counters)
  • Raw tools (tools/hosts.ts, sites.ts, etc.): Direct Site Manager API wrappers
  • Helpers (helpers/resolver.ts): hostName ↔ hostId/siteId resolution

Key Source Files

  • src/index.ts — Entry point, 12 base + 33 connector = 45 tools
  • src/config.ts — Dual key config + isConnectorAvailable()
  • src/client.ts — Site Manager API client (X-API-KEY, retry)
  • src/connector-client.ts — Cloud Connector client (owner key, retry, 30s timeout)
  • src/retry.ts — withRetry: exponential backoff + jitter (429, 5xx, AbortError, network)
  • src/tools/utils.ts — wrapToolHandler, error sanitization
  • src/tools/analysis.ts — 3 semantic analysis tools
  • src/tools/connector.ts — 33 Cloud Connector tools (siteGet/hostGet helpers)
  • src/helpers/resolver.ts — hostName → hostId/siteId + ConnectorContext

Read the full file on GitHub · 170 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 170 lines · 4,073 tokens per session scan A 405353250d06

Subscribe to this mod's changes

unifi-mcp-server CLAUDE.md is an instructions file published in the GitHub repository us-all/unifi-mcp-server (3 stars, last pushed 2mo ago), licensed MIT. It adds 4,073 tokens to every session, about $0.0204 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens