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

eve

vercel/eve/AGENTS.md

Guidance for coding agents (and humans) working in this repository. For setup, PR workflow, and release process, see CONTRIBUTING.md. eve is a filesystem-first framework for durable backend AI agents. You author an agent as a directory on disk — instructions, skills, tools, connections, channels, subagents, and schedules are all files — and eve compiles and runs it. See the README for the full overview and docs/ for user-facing documentation. Always style the framework name as eve, lowercase, in user-facing copy,…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / apps

vercel/eve/apps/docs/AGENTS.md

All user-facing UI changes must be mobile-responsive. Before completing a UI change, verify it at a narrow mobile viewport and a desktop viewport. Check for page-level horizontal overflow, clipped content, unreadably narrow columns, overlapping controls, and whether dense navigation should wrap or scroll horizontally. 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 monorepos the next package may not…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-chat-template

vercel/eve/apps/templates/eve-chat-template/AGENTS.md

This project uses the eve framework. Before writing code, always read the relevant guide in node_modules/eve/docs/. Use eve lowercase in user-facing copy, docs, prompts, and comments. Do not title-case it unless it is part of an exact external title or quoted text.

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-coding-agent-template

vercel/eve/apps/templates/eve-coding-agent-template/AGENTS.md

This project uses the eve framework: an agent is a directory of files under agent/, and eve compiles and runs it. For a content-only change to the root agent's identity, purpose, tone, or response guidelines, edit its existing authored instructions. Fresh projects use agent/instructions.md; a project may instead use agent/instructions.ts or files under agent/instructions/. You do not need to read the framework docs for a content-only instructions change. A fresh project already has its selected model in agent/agent.ts; preserve that…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-llm-council-template

vercel/eve/apps/templates/eve-llm-council-template/AGENTS.md

This project uses the eve framework. Before writing code, read the relevant guide from the installed eve package docs. In most installs, those docs are at node_modules/eve/docs/. In workspaces or local package installs, resolve the installed eve package location first and read its docs/ directory. If package docs are unavailable, use https://eve.dev/docs as a fallback. Before implementing an integration yourself, use eve registry search <query> or eve registry list to discover available integrations. Inspect one with eve registry view <item>,…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-slack-agent-template

vercel/eve/apps/templates/eve-slack-agent-template/AGENTS.md

This project uses the eve framework. Before writing code, always read the relevant guide in node_modules/eve/docs/.

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / personal-agent-template

vercel/eve/apps/templates/personal-agent-template/AGENTS.md

Durable personal AI assistant built with eve and Nuxt. This project deploys its Nuxt frontend and eve agent as peer Vercel services through vercel.ts. Before writing agent code, read the relevant guide in node_modules/eve/docs/. The eve agent calls Nuxt over HTTP: Authenticated with Authorization: Bearer <INTERNAL_API_SECRET>. See apps/web/server/utils/internal-api.ts. Categories: lib/types/memory.ts. One prose block per category; saves replace the full block. See docs/CUSTOMIZATION.md for details.

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-agent-desktop

vercel/eve/packages/eve-agent-desktop/AGENTS.md

This published package is the @eve/agent-desktop extension: accessibility-based desktop tools backed by the agent-desktop CLI, plus the @eve/agent-desktop/sandbox helpers that install and start the desktop. Before writing code, read the installed eve package docs for extensions, tools, and sandboxes as applicable. Tests run against the built dist/, so there is no unit tier. Tiers are set by directory: Run typecheck, build, both tiers, lint, and package-scoped formatting before completion.

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-code

vercel/eve/packages/eve-code/AGENTS.md

This private package is the source of the eve/extensions/code extension for CLI-based coding work. It contributes investigation and review skills, instruction fragments, Connect-backed authentication hooks, and consumer sandbox helpers. Before writing code, read the installed eve package docs for extensions, hooks, tools, skills, subagents, and sandboxes as applicable. The eve build copies extension/ into packages/eve/src/extensions/code/extension and compiles it into the eve package; public entry points are declared in packages/eve/package.json and packages/eve/src/extensions/code/. Do not publish this package or add it as…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-computer-use

vercel/eve/packages/eve-computer-use/AGENTS.md

