agentleFS

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Worked for most · soon
CloudflareAGENTS.md

kumo / components

cloudflare/kumo/packages/kumo/src/components/AGENTS.md

39 UI components. Base UI primitives + Tailwind v4 styling. Compound component pattern throughout. Parent: See packages/kumo/AGENTS.md for library context. Each component follows: {name}/{name}.tsx + optional {name}.test.tsx, {name}.browser.test.tsx Every component file MUST export (lint-enforced by enforce-variant-standard): 13 components use this pattern: Input, Select, Combobox auto-wrap with Field when label prop provided:

Steady20 mentions in 2 weeks

No other project uses it yet

4.2k4mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

capnweb / packages

cloudflare/capnweb/packages/docs/AGENTS.md

Astro, with Nimbus (@cloudflare/nimbus-docs) as the docs framework. The package handles content schemas, sidebar/TOC, MDX to markdown, search, OG cards, llms.txt, build hooks, and the nimbus-docs CLI. Everything in src/ is a real file in this repo and yours to edit, including the files the scaffold wrote. README.md next to this file explains why the site looks and works the way it does: the palette, the page shell, the WebGL hero, the example playgrounds, the traps. Read it before changing…

4k52d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

templates

cloudflare/templates/AGENTS.md

This guide helps AI agents review, maintain, and contribute to Cloudflare Worker templates. It documents patterns, common issues, and testing strategies learned from real PR reviews. When reviewing a template PR, verify these items in order: Symptom: Template linter fails with missing description error. Fix: Add a one-line description to package.json: Symptom: Dashboard won't display template details correctly. Fix: Add markers around the content that should appear in Cloudflare Dashboard: Important: The Deploy to Cloudflare button should be at the…

2.2k10mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

templates / agent-visibility-template

cloudflare/templates/agent-visibility-template/AGENTS.md

Notes for AI agents working on this template. One enriched content store (Resource[]) projected onto many agent-discovery surfaces. The data is enriched once by Workers AI and cached in KV; every surface (/llms.txt, /index.json, /<slug>.md, /robots.txt, JSON-LD) is just a different rendering of that same store. - surfaces.ts is pure. Render functions take RenderCtx and return strings/objects. No I/O. This keeps surfaces easy to test and add to. - Enrichment must never hard-fail. enrichResource falls back to fallbackEnrichment on any…

2.2k10mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

templates / ai-brand-visibility-template

cloudflare/templates/ai-brand-visibility-template/AGENTS.md

A Worker template that tests whether AI models (GPT-5.4, Claude Sonnet 4, Gemini 3 Flash, Llama 4, Mistral) mention your brand when answering relevant queries. All models run through Cloudflare AI Gateway — no external API keys needed.

No other project uses it yet

2.2k10mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

templates / x402-proxy-template

cloudflare/templates/x402-proxy-template/AGENTS.md

Context for AI coding agents to help users set up x402-proxy for payment-gated content. A Cloudflare Worker that adds payment gating to any origin using the x402 protocol. Users pay to access protected routes, then get a JWT cookie valid for 1 hour. With Bot Management Filtering: Requires Bot Management for Enterprise to enable bot filtering. With it enabled, x402-proxy can implement "default closed" - humans pass through free, only bots must pay. This is optional and enhances the base…

2.2k10mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

workers-oauth-provider

cloudflare/workers-oauth-provider/AGENTS.md

@cloudflare/workers-oauth-provider is a production-grade OAuth 2.1 provider library for Cloudflare Workers. It implements authorization code flow with PKCE, OAuth discovery, client registration, token exchange, audience validation, and encryption of sensitive data stored in KV. Primary use case: This library powers authorization for MCP (Model Context Protocol) servers. MCP servers are OAuth Resource Servers, and this library provides both protected-resource middleware and the authorization server functionality needed to secure them. This library was largely written with Claude AI assistance, with all…

Steady9 mentions in 2 weeks

No other project uses it yet

1.9k24d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

nimbus / www

cloudflare/nimbus/apps/www/AGENTS.md

Agent-facing context. If you're picking up work on this site, start here. Astro-based docs site. The nimbus-docs package provides the integration, content schemas, navigation/sidebar/TOC computation, MDX→markdown rendering, build hooks, and the nimbus CLI. Everything you see in src/ is user-owned and yours to edit. For Cloudflare deploys, also: wrangler.jsonc at project root. Frontmatter validates against the schema from docsCollection() (@cloudflare/nimbus-docs/content). Required: title. The schema includes optional fields for description, sidebar overrides, drafts, dates, edit-link suppression — read docsSchema in @cloudflare/nimbus-docs/schemas…

