agentleFS
Sign inSign up

AGENTS.md examples from real projects

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

Most stars first · from page 5Worked 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:

3.9k2mo agoDiscuss
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.1k9mo agoDiscuss
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.1k9mo agoDiscuss
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.

2.1k9mo agoDiscuss
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.1k9mo agoDiscuss
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…

1.9k6d agoDiscuss
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.7k4mo agoDiscuss
CloudflareAGENTS.md

foundations

cloudflare/foundations/AGENTS.md

- UserSpan::deferred() creates a stable request root that can be captured by telemetry contexts before activate() makes the sampling decision. - TelemetryContext::withuserspan() 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 under the write lock; the first active span wins, while inactive results remain retryable. - Recording and children created before activation are inactive. Contexts that…

1.7k14d agoDiscuss
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:

1.3k7mo agoDiscuss
CloudflareAGENTS.md

sandbox-sdk

cloudflare/sandbox-sdk/AGENTS.md

This file provides guidance for AI coding assistants working with this repository. Always consult Cloudflare documentation when working on this repository. Key topics: Use the gh CLI for GitHub interactions.…

1.1k4mo agoDiscuss
CloudflareAGENTS.md

sandbox-sdk / control-plane

cloudflare/sandbox-sdk/packages/sandbox-container/src/control-plane/AGENTS.md

This directory is the primary home for container-side control API methods used by the Sandbox Durable Object. Add control operations here. Use service methods directly rather than routing through HTTP…

1.1k4mo agoDiscuss
CloudflareAGENTS.md

sandbox-sdk / bridge

cloudflare/sandbox-sdk/packages/sandbox/src/bridge/AGENTS.md

The bridge is the library layer that powers @cloudflare/sandbox/bridge. It provides a bridge() factory that wraps a user's Worker with sandbox API routes, warm pool management, and authentication — all…

1.1k4mo agoDiscuss
CloudflareAGENTS.md

sandbox-sdk / transport

cloudflare/sandbox-sdk/packages/sandbox/src/clients/transport/AGENTS.md

This directory is compatibility-only for the HTTP and custom WebSocket route-based API. Do not add transport-layer capabilities here unless the task explicitly requires HTTP/WebSocket compatibility maintenance. DO-to-container control-channel work belongs…

1.1k4mo agoDiscuss
CloudflareAGENTS.md

sandbox-sdk / container-control

cloudflare/sandbox-sdk/packages/sandbox/src/container-control/AGENTS.md

This directory is the primary home for Sandbox Durable Object to container control-channel code. Use role-based names such as ContainerControlClient, ContainerControlConnection, and SandboxControlAPI. Treat capnweb/RPC as an implementation detail unless…

1.1k4mo agoDiscuss
CloudflareAGENTS.md

artifact-fs

cloudflare/artifact-fs/AGENTS.md

Repository-specific guidance for artifact-fs.

1.1k6mo agoDiscuss
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 must validate against docsSchema from nimbus-docs/schemas. Required: title. The schema includes optional fields for description, sidebar overrides, drafts, dates, edit-link suppression — read the schema for the…

1k16d agoDiscuss
CloudflareAGENTS.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: Node 22+ required.

8917d agoDiscuss
CloudflareAGENTS.md

chanfana

cloudflare/chanfana/AGENTS.md

Chanfana is an OpenAPI 3/3.1 schema generator and request validator for Hono and itty-router on Cloudflare Workers. It uses Zod v4 for schemas and provides auto CRUD endpoints with D1 support. Tests run inside @cloudflare/vitest-pool-workers with a real D1 binding. Config: tests/vitest.config.mts. Formatter/Linter: Biome (biome.json). Key settings: - 2-space indent, 120 char line width, double quotes, always semicolons, trailing commas on multiline - noExplicitAny is OFF — any is used deliberately throughout TypeScript (tsconfig.json): strict: true, verbatimModuleSyntax: true (requires import…

7667mo agoDiscuss
CloudflareAGENTS.md

chanfana / template

cloudflare/chanfana/template/AGENTS.md

A starter Cloudflare Worker using Chanfana (OpenAPI), Hono, D1, and Zod v4. This is a copyable template — users clone it and build on top. Tests use @cloudflare/vitest-pool-workers with a local miniflare D1 binding. Config: vitest.config.mts. Follow the same conventions as the parent chanfana library: - 2-space indent, double quotes, always semicolons - import type for type-only imports (verbatimModuleSyntax: true) - Classes: PascalCase — endpoint classes named after their action (TaskCreate, TaskList) - Named exports everywhere, no default exports (except…

7667mo agoDiscuss
CloudflareAGENTS.md

speedtest

cloudflare/speedtest/AGENTS.md

Browser-side TypeScript library (@cloudflare/speedtest) that measures connection quality against Cloudflare's edge. Powers speed.cloudflare.com. Uses Vitest with two test projects: - Unit tests (tests/unit/*/.test.ts) — pure function tests for utils, config, and Results. Run in Node, no browser needed. Fast. - E2E tests (tests/e2e/*.test.ts) — runs a realistic speed test in a real Chromium browser via Vitest Browser Mode + Playwright. Tests the full library integration (fetch, PerformanceResourceTiming, module loading) with multiple measurement phases (latency, download, upload), loaded latency, AIM scoring,…

74537d agoDiscuss
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.