CaddyUI-MCP: Instructions file for Codex

AGENTS.md

CaddyUI-MCP AGENTS.md is an instructions file for Codex, OpenCode from loryanstrant/CaddyUI-MCP. It costs 634 tokens per session, scanned A, original, MIT.

A project instruction file for CaddyUI-MCP, a Python server that lets an MCP client manage a Caddy reverse proxy through its web API. A reverse proxy directs web requests to services, and MCP is a way for an AI tool to call external services.

In plain words
What is it for?
Use it when changing the CaddyUI-MCP project so agents follow its development process, code layout, dependency rules, and repository instructions.
Why use it?
It gives coding agents shared rules for the project, including where code belongs, how to test and deploy it, and which repository is authoritative.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions Claude Code; mentions AGENTS.md.

This is loryanstrant/CaddyUI-MCP's own configuration. It tells Codex and OpenCode how to work on CaddyUI-MCP 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 CaddyUI-MCP configures →

Reuse

Borrowing it

Nothing to install: this file belongs to loryanstrant/CaddyUI-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/loryanstrant/CaddyUI-MCP/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/loryanstrant/CaddyUI-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.

agentmods badge for CaddyUI-MCP AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/loryanstrant/caddyui-mcp/agents-md.svg)](https://agentmods.dev/instructions/loryanstrant/caddyui-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/loryanstrant/caddyui-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/loryanstrant/caddyui-mcp/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 634 This file is loaded in full into every session.
When invoked 634 The same file — it is already loaded in full.
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.1 $0.00634 $0.00634
Opus 5 $0.00317 $0.00317
Sonnet 5 $0.00127 $0.00127
Haiku 4.5 $0.00063 $0.00063

Measured 6d ago against content hash b844f65792d4, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

CaddyUI-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 6d 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.

AGENTS.md · 44 lines

How it starts

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

AGENTS.md — CaddyUI-MCP

Cross-tool agent instructions (Claude Code, Copilot agent mode). Gotcha: Copilot inline suggestions do NOT read this file — any rule that must hold for inline completions is mirrored into .github/copilot-instructions.md. Keep them in sync.

Project

An MCP server that wraps CaddyUI's /api/v1 REST API so an MCP client can manage a Caddy reverse proxy (proxy/redirection hosts, raw routes, certificates). Python 3.13 + FastMCP v3. Canonical repo on Gitea (gitea.strant.casa/loryanstrant/CaddyUI-MCP); GitHub is a one-way push mirror — never review/merge PRs there. Modelled on the ESPHome-MCP homelab template.

How to work here

  • Use the plan-before-coding and write-a-test-plan skills (global, in ~/.copilot/skills/ — also available to Claude Code). Apply dev-standards/standards/{core,generic}.md.
  • Smallest shippable slice; one thing at a time. No new tools/deps unless they replace something. Pin dependencies; prefer boring, proven libraries.
  • At end of a task, capture any reusable lesson in DECISIONS.md.

Layout

  • src/caddyui_mcp/client.py — async httpx client for /api/v1 (Bearer auth, typed errors).
  • src/caddyui_mcp/server.py — FastMCP tools (one per operation) + INSTRUCTIONS.
  • src/caddyui_mcp/__main__.pymain() (stdio) / main_web() (HTTP :8080) with a connectivity pre-flight.
  • healthcheck.py — drives the full MCP handshake for the container healthcheck.

Build / test / deploy

  • make check = lint + format-check + typecheck + test (the gate).
  • Live tests need a real instance: CADDYUI_URL=… CADDYUI_TOKEN=… pytest -m live (they create and delete a throwaway proxy host — safe, self-cleaning).
  • Deploy as a container via Dockhand to SHOCKWAVE; front /mcp with Caddy at caddyui-mcp.strant.casa; register into MetaMCP. Verify the real artefact end-to-end (initialize + tools/list through the deployed endpoint), not just an HTTP 200.

Secrets

CADDYUI_TOKEN lives in Vaultwarden (CaddyUI API token (Claude Code)) and in a gitignored .envnever in the repo. Reference as ${CADDYUI_TOKEN}. Mint tokens in CaddyUI at /api-tokens (scope full for management).

Read the full file on GitHub · 44 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. 6d ago First seen · 44 lines · 634 tokens per session scan A b844f65792d4

Subscribe to this mod's changes

CaddyUI-MCP AGENTS.md is an instructions file published in the GitHub repository loryanstrant/CaddyUI-MCP (3 stars, last pushed 7d ago), licensed MIT. It adds 634 tokens to every session, about $0.0032 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,182 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