AGENTS.md examples from real projects

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

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

Sentry 1k+ stars

SentryAGENTS.md

sentry

getsentry/sentry/AGENTS.md

IMPORTANT: AGENTS.md files are the source of truth for AI agent instructions. Always update the relevant AGENTS.md file when adding or modifying agent guidance. Do not add to CLAUDE.md or…

46k4mo agoReviewMount

SentryAGENTS.md

sentry / src

getsentry/sentry/src/AGENTS.md

For setup, lint, and test commands, see the "Command Execution Guide" section in /AGENTS.md in the repository root. Multi-tenant queries MUST be scoped. Never trust user-supplied IDs alone. - Always…

46k4mo agoReviewMount

SentryAGENTS.md

sentry / action_log

getsentry/sentry/src/sentry/issues/action_log/AGENTS.md

Action log entries are kept effectively forever and are never migrated. Read the GroupAction docstring in types.py before adding or changing a GroupAction subclass.

46k4mo agoReviewMount

SentryAGENTS.md

sentry / derived

getsentry/sentry/src/sentry/issues/derived/AGENTS.md

Follow README.md in this directory when changing Features or aggregators here.

46k4mo agoReviewMount

SentryAGENTS.md

For critical commands and testing rules, see the "Command Execution Guide" section in /AGENTS.md in the repository root. - Routes defined in static/app/router/routes.tsx - Builds, tests, and typechecks use React…

46k4mo agoReviewMount

SentryAGENTS.md

sentry / tests

getsentry/sentry/tests/AGENTS.md

For test commands (make test-selective, pytest), see the "Command Execution Guide" section in /AGENTS.md in the repository root. This guide covers Python tests. For frontend React/TypeScript tests (.spec.tsx, RTL, MockApiClient),…

46k4mo agoReviewMount

SentryReads credentialsAGENTS.md

self-hosted

getsentry/self-hosted/AGENTS.md

This repository is Sentry's self-hosted packaging. It bundles upstream Sentry images (Sentry, Relay, Snuba, Symbolicator, and others) into a Docker Compose deployment with install/upgrade scripts, config templates, and optional patches.…

9.6k28d agoReviewMount

SentryReads credentialsAGENTS.md

sentry-javascript

getsentry/sentry-javascript/AGENTS.md