Steady11 mentions in 2 weeks

No other project uses it yet

1.8k31d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

circl

cloudflare/circl/AGENTS.md

CIRCL is an experimental, externally visible Go cryptographic library. Consumers include Cloudflare's Go fork, downstream modules, and external researchers. Every change is security-sensitive. The README disclaims API stability — the…

1.7k5mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

foundations

cloudflare/foundations/AGENTS.md

- Telemetry scope stacks must use std::thread_local! through ScopeStack; do not replace them with thread_local::ThreadLocal, whose metadata can cause false sharing on these hot paths. - UserSpan::deferred() creates a stable request root that can be captured by telemetry contexts before activate() makes the sampling decision. - TelemetryContext::with_user_span() attaches an explicit UserSpan without changing ambient scope; the returned context and handle share the same underlying span. - A deferred root is an inactive span in a shared RwLock. Activation replaces it…

1.7k11d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

partykit

cloudflare/partykit/AGENTS.md

This document provides essential information for AI coding agents working in the PartyServer monorepo. PartyServer is a monorepo using npm workspaces with multiple packages:

Steady2 mentions in 2 weeks

No other project uses it yet

1.3k9mo agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

forge

cloudflare/forge/AGENTS.md

API documentation site for Forge OpenAPI specs, built on Astro. Never publish links to Cloudflare-internal systems (anything behind Cloudflare's network or login) in files, commits, branch names, or PR and issue text. Bare ticket IDs (FORGE-1) are fine. A pushed link stays in history even after a later commit removes it: tell the maintainers.

No other project uses it yet

1.2k10d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

artifact-fs

cloudflare/artifact-fs/AGENTS.md

Repository-specific guidance for artifact-fs.

Steady8 mentions in 2 weeks

No other project uses it yet

1.1k8mo agoReviewMountCreate a free account to mount
CloudflareReads credentialsAGENTS.md

mcp

cloudflare/mcp/AGENTS.md

cloudflare-mcp is a token-efficient Model Context Protocol (MCP) server that exposes the entire Cloudflare API (~2,500 endpoints) using Cloudflare's Code Mode pattern. Instead of registering thousands of MCP tools, it uses just two tools (search and execute) that let agents write JavaScript to query the OpenAPI spec and call APIs — fitting all 2,500 endpoints into ~1,000 tokens. Production URL: mcp.cloudflare.com When modifying MCP or OAuth functionality, always check the latest published MCP specification:

1.1k9d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cf

cloudflare/cf/AGENTS.md

This repository contains the public cf npm CLI and its command generator. cf is an agent-first CLI for the whole Cloudflare API. Shared Forge code is installed from a commit-pinned pkg.pr.new build until it is available on npm. - CLI instructions: command, generator, dotenv, child-process, and runtime conventions when working in packages/cli/. - Wrangler test instructions: parity classification and generated test inventory rules. - Architecture reference: detailed layout, library map, generator behavior, UX, flags, dependency updates, and publishing. Read the…

Steady7 mentions in 2 weeks

No other project uses it yet

1k10d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cf / cli

cloudflare/cf/packages/cli/AGENTS.md

Cloudflare CLI. Yargs-based, TypeScript, ESM, Node ≥ 22. This package IS the CLI. It also owns the generator that produces its per-API command surface: the forge plugin in generator/plugin/, which forge runs (--target wasm://...) to write src/commands/_generated/. The cross-cutting runtime (src/index.ts and generic helpers under src/lib/) must remain a generic shell over whatever commands the generator emits into src/commands/_generated/. Product-specific behavior belongs in Forge unless it is one of the deliberately bounded hand-written exceptions below or the universal zone-name resolver…

Steady7 mentions in 2 weeks

No other project uses it yet

1k10d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cf / wrangler-tests

cloudflare/cf/packages/wrangler-tests/AGENTS.md

This package runs canonical Wrangler test situations against cf. The pinned revision, inventory shape, and regeneration command are documented in README.md; MANIFEST.md is the generated inventory. - Upstream test names and describe() ancestry are canonical identities. Do not rename or delete them when adapting command paths or assertions for cf. - A passing test is executable parity evidence. Use it.todo() when the behavior belongs in cf but is not working or ported yet. Use it.skip() only for Wrangler internals or…

Steady7 mentions in 2 weeks

No other project uses it yet

1k10d agoReviewMountCreate a free account to mount
CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.