canon AGENTS.md

Project instructions for mcp-canon, an MCP server that gives AI agents software-architecture guidance from a searchable collection of documents. The guide covers the project’s structure, technologies, and main features.

In plain words
What is it for?
Use it when developing or changing mcp-canon, including its document search, custom Markdown indexing, local knowledge base, or HTTP server mode.
Why use it?
It gives coding agents consistent project-specific context instead of making them infer how the repository works.

Instructions file for CodexOpenCode

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 instructions/tripcher/canon/agents-md
Clone the repo
git clone --depth 1 https://github.com/tripcher/canon

Made for: Codex, OpenCode.

Per session 3,773 This file is loaded in full into every session.
When invoked 3,773 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 $0.03773 $0.03773
Opus 5 $0.01886 $0.01886
Sonnet 5 $0.00755 $0.00755
Haiku 4.5 $0.00377 $0.00377

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

Security

Grade A, and why

canon 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 yesterday.

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 · 540 lines

How it starts

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

AGENTS.md - AI Agent Development Guide

Project: mcp-canon
Purpose: MCP server providing architectural patterns and best practices to LLM agents via RAG
License: MIT


Overview of Project

mcp-canon is a Model Context Protocol (MCP) server that provides architectural consultant capabilities to AI agents. It uses Retrieval-Augmented Generation (RAG) to serve best practices and coding guidelines from a vector database.

Key Features

  • Bundled knowledge base with pre-indexed guides for Python, Docker, Kubernetes, etc.
  • Custom indexing capability for creating your own knowledge bases from Markdown files
  • HTTP server mode for remote access and multi-client scenarios
  • Offline-first design — all data is local, no external API calls required

Core Architecture

┌──────────────────────────────────────────────────────────────────┐
│                     DEV ENVIRONMENT (Indexing)                    │
│  Sources (MD/PDF/URL) → Docling → LangChain Chunking → LanceDB  │
└──────────────────────────────────────────────────────────────────┘
                              ↓
┌──────────────────────────────────────────────────────────────────┐
│                     USER ENVIRONMENT (Runtime)                    │
│  MCP Client → FastMCP Server → SearchEngine → LanceDB Vectors   │
└──────────────────────────────────────────────────────────────────┘

Technologies

Language

  • Python 3.11+ (supports 3.11, 3.12, 3.13)

Main Frameworks & Libraries

Component Library Purpose
MCP Protocol mcp Communication with LLM clients
Vector Database lancedb Embedded vector storage
Embeddings fastembed ONNX-based text vectorization (nomic-embed-v1.5-Q default)
CLI typer Command-line interface
Data Validation pydantic Schema validation
HTTP Server uvicorn + starlette Streamable HTTP (optional)
Document Parsing docling PDF/DOCX/HTML conversion (indexing only)
Text Splitting langchain-text-splitters Markdown chunking (indexing only)

Read the full file on GitHub · 540 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. yesterday First seen · 540 lines · 3,773 tokens per session scan A a2f4d4330c32

Subscribe to this mod's changes

canon AGENTS.md is an instructions file published in the GitHub repository tripcher/canon (0 stars, last pushed 5mo ago), licensed MIT. It adds 3,773 tokens to every session, about $0.0189 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.