agents AGENTS.md

Repository instructions for Cloudflare Agents, a framework for building stateful AI agents on Cloudflare Workers. They describe the project layout, setup, and rules in nested instruction files.

In plain words
What is it for?
Use them when changing the SDK, examples, guides, websites, or documentation. They are also useful for deciding when package changes need a changeset and which deeper instructions apply.
Why use it?
They help a coding agent find the right package or example and follow the repository’s local rules. This reduces incorrect changes caused by misunderstanding the monorepo structure.

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

Made for: Codex, OpenCode.

Per session 2,131 This file is loaded in full into every session.
When invoked 2,131 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.02131 $0.02131
Opus 5 $0.01066 $0.01066
Sonnet 5 $0.00426 $0.00426
Haiku 4.5 $0.00213 $0.00213

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

Security

Grade A, and why

agents 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 yesterday.

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 · 197 lines

How it starts

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

AGENTS.md

Project overview

Cloudflare Agents SDK — a framework for building stateful AI agents on Cloudflare Workers. This is a monorepo containing the core SDK packages, examples, guides, sites, and documentation.

Repository structure

packages/          # Published npm packages (need changesets for changes)
  agents/          # Core SDK (see packages/agents/AGENTS.md)
  ai-chat/         # @cloudflare/ai-chat — higher-level AI chat agent
  hono-agents/     # Hono framework integration
  codemode/        # @cloudflare/codemode — experimental code generation

examples/          # Self-contained demo apps (see examples/AGENTS.md)
  playground/      # Main showcase app — all SDK features in one UI (uses Kumo design system)
  mcp/             # MCP server example
  mcp-client/      # MCP client example
  ...              # ~20 examples total

experimental/      # Work-in-progress experiments (not published, no stability guarantees)

site/              # Deployed websites
  agents/          # agents.cloudflare.com (Astro)
  ai-playground/   # Workers AI playground (React + Vite)

guides/            # In-depth pattern tutorials with narrative READMEs (see guides/AGENTS.md)
  anthropic-patterns/
  human-in-the-loop/

openai-sdk/        # Examples using @openai/agents SDK
  basic/ chess-app/ handoffs/ human-in-the-loop/ ...

docs/              # Markdown docs for developers.cloudflare.com (see docs/AGENTS.md)
design/            # Architecture and design decision records (see design/AGENTS.md)
scripts/           # Repo-wide tooling (typecheck, export checks, update checks)

Nested AGENTS.md files

Some directories have their own AGENTS.md with deeper guidance:

File Scope
packages/agents/AGENTS.md Core SDK internals — exports, source layout, build, testing, architecture
examples/AGENTS.md Example conventions — required structure, consistency rules, known issues
guides/AGENTS.md Guide conventions — how guides differ from examples, README expectations
docs/AGENTS.md Writing user-facing docs — Diátaxis framework, upstream sync, style
design/AGENTS.md Design records and RFCs — format, workflow, relationship to docs

Read the full file on GitHub · 197 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. yesterday First seen · 197 lines · 2,131 tokens per session scan A ddb2ad5f8953

Subscribe to this mod's changes

agents AGENTS.md is an instructions file published in the GitHub repository cloudflare/agents (5,498 stars, last pushed 2d ago), licensed MIT. It adds 2,131 tokens to every session, about $0.0107 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.