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

compose-multiplatform-core / navigation

JetBrains/compose-multiplatform-core/navigation/AGENTS.md

- When modifying any .kt file, format it via the following command: ./gradlew :ktCheckFile --format --file <file>. If more than one file needs formatting, continue adding --file <next-file> to the command. - When a public API is changed or when asked to update the public API files, execute: ./gradlew <project>:updateApi, the projects and their root paths can be found in settings.gradle. - When moving files, use git mv to keep version control history. - Do not make a git commit…

67447d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

compose-multiplatform-core / room3

JetBrains/compose-multiplatform-core/room3/AGENTS.md

- When modifying any .kt file, format it via the following command: ./gradlew :ktCheckFile --format --file <file>. If more than one file needs formatting, continue adding --file <next-file> to the command. - When a public API is changed or when asked to update the public API files, execute: ./gradlew <project>:updateApi, the projects and their root paths can be found in settings.gradle. - When moving files, use git mv to keep version control history. - Do not make a git commit…

67447d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

godot-support

JetBrains/godot-support/AGENTS.md

Development guidelines for the Godot support under dotnet/Plugins/godot-support. The main scenario for working with godot-support is the monorepo - the case when the root of the repository contains dotnet/Plugins/godot-support. The .iml files sit in dotnet/Plugins/ - intellij.rider.plugins.godot*.iml. The secondary scenario is when the root of the workspace directly contains folders rider, gdscript. Only in this case Gradle is the build/test tool to be used. Two repositories serve as a source of truth for the engine behavior:

51126d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

godot-support / gdscript

JetBrains/godot-support/gdscript/AGENTS.md

Development guidelines for the gdscript module (JetBrains Godot plugin). Read ../AGENTS.md section 2. Bazel vs Gradle first. Before you run a build or test command, check the repository environment: - Bazel. Follow Section 1 and Section 2. - Gradle. Follow Section 3. To compile only: Instructions are in the Gd.flex file. See also GdHighlight.flex. After you edit Gd.flex, regenerate the Java lexer from the workspace root: The generated file is src/main/gen/gdscript/GdLexer.java. Commit it together with the changes to Gd.flex. If…

51126d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

godot-support / godot-rd

JetBrains/godot-support/godot-rd/AGENTS.md

If you want to test if your changes compile, you must use bazel, not cmake. The only time you should ever use cmake, is if the user explicitly asks you to do so.

51126d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin-toolchain

JetBrains/kotlin-toolchain/AGENTS.md

The Kotlin Toolchain is a build system for Kotlin projects. This is the project that builds this build system, and it uses itself as a build system. Docs are located in the docs/ folder. Here are useful commands: * To learn about the available CLI commands: ./kotlin --help * To learn about the specific options of some command: ./kotlin <command> --help (Example: ./kotlin build --help) * To compile the project: ./kotlin build * To run all tests of a given…

4994d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

youtrackdb

JetBrains/youtrackdb/AGENTS.md

YouTrackDB is a general-purpose object-oriented graph database developed by JetBrains, used internally in production. It implements the Apache TinkerPop API with Gremlin query language support and features O(1) link traversal, schema-less/mixed/full modes, and encryption at rest. The project is a fork of OrientDB, re-architected under the com.jetbrains.youtrackdb package namespace. The docs/ folder contains user-facing product documentation. See docs/README.md for the index. Project-internal documentation (development workflow, role guidelines, ADR archive) lives in docs-internal/ — see docs-internal/README.md for the index. Storage engine,…

4425mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

skills / composition-patterns

JetBrains/skills/composition-patterns/AGENTS.md

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

Rising10 mentions in 2 weeks

119 projects use a version of this

3866mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

skills / postgres-best-practices

JetBrains/skills/postgres-best-practices/AGENTS.md

Comprehensive performance optimization guide for Postgres, maintained by Supabase. Contains rules across 8 categories, prioritized by impact to guide automated query optimization and schema design. Reference these guidelines when: -…

3866mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

skills / react-best-practices

JetBrains/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…

3866mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

skills / react-native-skills

JetBrains/skills/react-native-skills/AGENTS.md

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

55 projects use a version of this

3866mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin-desktop-toolkit

JetBrains/kotlin-desktop-toolkit/AGENTS.md

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

