book AGENTS.md

A repository instruction file for a Chinese technical guide about working with coding agents. It defines the project's audience, writing style, content rules, examples, and link and code checks.

In plain words
What is it for?
Use it when writing or editing chapters, examples, Markdown links, code blocks, and other documentation in the book project.
Why use it?
It helps the agent produce consistent, practical documentation that follows the book's editorial and verification 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/aipmer/book/agents-md
Clone the repo
git clone --depth 1 https://github.com/aipmer/book

Made for: Codex, OpenCode.

Per session 654 This file is loaded in full into every session.
When invoked 654 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.00654 $0.00654
Opus 5 $0.00327 $0.00327
Sonnet 5 $0.00131 $0.00131
Haiku 4.5 $0.00065 $0.00065

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

Security

Grade A, and why

book 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 · 51 lines

What it actually says

🤖 Codex 协作协议 (Codex Collaboration Protocol - CAP)

🌐 English Version

📌 项目指纹

  • 项目名称:Codex 蓝皮书
  • 项目类型:Markdown 指南 / 电子书项目
  • 写作风格:专业、精炼、技术密度高、易读的中文,伴以恰当的格式与图表。
  • 引用规范:链接必须使用 file:/// 格式的绝对路径(例如:[link text](file:///Users/hunkwu/Desktop/ai/book/README.md))。

🎯 目标受众

  • 希望利用 AI 智能体(尤其是 OpenAI Codex)进行高效开发的专业开发者。
  • 想要自主构建商业级 MVP 的独立黑客与创业者。

🛑 约束红线

  • 严禁使用占位符:必须提供真实、可运行的示例代码和配置。
  • 注重实操:每个章节必须包含逐步的代码片段、命令行执行或配置文件模版。
  • 链接完整:确保各章节之间的链接引用正确,无死链。
  • 杜绝冗长摘要:避免重复内容;专注于可落地的洞察、心智模型和步骤演练。

🧪 验证标准

  • 所有 Markdown 文件必须语法正确,且链接到真实存在的目标路径。
  • 所有代码块必须带有正确的语言标签(例如:```bash, ```markdown, ```json)。


🌐 English Version

🤖 Codex Collaboration Protocol (CAP)

📌 Project Signature

  • Project Name: Codex Blue Book
  • Framework: Markdown Guide / Book Project
  • Coding Style: Professional, concise, tech-rich, easy-to-read Chinese with proper formatting and diagrams.
  • Reference Style: Links should be absolute paths with file:/// scheme (e.g. [link text](file:///Users/hunkwu/Desktop/ai/book/README.md)).

🎯 Target Audience

  • Professional developers looking to leverage AI agents (especially OpenAI Codex) for high-efficiency development.
  • Indie Hackers / Entrepreneurs wanting to build commercial-grade MVPs autonomously.

🛑 Hard Constraints

  • Do not use placeholders: Always provide real, functional examples and configurations.
  • Keep it practical: Every chapter must contain step-by-step code snippets, command executions, or configuration templates.
  • Preserve Links: Ensure all links between chapters are correctly referenced.
  • No verbose summaries: Avoid repeating contents; focus on actionable insights, mental models, and step-by-step walkthroughs.

🧪 Verification Specs

  • All markdown files must be syntactically valid and link to actual target paths.
  • Code blocks must have language tags (e.g. ```bash, ```markdown, ```json).
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 · 51 lines · 654 tokens per session scan A ed0350b82595

Subscribe to this mod's changes

book AGENTS.md is an instructions file published in the GitHub repository aipmer/book (53 stars, last pushed 15d ago), licensed Apache-2.0. It adds 654 tokens to every session, about $0.0033 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

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

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

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

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

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

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