CaddyUI-MCP: Instructions file for GitHub Copilot

.github/copilot-instructions.md

CaddyUI-MCP copilot-instructions.md is an instructions file for GitHub Copilot from loryanstrant/CaddyUI-MCP. It costs 273 tokens per session, scanned A, original, MIT.

Development instructions for a Python MCP server that connects CaddyUI to its REST API. MCP is a way for an AI coding assistant to call defined tools, while a REST API is a web interface for reading and changing data.

In plain words
What is it for?
Use them when adding or maintaining CaddyUI-MCP tools, configuring bearer-token authentication, passing CaddyUI settings through environment variables, and keeping the Python code style and dependencies consistent.
Why use it?
They keep the server's tools, authentication, error handling, and configuration consistent. They also prevent secrets and large sets of proxy-host fields from being handled unsafely in code.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions AGENTS.md.

This is loryanstrant/CaddyUI-MCP's own configuration. It tells GitHub Copilot 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/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/loryanstrant/CaddyUI-MCP

Made for: GitHub Copilot.

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 copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/loryanstrant/caddyui-mcp/copilot-instructions.svg)](https://agentmods.dev/instructions/loryanstrant/caddyui-mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/loryanstrant/caddyui-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/loryanstrant/caddyui-mcp/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 273 This file is loaded in full into every session.
When invoked 273 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.00273 $0.00273
Opus 5 $0.00137 $0.00137
Sonnet 5 $0.00055 $0.00055
Haiku 4.5 $0.00027 $0.00027

Measured 6d ago against content hash d2b519be367a, 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 copilot-instructions.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.

.github/copilot-instructions.md · 16 lines

What it actually says

Copilot instructions — CaddyUI-MCP

MCP server (Python 3.13 + FastMCP v3) wrapping CaddyUI's /api/v1 REST API. See AGENTS.md for the full picture; this file mirrors the rules that must hold for inline completions.

  • Tools live in src/caddyui_mcp/server.py, one @mcp.tool per operation; they call the async client in client.py and return an error string on failure (never raise). Reads use annotations=_READ, deletes annotations=_DESTRUCTIVE.
  • Auth is Authorization: Bearer <token> from CADDYUI_TOKEN. Never hard-code a token or URL; both come from env via CaddyUISettings. Secrets live in Vaultwarden + gitignored .env, referenced as ${CADDYUI_TOKEN}.
  • Create/update take a pass-through config: dict — do not enumerate the 200+ proxy-host fields as parameters.
  • Match the surrounding style: from __future__ import annotations, type hints, 100-col lines, ruff-clean. Pin deps. Canonical repo is Gitea; GitHub is a read-only mirror.
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 · 16 lines · 273 tokens per session scan A d2b519be367a

Subscribe to this mod's changes

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

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

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