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.
npx agentmods add instructions/juliocbm/beacon-docs/agents-mdgit clone --depth 1 https://github.com/Juliocbm/beacon-docsWhat 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 | $0.01189 | $0.01189 |
| Opus 5 | $0.00594 | $0.00594 |
| Sonnet 5 | $0.00238 | $0.00238 |
| Haiku 4.5 | $0.00119 | $0.00119 |
Grade A, and why
beacon-docs 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 2d 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.
Copies of this mod
2 near-identical copies found in the catalogue:
- beacon-docs CLAUDE.md — 98% identical, 4 lines differ
- beacon-docs GEMINI.md — 95% identical, 4 lines differ
How it starts
The opening of the file, as written. The whole thing — 62 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AGENTS.md — Documentation Convention
Read by OpenAI Codex / GitHub Copilot. Full convention:
docs/_meta/convention.md.
Universal rules
- One doc = one category. Never duplicate across folders.
- Status via folder, never filename. Closed plan →
_archive/, never*_DONE.mdor*_v2.md. - kebab-case for all filenames. No camelCase, no snake_case, no spaces.
- README required in every category folder.
- ADRs are append-only. Supersede with a new ADR; never edit an accepted one.
- Evaluations are immutable snapshots. To revise, create a new dated file.
- Plans archive to
_archive/when done. Move them, never rename. - Generated AI files (this one) must match
docs/_meta/convention.md. Runbeacon syncafter editing the convention. - Don't create folders outside the convention. Run
beacon enable <addon>or propose an ADR.
Persistence rule: Decisions live in ADRs, multi-step work lives in plans, deferred work lives in backlog, retrospection lives in evals. Chat memory is session-scoped and lost when the conversation ends. If you find yourself relying on chat memory to track a decision, plan, or follow-up — write the document instead.
Project-specific rules
operations/*.guide.md— deploy guides, admin runbooks, troubleshooting. Post-mortems go inevaluations/.
Where does X go?
| Question | Folder |
|---|---|
| "How is X done technically?" | reference/ |
| "How is the system structured?" | architecture/ |
| "Why was X decided?" | adr/ |
| "What is being built right now?" | plans/ |
| "What is on the future backlog?" | backlog/ |
| "What was the state at date X?" | evaluations/ |
| "How do I deploy/administer X?" | operations/ |
Workflow triggers — when to create documents
These are the conversational signals that should prompt you to create or update Beacon documents. Treat them as imperatives, not suggestions.
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.
- 2d ago First seen · 62 lines · 1,189 tokens per session scan A aa9ae8ebd462
beacon-docs AGENTS.md is an instructions file published in the GitHub repository Juliocbm/beacon-docs (6 stars, last pushed 3mo ago), licensed MIT. It adds 1,189 tokens to every session, about $0.0059 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.
Other instructions, from other repositories
planning-with-files AGENTS.md
AGENTS.md instructions for OthmanAdi/planning-with-files, covering agents.md — planning-with-files agent reference card, commit rules, release checklist (12 steps), version bump scope and changelog format.
DevoxxGenieIDEAPlugin GEMINI.md
Instructions for devoxx/DevoxxGenieIDEAPlugin, a project described as: DevoxxGenie is an agentic plugin for IntelliJ IDEA that uses local LLM's (Ollama, LMStudio, GPT4All, Jan and Llama.cpp) and Cloud based LLMs to help review, test, explain your project code. Latest version now also supports Spec Driven Development…
autoharness AGENTS.md
Instructions for tigerless-labs/autoharness: This repo uses Open Knowledge — collaborative markdown via MCP. .open-knowledge/config.yml (with optional /.open-knowledge/config.yml; CLI/env may override) is the path contract: content.dir is the root for relative paths; content.include lists globs that add markdown…
ESAA-Core AGENTS.md
Instructions for elzobrito/ESAA-Core, covering agents.md — contrato operacional codex/esaa, 1. autoridade e termos, 2. cli e runner, ou configure o runner uma vez por sessão and 3. concorrência.
squarebox CLAUDE.md
Instructions for SquareWaveSystems/squarebox, covering claude.md, agent skills, issue tracker, triage labels and domain docs.
mcpelevator CLAUDE.md
Instructions for pacnpal/mcpelevator, covering commands, architecture, conventions, agent skills and issue tracker.