Copy a production-ready example below, or generate one tuned to your exact FastAPI setup in about thirty seconds — free, in your browser.
# your-fastapi-app > FastAPI project. Instructions for AI coding agents working in this repository. ## Setup - Install dependencies: `uv sync` - Start dev server: `uvicorn app.main:app --reload` - Run tests: `pytest` ## Code style - Type hints on every function signature. - Pydantic models for all request/response bodies. - Follow PEP 8; format with `ruff format`. ## Guardrails Things agents get wrong here. Follow these strictly: - Never edit Alembic migration files by hand after they are generated. - Keep DB sessions request-scoped; don’t open global connections. - Never commit secrets, API keys, or `.env` files.
Dropped into a FastAPI repo with no context, an AI agent guesses: it reaches for the wrong package manager, ignores your structure, and edits files it shouldn’t. AGENTS.md is the briefing it reads first — so the very next prompt behaves like a teammate who already knows your conventions.
The example above covers the three sections that matter most for FastAPI: the real setup commands (uv sync, uvicorn app.main:app --reload, pytest), your code-style conventions, and the guardrails agents reliably get wrong. The generator fills these in from your actual manifest so the commands match your project, not a generic template.
It is a markdown file at your repo root that tells AI coding agents how your FastAPI project works — setup commands, code style and guardrails — so they follow your conventions instead of guessing.
AGENTS.md is a shared convention read by Cursor, Claude Code, OpenAI Codex, GitHub Copilot, Gemini, Windsurf, Zed and others. For tools with their own filename you can export that format or symlink it to AGENTS.md.
At minimum: install/dev/test commands (uv sync, uvicorn app.main:app --reload, pytest), your code-style conventions, and the guardrails agents get wrong — like Never edit Alembic migration files by hand after they are generated.
Detect your stack, tune the guardrails, export to every agent format. Free.
Open the generator