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

cloudflare-os / gatekeeper-x

cloudflare/cloudflare-os/packages/gatekeeper-x/AGENTS.md

X (formerly Twitter) — account / post / List / read-only profile resources over plain fetch (the twitter-api-v2 package breaks on Workers). plans/x-gatekeeper.md is the design record. X's API is pay-per-use and bills every resource a read returns, so cost is part of the design and easy to undo by accident: - Every read goes through the gatekeeper's #read, which reserves against the connection's daily read limit (X_DAILY_READ_LIMIT, counted per UTC day in the UserAccount DO across all of the…

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / mcp-shared

cloudflare/cloudflare-os/packages/mcp-shared/AGENTS.md

The shared implementation behind the two MCP gatekeepers — gatekeeper-mcp (endpoints a user pastes) and gatekeeper-mcp-portal (one admin-configured portal). Not a Worker; a library both import, holding the MCP client, the OAuth chain, the account DO base, the resource-URL scope grammar, and the queued-action store. See README.md and each connector's README. - The trust boundary is tools.ts, and nothing outside it reads a tool's annotations: a tool the server declares readOnlyHint: true runs as an observation, everything else is queued…

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / observability

cloudflare/cloudflare-os/packages/observability/AGENTS.md

@gadgets/observability: server-side logging, issue reporting and usage metrics. Frontend browser console.* is out of scope, and frontend error reporting is packages/error-reporting/AGENTS.md. Server-side logging uses @gadgets/observability/logger: - Define a package-owned field type and module-scoped logger with a stable dot-separated component and, for gatekeepers, vendorId: const logger = createLogger<GitHubLogFields>({ component: "gatekeeper.github", vendorId: VENDOR_ID });. - Emit concrete event names and relevant typed fields, for example: logger.warn("failed to notify credential expiry", { event: "credentials.expiry.notify.failed", error: err });. Each call emits one indexed object;…

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / ui

cloudflare/cloudflare-os/packages/ui/AGENTS.md

@gadgets/ui is the shared runtime React UI layer for the Workshop and gatekeeper management apps. Kumo owns low-level controls and semantic tokens; this package owns reusable Gadgets interaction patterns and composed components. - Add a component here when at least two independent frontends need the same feature-independent behavior or when consistency across those frontends is an explicit product requirement. - Keep product data fetching, routing, RPC, permissions, and domain workflows in the consuming app. - Check Kumo before adding a…

No other project uses it yet

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / workshop-backend

cloudflare/cloudflare-os/packages/workshop-backend/AGENTS.md

The Gadgets Workshop server on Cloudflare Workers: the kernel, held to the bar in the root AGENTS.md (The kernel). The backend installs the bundled blueprints from @gadgets/bundled-blueprints on a deployment's first /api request, and offers them as the deployment's standard output formats. scripts/build-bundled-blueprints.ts generates the gitignored src/generated/bundled-blueprints.ts they are installed from, which holds each blueprint's manifest and built files (BUNDLED_BLUEPRINTS_DIR overrides the source directory), so build and test both run the generator first; pnpm import:bundled-blueprint updates or adds a blueprint…

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / workshop-frontend

cloudflare/cloudflare-os/packages/workshop-frontend/AGENTS.md

This package is the Workshop single-page application. It uses React, TanStack Router, Tailwind, and Kumo. Follow the repository-wide guidance in ../../AGENTS.md in addition to this file. Organize new code by product ownership first and implementation type second. The existing tree predates this convention. Apply it to new code and to code being substantially reworked; do not migrate unrelated files opportunistically. Feature directories own product behavior. A feature may contain components, hooks, tests, and utilities that belong to that behavior. Start…

12k54d agoReviewMountCreate a free account to mount
CloudflareAGENTS.md

cloudflare-os / release

cloudflare/cloudflare-os/scripts/release/AGENTS.md

How customer instances get deployed. - build-release.ts bundles every deployable worker byte-identically (wrangler dry-run with the pinned wrangler), builds the Access-mode frontend asset build, and generates the release manifest — the contract between this repo's CI and the deploy service, produced by manifest-lib.ts from each package's wrangler.jsonc with account-specific values replaced by placeholders ($ACCOUNT_ID, $WORKER_NAME(...), $SECRET(...), $PUBLIC_BASE_URL, ...). - upload-release.ts mirrors the release to R2 content-addressed, manifest last; with --candidate the manifest lands under candidates/<id>/ (invisible to the deploy service)…

12k54d 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.