agentmods.dev

agent-ready: Instructions file for Codex

AGENTS.md

agent-ready AGENTS.md is an instructions file for Codex, OpenCode from EShener/agent-ready. It costs 550 tokens per session, scanned A, original, MIT.

Repository instructions for Agent Ready, a local command-line tool that scans projects, creates agent instruction files, checks them, and measures how prepared a repository is for coding agents.

In plain words
What is it for?
Use them when working on the Agent Ready repository, especially for its scanner, generator, linter, reports, workflows, and related command-line features.
Why use it?
They give an agent the project’s purpose, layout, runtime, and working conventions in one place. This reduces the chance of using the wrong commands or changing code inconsistently.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is EShener/agent-ready's own configuration. It tells Codex and OpenCode how to work on agent-ready itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything agent-ready configures →

not rated 1repo 4mo ago A scan 550 tokens original MIT
View source ↗ EShener/agent-ready
Reuse

Borrowing it

Nothing to install: this file belongs to EShener/agent-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.

Copy the file
curl -O https://raw.githubusercontent.com/EShener/agent-ready/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/EShener/agent-ready

Made for: Codex, OpenCode.

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

agentmods badge for agent-ready AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/eshener/agent-ready/agents-md/github.svg)](https://agentmods.dev/instructions/eshener/agent-ready/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/eshener/agent-ready/agents-md"><img src="https://agentmods.dev/badge/instructions/eshener/agent-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.

agentmods 80×15 button for agent-ready AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/eshener/agent-ready/agents-md"><img src="https://agentmods.dev/badge/instructions/eshener/agent-ready/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 550 This file is loaded in full into every session.
When invoked 550 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00550 $0.00550
Opus 5.5 $0.00220 $0.00220
Sonnet 5.5 $0.00110 $0.00110
Haiku 4.5 $0.00055 $0.00055

Measured 1mo ago against content hash c1a52eee0d1a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 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.

AGENTS.md · 50 lines

How it starts

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

AGENTS.md

Project Overview

  • Name: agent-ready
  • Primary language: JavaScript
  • Runtime: Node.js 20+ ESM
  • Purpose: local-first CLI for scanning repositories, generating agent instruction files, linting them, and scoring agent readiness.

Repository Layout

  • bin/agent-ready.mjs: CLI executable.
  • src/scanner.mjs: repository profiling and command detection.
  • src/benchmark.mjs: multi-repository score aggregation and benchmark data.
  • src/comment.mjs: shareable PR/issue comment data generation.
  • src/compare.mjs: before/after readiness JSON comparison.
  • src/generator.mjs: AGENTS.md and tool-specific shim generation.
  • src/linter.mjs: readiness rules and scoring inputs.
  • src/matrix.mjs: AI coding agent compatibility matrix generation.
  • src/reporter.mjs: text, JSON, and Markdown output rendering.
  • src/config.mjs: optional agent-ready.json loading and validation.
  • src/explainer.mjs: impact-ranked fix plan data for explain.
  • src/interactive.mjs: guided setup prompts for init --interactive.
  • src/workflow.mjs: GitHub Actions workflow generation and write-mode support.
  • scripts/benchmark-sample.mjs: optional public repository benchmark runner.
  • test/: Node test suite and repository fixtures.

Commands

  • install: npm install
  • test: npm test
  • lint: npm run lint
  • check: npm run check

Agent Workflow

  • Read this file and README.md before editing.
  • Keep the CLI zero-dependency unless there is a strong reason to add a package.
  • Preserve deterministic output for tests and fixture snapshots.
  • Prefer small rule additions over broad rewrites of scanner behavior.

Safety Boundaries

  • Do not modify generated dependency folders such as node_modules, coverage, dist, or build.
  • Do not rewrite unrelated files or revert user changes.
  • Do not add network calls, telemetry, or API-key requirements to the default path.
  • Ask before publishing, tagging, deleting files, or changing package ownership metadata.

Read the full file on GitHub · 50 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. 1mo ago First seen · 50 lines · 550 tokens per session scan A c1a52eee0d1a

Subscribe to this mod's changes

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

Building agentsClaude Codeai-agentsclicodexcopilotcursor
Related

Other instructions, from other repositories

plugin-files-mode

Rosetta Plugin Mode Bootstrap.

griddynamics/rosetta · 236 tokens

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

microsoft/vscode · 9,715 tokens

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.

vercel/next.js · 7,461 tokens

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

microsoft/vscode · 5,262 tokens

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.

langchain-ai/langchain · 4,680 tokens

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

microsoft/vscode · 2,731 tokens