What is unifi-mcp AGENTS.md?

A project instruction file that sets rules for how the UniFi MCP codebase should be structured and changed. It documents boundaries, allowed dependencies, and how shared objects are created.

It helps with implementation and code review by defining layering, controller communication, package dependencies, and test setup for the UniFi MCP project.

It gives coding agents and developers a shared set of project rules, reducing architectural mistakes and inconsistent changes.

How devjourney/unifi-mcp configures Codex and OpenCode

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/devjourney/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/devjourney/unifi-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/devjourney/unifi-mcp/agents-md)

Your own site

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

Per session 4,721 This file is loaded in full into every session.

When invoked 4,721 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 100% copy Near-identical to another mod 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.04721	$0.04721
Opus 5.5	$0.01888	$0.01888
Sonnet 5.5	$0.00944	$0.00944
Haiku 4.5	$0.00472	$0.00472

Measured 1mo ago against content hash 9aeae64ec972, 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 1mo 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

This is a copy

100% identical to unifi-mcp AGENTS.md — 76 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 292 lines

How it starts

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

Project Rules

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

Exceptions MUST NOT escape tool functions. Catch, log with exc_info=True, return error dict.
Error messages MUST include the operation that failed (e.g., "Failed to list devices: ..." not just str(e)).
Raw tracebacks MUST NOT be exposed to MCP clients.

Confirmation System

All state-changing tools MUST implement preview-then-confirm:

confirm=False (default): validate input, return preview payload
confirm=True: execute the mutation on the controller
Bypass mode injects confirm=True automatically
Anchor: packages/unifi-mcp-shared/src/unifi_mcp_shared/confirmation.py

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

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 devjourney/unifi-mcp (0 stars, last pushed 3mo ago), licensed MIT. It adds 4,721 tokens to every session, about $0.0189 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 100% identical to unifi-mcp AGENTS.md, differing in 76 lines, and is treated as a copy.

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