What is unifi-mcp AGENTS.md?

Project-wide instructions for the UniFi MCP codebase, which lets coding agents connect to UniFi controllers through tools. They define architecture boundaries, layering, non-goals, and shared-object rules.

Guiding changes across UniFi apps and shared packages, especially tool functions, managers, controller connections, runtime factories, and tests.

They prevent business logic from being placed in the wrong layer, circular dependencies between packages, and inconsistent creation of shared services.

How sirkirby/unifi-mcp configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to sirkirby/unifi-mcp. 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/sirkirby/unifi-mcp/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/sirkirby/unifi-mcp

Made for: Codex, OpenCode.

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/sirkirby/unifi-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/sirkirby/unifi-mcp/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/sirkirby/unifi-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/sirkirby/unifi-mcp/agents-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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/sirkirby/unifi-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/sirkirby/unifi-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 6,297 This file is loaded in full into every session.

When invoked 6,297 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.

Model	Per session	Once invoked
Fable 5.1	$0.06297	$0.06297
Opus 5.5	$0.02519	$0.02519
Sonnet 5.5	$0.01259	$0.01259
Haiku 4.5	$0.00630	$0.00630

Measured 3d ago against content hash c97e68b7bfc9, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

unifi-mcp AGENTS.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 3d 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

unifi-mcp AGENTS.md — 100% identical, 76 lines differ

AGENTS.md · 364 lines

How it starts

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

Project Rules

Documentation scope

Commit user-facing documentation and maintained contributor/agent instructions only. Keep internal plans, research notes, review/audit reports, execution records, and release checklists in Myco or private storage outside the checkout. These working documents MUST NOT be committed to Git. Before committing documentation, check its audience and remove references to any working documents moved out of the repository.

Non-Goals

This project is not:

a general-purpose network management framework
a UniFi controller replacement or admin dashboard
a real-time monitoring or alerting service
a CI/CD pipeline runner or deployment tool
a web application with a frontend UI (dev consoles are debugging REPLs only)
a database or persistent storage layer (all state lives on UniFi controllers)

Architecture Rules

Layering

Tool functions MUST NOT contain business logic beyond argument validation and response formatting
Tool functions MUST delegate to manager methods for all controller interactions
Manager methods MUST NOT import from <app>.tools (no circular dependencies)
All controller communication MUST flow through ConnectionManager
Tool modules MUST import singletons from <app>.runtime, never instantiate directly
Shared packages MUST NOT import from app packages (dependency flows downward only)
App packages MUST NOT import from each other (no cross-app dependencies)

Singletons

All shared objects (server, config, managers) MUST be created via @lru_cache factories in <app>/runtime.py
Tests MUST monkey-patch the factory or alias before importing tool modules
There MUST be exactly one ConnectionManager instance per server process

Tool Response Contract

All tools MUST return Dict[str, Any]:

{"success": True, "data": <result>}                                    # Success
{"success": False, "error": "<specific, actionable message>"}          # Error
{"success": True, "requires_confirmation": True, "preview": <payload>} # Mutation preview

Read the full file on GitHub · 364 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.

3d ago Changed · +10 lines · +176 tokens per session c97e68b7bfc9
15d ago Changed · +15 lines · +481 tokens per session e05d024559d9
1mo ago Changed · +8 lines · +79 tokens per session 0894c23b4a0a
1mo ago Changed · +28 lines · +337 tokens per session 4ec5bef52be8
1mo ago Changed · +6 lines · +268 tokens per session 1e7c2fc09ced
1mo ago Changed · +1 lines · +50 tokens per session 771f1031358b
1mo ago Changed · +4 lines · +185 tokens per session 469ff0d47234
1mo ago First seen · 292 lines · 4,721 tokens per session scan A 9aeae64ec972

Subscribe to this mod's changes

unifi-mcp AGENTS.md is an instructions file published in the GitHub repository sirkirby/unifi-mcp (955 stars, last pushed yesterday), licensed MIT. It adds 6,297 tokens to every session, about $0.0252 per session on Opus 5.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-30.

home-automation mcp-server unifi unifi-access unifi-controller unifi-network

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 · 9,715 tokens

unifi-mcp: Instructions file for Codex