Monorepo with 40+ packages in @sentry/*, managed with pnpm workspaces and Nx. Prefer LSP over Grep/Read for code navigation — it's faster, precise, and avoids reading entire files: Use Grep…

8.8k35d agoReviewMount

SentryAGENTS.md

sentry-javascript / browser

getsentry/sentry-javascript/packages/browser/AGENTS.md

Bundle size is critical. Be mindful of imports and tree-shaking. Use /add-cdn-bundle skill to create new CDN bundles.

8.8k35d agoReviewMount

SentryReads credentialsAGENTS.md

sentry-javascript / nextjs

getsentry/sentry-javascript/packages/nextjs/AGENTS.md

Next.js apps use either webpack or turbopack as their bundler. This fundamentally changes how Sentry instruments the application. Detection: process.env.TURBOPACK or --turbo CLI flag (see src/config/util.ts:detectActiveBundler). Webpack builds use loaders…

8.8k35d agoReviewMount

SentryAGENTS.md

MobileBuildMCP

getsentry/MobileBuildMCP/AGENTS.md

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

6.5k39d agoReviewMount

SentryAGENTS.md

MobileBuildMCP / iOS_Calculator

getsentry/MobileBuildMCP/example_projects/iOS_Calculator/AGENTS.md

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

6.5k39d agoReviewMount

SentryAGENTS.md

sentry-python

getsentry/sentry-python/AGENTS.md

Use tox for testing (not pytest directly): - Test matrix configuration is in tox.ini - Integration tests: uv run tox -e py3.14-{integration}-v{version} - Common tests: uv run tox -e py3.14-common - Run specific test file: TESTPATH=tests/integrations/logging/testlogging.py uv run tox -e py3.14-common - Run single test: TESTPATH=tests/path/to/testfile.py uv run tox -e py3.14-common -- -k "test_name" Mypy and its type stubs live in the opt-in typing dependency group: - Run uv run --group typing mypy sentrysdk before committing (must pass with zero…

2.2k8mo agoReviewMount

SentryAGENTS.md

sentry-php

getsentry/sentry-php/AGENTS.md

- sentry/sentry is the core PHP SDK, not an application or framework bundle. - Public entry points include the autoloaded global helpers in src/functions.php and the public classes and interfaces under src/. - Use this file for repo-specific constraints that are easy to miss, and explore the codebase for current implementation details. - The minimum supported PHP version for shipped code is 7.2. composer.json requires ^7.2|^8.0, so shipped code must remain valid on PHP 7.2 unless support policy is intentionally…

1.9k4mo agoReviewMount

SentryDeletes or force-pushesAGENTS.md

sentry-react-native

getsentry/sentry-react-native/AGENTS.md

Sentry React Native SDK — a hybrid SDK: a TypeScript/JS layer on top that wraps the native sentry-cocoa (iOS) and sentry-android/java SDKs through a JS↔native bridge. Monorepo using yarn workspaces; the SDK itself is the packages/core package. Changes to the wrapped native SDKs can ripple to them and to downstream hybrid SDKs (Flutter, .NET/MAUI, Unity) — see Cross-Platform Dependencies. ✅ Always - Run yarn lint, yarn test, and yarn circularDepCheck before calling a change done; regenerate the API report (yarn…

1.8k2mo agoReviewMount

SentryAGENTS.md

sentry-react-native / core

getsentry/sentry-react-native/packages/core/AGENTS.md

Depth lives in the skills. The code-guidelines and test-guidelines skills (.agents/skills/) hold the authoritative, current guidance on code style, API/integration design, the bridge, and tests — load them before non-trivial work. This file covers the package's build/test commands, quick-reference conventions, and the TurboModule subsystem, which is documented nowhere else. Where a convention here overlaps a skill, the skill wins. Use describe/it blocks (preferred) or flat test() calls: Arrange-Act-Assert pattern — always structure tests with clear sections. Use specific Jest matchers:

1.8k2mo agoReviewMount

SentryAGENTS.md

sentry-react-native / android

getsentry/sentry-react-native/packages/core/android/AGENTS.md

Depth lives in the skills. code-guidelines (.agents/skills/, esp. references/native-bridge.md) is authoritative for bridge and native conventions — load it before non-trivial work. This file is the quick reference for the Android surface; where a convention here overlaps a skill, the skill wins. Android native code supports both React Native architectures — a bridge-method change usually has to land in both: Catch Throwable at the boundary — not just Exception, so an Error can't crash the app either (the module code…

1.8k2mo agoReviewMount

SentryAGENTS.md

sentry-react-native / ios

getsentry/sentry-react-native/packages/core/ios/AGENTS.md

Depth lives in the skills. code-guidelines (.agents/skills/, esp. references/native-bridge.md) is authoritative for bridge and native conventions — load it before non-trivial work. This file is the quick reference for the iOS surface; where a convention here overlaps a skill, the skill wins. Catch everything at the boundary and reject — never let an exception reach the app. The reject error code is the shared @"SentryReactNative", not a per-method code: ✅ Always - Resolve or reject every exported method — a…

1.8k2mo agoReviewMount

SentryAGENTS.md

sentry-react-native / expo

getsentry/sentry-react-native/samples/expo/AGENTS.md

The test bed for the SDK under Expo (config plugin, Metro integration, EAS). Use it to verify a change behaves in an Expo-managed app, not just a bare RN one. yarn start then follows the Expo CLI prompts to open on an iOS simulator, Android emulator, or a physical device. Because the SDK ships native code, plain Expo Go isn't enough — the run:* scripts build a dev client that includes it. This app runs on the iOS UIScene lifecycle…

1.8k2mo agoReviewMount

SentryDeletes or force-pushesAGENTS.md

sentry-react-native / react-native

getsentry/sentry-react-native/samples/react-native/AGENTS.md

The end-to-end test bed for the SDK on a bare RN app. Use it to reproduce and verify a change on real devices/simulators, on both architectures. The iOS build varies on three axes, and there's a yarn script per combination. Install pods through one of these rather than a bare pod install — each exports the env the Podfile and pod update read (USEFRAMEWORKS, ENABLEPROD, ENABLENEWARCH): e.g. yarn pod-install-debug-static (New Arch, static frameworks) or yarn pod-install-release-dynamic-legacy (Old Arch, dynamic frameworks).…

1.8k2mo agoReviewMount

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.