agent-ready AGENTS.md

Repository instructions for agent-ready, a TypeScript tool that prepares repositories for work by coding agents. They describe the project structure, supported commands, and the checks used to verify the tool.

In plain words
What is it for?
Use them when developing or maintaining agent-ready, especially when changing its scanner, checks, command-line interface, or tests.
Why use it?
They give agents the project-specific rules needed to make safe, consistent changes. They also explain how to run tests, type checks, linting, formatting, and builds.

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

Made for: Codex, OpenCode.

Per session 1,381 This file is loaded in full into every session.
When invoked 1,381 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.01381 $0.01381
Opus 5 $0.00691 $0.00691
Sonnet 5 $0.00276 $0.00276
Haiku 4.5 $0.00138 $0.00138

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

Security

Grade A, and why

agent-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 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 · 183 lines

How it starts

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

AGENTS.md - AI Agent Instructions

Instructions for AI agents working with the agent-ready codebase.

Project Overview

agent-ready is a repo infrastructure setup tool for agent-guided development. One command to make any repo agent-ready — everything except the code.

Version: 0.1.0 Language: TypeScript Runtime: Node.js >= 20

Quick Commands

npm install                    # Install dependencies
npm run dev -- scan .          # Scan current directory
npm test                       # Run tests (152 tests)
npm run test:coverage          # Coverage with c8
npm run typecheck              # Type check (tsc --noEmit)
npm run lint                   # ESLint
npm run format                 # Prettier
npm run check                  # All gates: typecheck + lint + format
npm run build                  # Build for production

Project Structure

agent-readiness/
├── src/
│   ├── index.ts           # CLI entry (Commander.js)
│   ├── scanner.ts         # Main orchestrator
│   ├── types.ts           # TypeScript interfaces
│   ├── checks/            # Check implementations
│   │   ├── index.ts       # Check registry
│   │   ├── file-exists.ts
│   │   ├── path-glob.ts
│   │   ├── any-of.ts
│   │   ├── github-workflow.ts
│   │   ├── github-action.ts
│   │   ├── build-command.ts
│   │   ├── log-framework.ts
│   │   └── dependency-detect.ts
│   ├── engine/
│   │   ├── index.ts       # Execution engine
│   │   ├── level-gate.ts  # Level gating logic
│   │   └── context.ts     # Scan context
│   ├── output/
│   │   ├── json.ts        # JSON output
│   │   └── markdown.ts    # Terminal output
│   ├── profiles/
│   │   └── index.ts       # Profile loader
│   ├── commands/
│   │   └── init.ts        # Init command
│   └── utils/
│       ├── fs.ts
│       ├── git.ts
│       └── yaml.ts
├── profiles/
│   └── factory_compat.yaml # Default profile (35+ checks)
├── templates/              # Init command templates
├── skill/                  # Claude Code skill
│   └── agent-ready/
│       └── SKILL.md
├── docs/
│   └── index.html         # Landing page
├── test/
│   ├── *.test.ts
│   ├── fixtures/
│   └── VALIDATION_REPORT.md
└── agent-ready.skill      # Packaged skill

Read the full file on GitHub · 183 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 · 183 lines · 1,381 tokens per session scan A 016ebb0b603f

Subscribe to this mod's changes

agent-ready AGENTS.md is an instructions file published in the GitHub repository agent-next/agent-ready (27 stars, last pushed 3mo ago), licensed MIT. It adds 1,381 tokens to every session, about $0.0069 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.

Related

Other instructions, from other repositories