Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions docs/ai_builder/integrations/agents_md.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# AGENTS.md and CLAUDE.md

`AGENTS.md` and `CLAUDE.md` are project-level instruction files that AI coding assistants read when they enter your repository. They give the assistant durable, repository-specific context so it follows Reflex conventions instead of generic defaults.

- `AGENTS.md` is read by agents that follow the [AGENTS.md convention](https://agents.md), including Cursor, OpenCode, OpenAI Codex, and Pi.
Comment thread
adhami3310 marked this conversation as resolved.
- `CLAUDE.md` is read by [Claude Code](https://code.claude.com/docs/en/memory). Claude Code does not read `AGENTS.md` directly — see [Sharing With Claude Code](#sharing-with-claude-code) below.

A Reflex project should have at least one of these files at the project root, next to `rxconfig.py`.

## Recommended Content

The [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository ships an `AGENTS.md` template that points assistants at the [Reflex Agent Skills](/docs/ai/integrations/skills/) for environment setup, documentation lookup, and process management. Use it as the starting point, then add anything specific to your codebase.

```md alert info
# `AGENTS.md` references skills by name, so it works once the [Reflex Agent Skills](/docs/ai/integrations/skills/) are installed in the assistant.
```

## Installation

Download the template into your project root, next to `rxconfig.py`:

```bash
curl -fsSL https://raw.githubusercontent.com/reflex-dev/agent-skills/main/AGENTS.md -o AGENTS.md
```

Or copy it manually from a local clone of the [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository.

## Sharing With Claude Code

Claude Code reads `CLAUDE.md`, not `AGENTS.md`. To avoid duplicating content, create a `CLAUDE.md` that [imports](https://code.claude.com/docs/en/memory#import-additional-files) `AGENTS.md` using the `@` syntax:

```md
@AGENTS.md

## Claude Code

Add any Claude-specific instructions here.
```

Claude Code expands the `@AGENTS.md` import at session start, then appends anything you write below it. Both files stay in sync from a single source.

After installation, your project root looks like:

```text
my_app/
AGENTS.md
CLAUDE.md
rxconfig.py
my_app/
my_app.py
```

## Project-Specific Additions

The template covers Reflex-wide setup. Below it, add anything else the assistant should know about your project:

- Internal conventions and code style.
- Required lint, type-check, or test commands.
- Folder layout and where new code should go.
- Hosting or deployment notes.

Keep entries short and imperative — assistants follow concise, direct instructions more reliably than long paragraphs.

## Keeping Files Updated

Reflex evolves quickly. If you used `curl` to download the template, re-run the same command to refresh it:

```bash
curl -fsSL https://raw.githubusercontent.com/reflex-dev/agent-skills/main/AGENTS.md -o AGENTS.md
```

If you cloned the [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository, pull the latest changes and copy the file back into your project:

```bash
cd agent-skills
git pull
cp AGENTS.md /path/to/your/reflex-project/AGENTS.md
```

## Combining With Skills and MCP

`AGENTS.md` and `CLAUDE.md` anchor the assistant in your project. Pair them with the other onboarding tools for deeper Reflex knowledge:

- [Reflex Agent Skills](/docs/ai/integrations/skills/) provide reusable workflows that the file references by name.
- [Reflex MCP](/docs/ai/integrations/mcp-overview/) provides structured documentation lookup at runtime.
- The [llms.txt index](/llms.txt) gives a broad map of the documentation in one file.
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ def sidebar_comp(
is_ai_mcp_or_skills = path.startswith((
"/ai/integrations/ai-onboarding/",
"/ai/integrations/skills/",
"/ai/integrations/agents-md/",
"/ai/integrations/mcp",
))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ def get_sidebar_items_skills():
names="Overview",
link=ai_builder.integrations.skills.path,
),
SideBarItem(
names="AGENTS.md / CLAUDE.md",
link=ai_builder.integrations.agents_md.path,
),
]


Expand Down
Loading