How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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:
CloudflareAGENTS.mdcloudflare/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.…
CloudflareAGENTS.mdcloudflare/sandbox-sdk/bridge/AGENTS.md
This directory contains a deployable Cloudflare Worker that uses @cloudflare/sandbox/bridge to expose the sandbox HTTP API. It is a thin wrapper — all route handling, authentication, pool management, and OpenAPI…
CloudflareAGENTS.mdcloudflare/sandbox-sdk/bridge/examples/basic/AGENTS.md
This directory contains a single-file uv script (main.py) that demonstrates the OpenAI Agents SDK with a Cloudflare Sandbox backend. - Single file: everything lives in main.py with inline # ///…
CloudflareAGENTS.mdcloudflare/sandbox-sdk/bridge/examples/workspace-chat/AGENTS.md
This directory contains a two-process workspace chat demo: a Python backend and a React frontend. - Framework: Starlette (not FastAPI) served with uvicorn. - Dependencies: managed via uv with pyproject.toml.…
CloudflareAGENTS.mdcloudflare/sandbox-sdk/bridge/harness/AGENTS.md
Agent-driven QA test harness for the cloudflare-sandbox-bridge Cloudflare Worker. Uses the OpenAI Agents SDK (openai-agents[cloudflare]) to exercise sandbox exec, file I/O, process management, and session persistence against a production deployment.
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/artifact-fs/AGENTS.md
Repository-specific guidance for artifact-fs.
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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.
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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…
CloudflareAGENTS.mdcloudflare/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,…
CloudflareAGENTS.mdcloudflare/telescope/AGENTS.md
@cloudflare/telescope is a TypeScript browser performance testing library and CLI built on Playwright. It launches real browsers (Chrome, Chrome Beta, Canary, Firefox, Safari, Edge), collects HAR files, Web Vitals, and…
CloudflareAGENTS.mdcloudflare/telescope/packages/telescope/AGENTS.md
@cloudflare/telescope is a TypeScript browser performance testing library and CLI built on Playwright. It launches real browsers (Chrome, Chrome Beta, Canary, Firefox, Safari, Edge), collects HAR files, Web Vitals, and…
An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.
At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.
Setup and test commands, code style, and the rules a new contributor would need to know.
Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.
