agent-ready-repo AGENTS.md

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

A root AGENTS.md instruction file for AI coding assistants such as Codex, Claude Code, Cursor, or Copilot. It explains the project, maps a monorepo—a repository containing multiple apps and shared packages—and defines rules for changes.

In plain words
What is it for?
Use it to document the project overview, list applications and packages, record their technologies and owners, and direct assistants to more specific instructions.
Why use it?
It gives an assistant one starting point for understanding the codebase and reduces mistakes caused by missing project-specific rules.

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

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-repo AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/syntaxway/agent-ready-repo/agents-md.svg)](https://agentmods.dev/instructions/syntaxway/agent-ready-repo/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/syntaxway/agent-ready-repo/agents-md"><img src="https://agentmods.dev/badge/instructions/syntaxway/agent-ready-repo/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,310 This file is loaded in full into every session.
When invoked 1,310 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.01310 $0.01310
Opus 5 $0.00655 $0.00655
Sonnet 5 $0.00262 $0.00262
Haiku 4.5 $0.00131 $0.00131

Measured 4d ago against content hash 94efdf314f29, 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-repo 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 4d 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 · 98 lines

How it starts

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

AGENTS.md — AI Agent Instructions (Root)

This file is the single entry point for AI coding agents (Claude Code, Cursor, Copilot, Codex, Gemini, Windsurf, Cline, Aider, etc.). Read this FIRST before making any changes. Each app/package may have its own nested AGENTS.md with more specific rules — the nearest AGENTS.md to the file you're editing wins. Tool-specific pointer files (CLAUDE.md, GEMINI.md, .clinerules, .cursor/rules/, .windsurf/rules/, .github/copilot-instructions.md, .aider.conf.yml) all redirect here — shared rules belong in this file, never in the pointers.

1. Project Overview (one paragraph, keep it current)

[PROJECT_NAME] is a [type of product] that [core value proposition] for [target users]. The monorepo contains [N] deployable apps and [N] shared packages.

2. Monorepo Map

Path What it is Tech Owner
apps/web Customer-facing web app Next.js 15, TypeScript @team-frontend
apps/api REST/GraphQL backend Node.js, Fastify @team-backend
packages/ui Shared component library React, Tailwind @team-frontend
packages/core Domain logic, shared types TypeScript (no framework deps) @team-backend
packages/config Shared ESLint/TS/Tailwind configs @team-platform
infra/ IaC, Docker, K8s manifests Terraform, Helm @team-devops

Dependency rule: apps/* may depend on packages/*. Packages may NOT depend on apps. packages/core must stay framework-free.

3. Golden Commands (always use these — never invent your own)

pnpm install              # install all workspace deps
pnpm dev                  # run all apps in dev mode
pnpm dev --filter web     # run one app
pnpm build                # build everything
pnpm test                 # run all tests
pnpm test --filter core   # test one package
pnpm lint                 # lint + typecheck
pnpm format               # auto-format (Prettier)

Read the full file on GitHub · 98 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. 4d ago First seen · 98 lines · 1,310 tokens per session scan A 94efdf314f29

Subscribe to this mod's changes

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

Related

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

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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,345 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js 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,296 tokens