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
VercelAGENTS.md

chat / adapter-web

vercel/chat/packages/adapter-web/AGENTS.md

Guidance for coding agents working inside the Web adapter package. The top-level repository AGENTS.md covers monorepo-wide build, lint, and release rules — read it first. This file documents the adapter-specific surface, conventions, and pitfalls. @chat-adapter/web lets a Chat SDK bot serve a browser chat UI alongside Slack, Teams, Discord, and the rest. The same handlers fire for every platform. The Web adapter speaks one of two wire protocols, chosen with the protocol config option: - "ai-sdk" (default): the AI SDK…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / state-memory

vercel/chat/packages/state-memory/AGENTS.md

Guidance for coding agents working inside the in-memory state adapter package. The top-level repository AGENTS.md covers monorepo-wide build, lint, and release rules — read it first. This file documents the adapter-specific surface, conventions, and pitfalls. @chat-adapter/state-memory is the simplest state adapter — keeps all subscriptions, locks, caches, lists, and queues in process memory. Suitable for: - Local development and tutorials. - Single-process bots where durability is not a concern (and recovery from a restart is acceptable). - Tests — the…

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / state-pg

vercel/chat/packages/state-pg/AGENTS.md

Guidance for coding agents working inside the PostgreSQL state adapter package. The top-level repository AGENTS.md covers monorepo-wide build, lint, and release rules — read it first. This file documents the adapter-specific surface, conventions, and pitfalls. @chat-adapter/state-pg persists Chat SDK state in PostgreSQL using the pg client. Pick this adapter when: - Postgres is already your primary datastore and you don't want to add Redis to the stack. - You need rich query access (analytics, audit, joins) over subscriptions / cache…

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

flags

vercel/flags/AGENTS.md

No summary in the file. Open it to read it.

62837d agoReviewMountCreate a free account to mount
VercelAGENTS.md

next-evals-oss

vercel/next-evals-oss/AGENTS.md

Read README.md first — it is the spec for this repo, not a summary of it. "Adding a new model", "Reasoning effort", "Model retention policy", and "Scoring and cost methodology" are the rules the board is published under. Skills live in .agents/skills/, with .claude/skills symlinked to that directory so Claude Code and other harnesses read the same copy. Almost every task here ends in numbers on a public board, and the work only counts once those numbers exist. An experiment…

32912d agoReviewMountCreate a free account to mount
VercelAGENTS.md

vercel-plugin / react-best-practices

vercel/vercel-plugin/skills/react-best-practices/AGENTS.md

Version 1.0.0 Vercel Engineering January 2026 Note: This document is mainly for agents and LLMs to follow when maintaining, generating, or refactoring React and Next.js codebases. Humans may also find…

32838d agoReviewMountCreate a free account to mount
VercelAGENTS.md

sandbox

vercel/sandbox/AGENTS.md

This repo uses changesets for versioning. When making changes to any package, add a changeset by running pnpm changeset or by creating a markdown file in .changeset/ with the following format: Use patch for bug fixes, cosmetic changes, and DX improvements. Use minor for new features. Use major for breaking changes.

2229mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

microfrontends

vercel/microfrontends/AGENTS.md

This is a monorepo for @vercel/microfrontends, a library that enables splitting large applications into independently developed and deployed microfrontends on Vercel. The package provides generic platform support for microfrontends in multiple frameworks, such as Next.js, SvelteKit, React Router, Vite, and React. When running commands for a specific application, do not cd into the directory. Run commands from the root. The above commands can be run for a particular package by using a filter option: pnpm checks -F <package name>. Use…

457mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

vercel-py

vercel/vercel-py/AGENTS.md

- uv for package management, virtual environment construction, and running scripts - ruff for linting and formatting - mypy for type checking - Implementation code uses AnyIO primitives. Direct asyncio usage is allowed only in tests, examples, and documentation. - uv run poe qa — Run lint, typecheck, and tests. Accepts package or file scopes plus -q/--quiet and -v/--verbose; does not accept tool-specific options after --. - uv run poe test — Run tests (excludes example tests). - uv run…

345mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

bridge

vercel/bridge/AGENTS.md

When using the slog logger, you should be saving it to a variable called logger and attach any relevant context using the With func. When told to "rebuild" you should…

128mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

veil

vercel/veil/AGENTS.md

No summary in the file. Open it to read it.

92mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

workflow-builder-starter

vercel/workflow-builder-starter/AGENTS.md

This project uses pnpm as its package manager. Always use pnpm for all package operations: Never use npm or yarn for this project. When working on this project, always follow…

812mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

nextjs-foundations-starter

vercel/nextjs-foundations-starter/AGENTS.md

This is the starter repository for the Next.js Foundations certification course. A Turborepo monorepo with two Next.js applications and shared packages: Import from @repo/ui for components: Import from @repo/api for…

310mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / starter

vercel/academy-starters/agent-friendly-apis/starter/AGENTS.md

This project is the starter for the Agent-Friendly APIs course on Vercel Academy: https://vercel.com/academy/agent-friendly-apis The course builds on this code one lesson at a time. If the person you're helping…

010d agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / starter

vercel/academy-starters/filesystem-agents/starter/AGENTS.md

This project is the starter for the Building Filesystem Agents course on Vercel Academy: https://vercel.com/academy/filesystem-agents The course builds on this code one lesson at a time. If the person you're…

010d agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / complete

vercel/academy-starters/launch-an-ai-startup/complete/AGENTS.md

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in…

Surging+48 new adopters in 4 weeks

90 projects use a version of this

010d agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / starter

vercel/academy-starters/launch-an-ai-startup/starter/AGENTS.md

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in…

010d agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / starter

vercel/academy-starters/nextjs-foundations/starter/AGENTS.md

This is the starter repository for the Next.js Foundations certification course. A Turborepo monorepo with two Next.js applications and shared packages: Import from @repo/ui for components: Import from @repo/api for…

010d agoReviewMountCreate a free account to mount
VercelAGENTS.md

academy-starters / starter

vercel/academy-starters/python-on-vercel/starter/AGENTS.md

This project is the starter for the Python on Vercel course on Vercel Academy: https://vercel.com/academy/python-on-vercel The course builds on this code one lesson at a time. If the person you're…

010d 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.