adrkit AGENTS.md

Repository instructions for adrkit, a tool that records important software decisions in machine-readable files and can check them in CI. It also covers its command-line tools, visual decision graph, queue, and agent integrations.

In plain words
What is it for?
Use it when creating, reviewing, explaining, checking, or queuing architecture decision records (written decisions about how a system should work), including decisions enforced by automated checks.
Why use it?
It gives coding agents one shared record of project decisions and rules, reducing inconsistent plans and decisions that are hard to check or remember.

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

Made for: Codex, OpenCode.

Per session 5,493 This file is loaded in full into every session.
When invoked 5,493 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.05493 $0.05493
Opus 5 $0.02746 $0.02746
Sonnet 5 $0.01099 $0.01099
Haiku 4.5 $0.00549 $0.00549

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

Security

Grade A, and why

adrkit 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.

AGENTS.md · 374 lines

How it starts

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

adrkit

Decision memory for human- and agent-authored plans — machine-readable ADRs that are enforceable in CI and legible to agents, without leaving git. Status: early — phases 0–6 landed and v0.13.0 is public. @adrkit/core, @adrkit/evaluator, @adrkit/cli (lint, new, graph, explain, check, queue, migrate --from madr, evaluate) are published on npm, as is the independently versioned @adrkit/spec-kit Spec Kit extension (0.1.3); the repository-backed CI Action is available at mbeacom/adrkit/packages/ci@v0. The governing-decisions Action also has a root action.yml alias for GitHub Marketplace beginning with v0.13.0. Root Marketplace guidance uses immutable release tags; never advertise mbeacom/adrkit@v0, because recovery may move that shared tag to a pre-alias release. The queue Action remains nested because GitHub lists only root Action metadata. The published @adrkit/mcp server has exactly four local stdio tools and serves both MCP protocol eras over one stdio connection — 2026-07-28 (stateless; opened by server/discover or a 2026 _meta envelope) and the 2025 era (opened by initialize) — via the SDK v2 serveStdio entry (ADR-0018). It passed real-session dogfood against the published artifact on both eras, driven through the official MCP Inspector. The Inspector defaults to the 2025 era; select the modern one with "protocolEra": "modern" (or "auto") in the server's entry in the Inspector's mcp.json — there is no CLI flag for it.

Visual adr graph

adr graph preserves agent/script compatibility while giving interactive users a useful view under ADR-0033. Its default is auto: stdout attached to a TTY receives the terminal status/relationship instrument; piped, redirected, and captured stdout still receives deterministic DOT. Explicit --format terminal|dot|json|mermaid always wins. --focus <id> keeps one ADR and its direct neighborhood; repeatable --kind supersedes|relatesTo|conflictsWith filters every format.

Read the full file on GitHub · 374 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. 2d ago First seen · 374 lines · 5,493 tokens per session scan A ecaceb3bc026

Subscribe to this mod's changes

adrkit AGENTS.md is an instructions file published in the GitHub repository mbeacom/adrkit (11 stars, last pushed 3d ago), licensed Apache-2.0. It adds 5,493 tokens to every session, about $0.0275 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-30.