Borrowing it
Nothing to install: this file belongs to johnpapa/ai-ready. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/johnpapa/ai-ready/main/AGENTS.mdgit clone --depth 1 https://github.com/johnpapa/ai-readyWrote 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.
[](https://agentmods.dev/instructions/johnpapa/ai-ready/agents-md)<a href="https://agentmods.dev/instructions/johnpapa/ai-ready/agents-md"><img src="https://agentmods.dev/badge/instructions/johnpapa/ai-ready/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/johnpapa/ai-ready/agents-md"><img src="https://agentmods.dev/badge/instructions/johnpapa/ai-ready/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.02176 | $0.02176 |
| Opus 5.5 | $0.00870 | $0.00870 |
| Sonnet 5.5 | $0.00435 | $0.00435 |
| Haiku 4.5 | $0.00218 | $0.00218 |
Grade A, and why
ai-ready 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 1mo 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.
How it starts
The opening of the file, as written. The whole thing — 148 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AI-Ready Repo — Agent Guide
This is an Agent Skill — not a traditional application. The deliverable is a skill definition
(SKILL.md) that teaches an AI coding agent how to make any repository AI-ready. There is nothing to compile
and nothing to ship a binary from.
There is code, though, and it has to pass before you push: a small Python validation harness under tools/
and tests/ that checks the skill's detection data against fixture repos. See § Testing.
The skill follows the vendor-neutral Agent Skills standard, so one canonical
skills/ai-ready/SKILL.md is consumed by GitHub Copilot, Claude Code, OpenAI Codex, and Cursor. Each tool gets
its own thin manifest that points at that same directory — never duplicate the skill content.
Repository Structure
Conventional where you'd expect: skills/ai-ready/ holds the skill, docs/ the prose, tests/ and tools/
the validation harness, evals/ the manual rubric. Run ls for the rest.
The part that is not guessable, and that CI enforces:
Six files carry a version and all six must agree — skills/ai-ready/SKILL.md (metadata.version, the
source of truth), plugin.json, .github/plugin/plugin.json, .claude-plugin/plugin.json,
.codex-plugin/plugin.json, and .claude-plugin/marketplace.json (nested under plugins[0]). There is also
.agents/plugins/marketplace.json, which carries no version. Bumping one and not the rest is the most common
way to fail the build.
Packaging Model
One canonical skills/ai-ready/SKILL.md; every tool gets a thin manifest pointing at that same directory.
Never duplicate the skill content. Details of each tool's manifest: docs/authoring.md.
Tech Stack
- Content format: Markdown, YAML, JSON — this is a documentation-driven project
- No build system and nothing to compile. The repo ships files agents read directly
- Validation harness: Python 3 with
pyyaml, undertools/andtests/. Dependency-free otherwise — no framework, no test runner.tests/test_detection.pyis a plain script that exits non-zero
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.
- 1mo ago Changed · -185 tokens per session 349a39204e5a
- 1mo ago Changed · +1 lines · +327 tokens per session b6ca98d9999e
- 1mo ago Changed · +45 lines · +891 tokens per session 40c1d91cd8e2
- 1mo ago First seen · 102 lines · 1,143 tokens per session scan A 9ce7960b9c63
ai-ready AGENTS.md is an instructions file published in the GitHub repository johnpapa/ai-ready (233 stars, last pushed 27d ago), licensed MIT. It adds 2,176 tokens to every session, about $0.0087 per session on Opus 5.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.
Other instructions, from other repositories
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).
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.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
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.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deepseek-harness AGENTS.md
AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.