This private package is the source of the eve/extensions/computer-use extension. It contributes the computer_use tool and the sandbox helpers that install and start the desktop and driver. Before writing code, read the installed eve package docs for extensions, tools, and sandboxes as applicable. The eve build copies extension/ into packages/eve/src/computer-use/extension and compiles it into the eve package; public entry points are declared in packages/eve/package.json and packages/eve/src/computer-use/. Do not publish this package or add it as an eve dependency (it depends…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

eve / eve-git

vercel/eve/packages/eve-git/AGENTS.md

This private package is the source of the eve/extensions/git extension. It owns everything GitHub-facing: the pull request skill, GitHub instructions, and, with github config, the Connect-brokered gh tool and signed-commit workflow. Before writing code, read the installed eve package docs for extensions, tools, skills, instructions, and sandboxes as applicable. The eve build copies extension/ into packages/eve/src/extensions/git/extension and compiles it into the eve package; public entry points are declared in packages/eve/package.json and packages/eve/src/extensions/git/. Do not publish this package or add it…

Steady4 mentions in 2 weeks

No other project uses it yet

5.8k12d agoReviewMountCreate a free account to mount
VercelAGENTS.md

workflow / nextjs-turbopack

vercel/workflow/workbench/nextjs-turbopack/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 monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices. This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree…

198 projects use a version of this

2.5k13mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat

vercel/chat/AGENTS.md

Guidance for coding agents working in this repository. For PR workflow, signed commits, and changeset rules, see .github/CONTRIBUTING.md. Install dependencies with pnpm add, not by editing package.json by hand. pnpm + Turborepo monorepo. Packages are ESM ("type": "module"), TypeScript, bundled with tsup. When editing a specific package, read its AGENTS.md if present (most adapters, state packages, create-chat-sdk, and packages/catalog have one). {adapter}:{channel}:{thread} — e.g. slack:C123ABC:1234567890.123456. Some adapters base64-encode IDs that contain delimiters (Teams, Google Chat). mdast is the canonical message…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / apps

vercel/chat/apps/docs/public/AGENTS.md

Build multi-platform chat bots with Chat SDK (`chat` npm package). Use when developers want to scaffold a bot with create-chat-sdk, build a Slack, Teams, Google Chat, Discord, Telegram, GitHub, Linear, or WhatsApp bot, handle mentions, direct messages, subscribed threads, reactions, slash commands, cards, modals, files, or AI streaming, set up webhook routes or multi-adapter bots, send rich cards or streamed AI responses to chat platforms, or build a custom adapter or state adapter.

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-gchat

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

Guidance for coding agents working inside the Google Chat 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/gchat connects a Chat SDK bot to Google Chat (the Workspace messaging product, not Hangouts/Meet). It covers: - HTTP webhook endpoint at /api/webhooks/gchat, validated with Google-issued JWTs. - Card v2 rendering for cards, fields, action buttons, image attachments, and dialog modals. - Workspace Events API…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-github

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

Guidance for coding agents working inside the GitHub 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/github connects a Chat SDK bot to issue and pull-request comment threads on GitHub. It covers: - HTTP webhook endpoint at /api/webhooks/github for issues, issue_comment, pull_request, pull_request_review_comment, and pull_request_review events, validated with HMAC-SHA256 against the App secret. - Comment posting, editing, and deletion via the REST…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-gitlab

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

Guidance for coding agents working inside the GitLab adapter package. The top-level repository AGENTS.md covers monorepo-wide build, lint, and release rules. Read it first. @chat-adapter/gitlab connects a Chat SDK bot to merge request and issue comments on GitLab.com, GitLab Self-Managed, and GitLab Dedicated: - Webhook endpoint at /api/webhooks/gitlab for Note Hook (comments) and Emoji Hook (reactions) events. - Webhook verification with a signing token (Standard Webhooks webhook-signature, GitLab 19.0+), a secret token (X-Gitlab-Token), or a custom webhookVerifier. - REST API…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-notion

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

Guidance for coding agents working inside the Notion adapter package. The top-level repository AGENTS.md covers monorepo-wide build, lint, and release rules — read it first. @chat-adapter/notion connects a Chat SDK bot to Notion comments (page-level and discussion threads) via: - Webhooks (comment.created) with X-Notion-Signature HMAC verification and a one-time verification_token handshake - Comments REST API (create / update / delete / list / retrieve) - Outbound Vercel Connect authentication via an async token resolver; inbound webhooks remain direct and use…

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-telegram

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

Guidance for coding agents working inside the Telegram 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/telegram connects a Chat SDK bot to a Telegram bot account via the official Bot API. It covers: - HTTP webhook endpoint at /api/webhooks/telegram (or polling for long-running processes), validated with the optional secret_token header. - Inline keyboards for buttons (cards/actions are rendered as a text…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
VercelAGENTS.md

chat / adapter-twitch

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

Follow the repository-level AGENTS.md plus these package-specific rules. This package integrates Twitch channel chat and whispers through EventSub webhooks and the Helix API. It runs as a Twitch "cloud chatbot": a dedicated bot account, an app access token from the client credentials grant, and one-time authorizations from the bot and each broadcaster. It uses the EventSub webhook transport only, so it works on serverless platforms. - Factory: createTwitchAdapter - Adapter name: twitch - Thread IDs: twitch:{broadcasterUserId} (chat room) and twitch:whisper:{userId}…

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d 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.