environment-setup

A guide for setting environment variables and other configuration for the UniFi MCP Server, a tool that connects coding agents to UniFi network systems.

In plain words
What is it for?
Use it when configuring cloud or local UniFi access, optional Redis caching, webhook verification, or loading settings in Python.
Why use it?
It keeps API keys and connection details out of source code and explains which settings take priority. It also helps avoid connecting to the wrong UniFi service or site.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/enuno/unifi-mcp-server/environment-setup
Clone the repo
git clone --depth 1 https://github.com/enuno/unifi-mcp-server

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 386 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00386
Opus 5 $0.00000 $0.00193
Sonnet 5 $0.00000 $0.00077
Haiku 4.5 $0.00000 $0.00039

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

Security

Grade A, and why

environment-setup 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.

.cursor/rules/environment-setup.mdc · 75 lines

What it actually says

Environment Setup

Required Environment Variables

# Required
UNIFI_API_KEY=your-api-key-here
UNIFI_API_TYPE=cloud  # or "local"
UNIFI_HOST=api.ui.com  # or local gateway IP
UNIFI_SITE=default

# Optional
REDIS_HOST=localhost  # Enable caching
REDIS_PORT=6379
WEBHOOK_SECRET=your-secret  # Enable webhook HMAC verification

Configuration Loading Order

The server merges settings from environment variables, an optional .env file, and src/config/config.py (listed in order of precedence).

API Configuration

Cloud API (Default)

UNIFI_API_TYPE=cloud
UNIFI_CLOUD_API_URL=https://api.ui.com

Local Gateway Proxy

UNIFI_API_TYPE=local
UNIFI_LOCAL_HOST=192.168.2.1
UNIFI_LOCAL_PORT=443
UNIFI_LOCAL_VERIFY_SSL=true

Development Environment

Always use .env.example as a template:

# Copy example file
cp .env.example .env

# Never commit .env to version control
# It's in .gitignore by default

Configuration in Code

Load settings in Python using Pydantic:

from src.config.config import Settings

settings = Settings()  # Automatically loads from environment

Security Reminders

  • NEVER hardcode API keys in source code
  • NEVER commit .env files to version control
  • ALWAYS use environment variables for sensitive data
  • ALWAYS mask sensitive data in logs
  • ALWAYS validate configuration on startup
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. 3d ago First seen · 75 lines · 0 tokens per session scan A ee8dcc2d20b5

Subscribe to this mod's changes

environment-setup is a cursor rule published in the GitHub repository enuno/unifi-mcp-server (242 stars, last pushed 14d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 386 tokens. 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.