2045mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin-desktop-toolkit / desktop-win32

JetBrains/kotlin-desktop-toolkit/native/desktop-win32/docs/AGENTS.md

You are reading this because you've been pointed at the native/desktop-win32 crate (or its Kotlin counterpart at kotlin-desktop-toolkit/src/main/kotlin/org/jetbrains/desktop/win32/) and need to navigate, modify, or debug it. Read this file first; it indexes the rest. Windows backend of the kotlin-desktop-toolkit. Rust crate (cdylib) exposing a flat C ABI via cbindgen, consumed from Kotlin via JExtract-generated bindings plus hand-written wrappers. UI runs on a single thread (OleInitialize STA) with a classic GetMessage pump in event_loop.rs. Composition uses WinRT Windows.UI.Composition via ICompositorDesktopInterop —…

2045mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

educational-plugin

JetBrains/educational-plugin/AGENTS.md

- edu-format — shared module with course format: course/lesson/task classes, YAML/JSON/XML serialization, etc. Note, this module is used outside the plugin project for reading and parsing course archives. - intellij-plugin — main plugin root, containing: - educational-core/ — core code of the plugin. - jvm-core/ — JVM-shared functionality. - Edu-<Language>/ — language-specific modules. - sql/ and sql:sql-jvm — SQL support. - AI/ — core module for AI features - features:* — feature modules. Some important ones: - command-line - command…

1815d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

teamcity-cli

JetBrains/teamcity-cli/AGENTS.md

Read CONTRIBUTING.md — it is the source of truth for architecture, conventions, testing, linting, and the before-pushing checklist. Everything below is additive guidance for AI agents only. Eval issues document real agent failures to turn into automated benchmarks. Keep them focused on observable behavior:

13027d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

klibs-io

JetBrains/klibs-io/AGENTS.md

klibs.io — a service that indexes, catalogs, and provides search for Kotlin Multiplatform libraries from Maven Central and GitHub, with AI-powered metadata generation. Note: avoid introducing new dependencies unless absolutely necessary. Module structure follows "module by feature". Each core module has its own entity, repository, service, and controller layers. Docker must be running for Testcontainers-based tests. Key config files in app/src/main/resources/: - application.yml — base config - application-local.yml — local dev - application-prod.yml — production template - PostgreSQL with Liquibase…

10812d agoReviewMountCreate a free account to mount
JetBrainsReads credentialsAGENTS.md

klibs-io / frontend

JetBrains/klibs-io/frontend/AGENTS.md

Next.js 14 (App Router) frontend for klibs.io. React 18 + TypeScript, JetBrains @rescui/* design system. Pick the cheapest level that proves the behavior: Every page and route state (page, loading, error, not-found) needs a visual test that renders it or its content component; src/app/visual-coverage.test.ts fails otherwise. That test can't see states inside a page, so when you add one (empty, error, a different layout), add a visual test for it too.

10812d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

aspire-plugin

JetBrains/aspire-plugin/AGENTS.md

JetBrains Rider plugin for .NET Aspire — Kotlin JVM frontend with embedded session servers and a C# Rider backend plugin communicating over the RD protocol.

9659d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

tracy

JetBrains/tracy/AGENTS.md

Rules for AI agents modifying this codebase. Security - Never commit API keys or credentials - Never log secrets - Use environment variables for sensitive config Sensitive Content Redaction - Tracy redacts AI inputs/outputs by default — do not change this behavior - This is a security requirement, not a bug OpenTelemetry Conventions - Follow OpenTelemetry GenAI semantic conventions - Do not invent custom attribute names Runtime Gating - Spans emit only when SDK is installed via TracingManager.setSdk(...) AND isTracingEnabled…

795mo agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin-compiler-devkit

JetBrains/kotlin-compiler-devkit/AGENTS.md

Kotlin Compiler DevKit is an IntelliJ IDEA plugin that enhances the development experience for working with compiler tests in the Kotlin project or Kotlin compiler plugins. It provides a specialized test data editor, test running capabilities, and diff application features. Use JetBrains MCP getrunconfigurations() or these pre-configured options: - Run Plugin - Launches sandbox IDE with plugin installed - Run Tests - Executes test suite - Run Verifications - Runs plugin verification - Run Linters - Runs linters verification The…

589mo 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.