Skip to content

FastAPI + Supabase + pytest rules for AI coding agents

Full stack: Python + FastAPI + Supabase + pytest

Ready-to-commit rules for Python + FastAPI + Supabase + pytest in every major format: AGENTS.md (Codex, Cursor, Copilot), CLAUDE.md (Claude Code), Cursor .mdc project rules, legacy .cursorrules, Copilot instructions, Windsurf rules and GEMINI.md. A FastAPI service on Supabase Postgres and auth.

Last reviewed 2026-10-21 · Customise in the generator · Raw: AGENTS.md, CLAUDE.md

The mistake agents make most on this stack

The service-role key is used for every query, silently bypassing RLS.

Generated files

AGENTS.md
# AGENTS.md - this project

Instructions for AI coding agents working in this repository.

## Project

A Python + FastAPI + Supabase + pytest project.

Stack: Python + FastAPI, Supabase, pytest.

## Commands

- Install deps: `uv sync`
- Dev server: `uv run fastapi dev`
- Lint and format: `uv run ruff check . && uv run ruff format .`
- Tests: `uv run pytest`
- New migration: `npx supabase migration new <name>`
- Generate TS types: `npx supabase gen types typescript --local > types/supabase.ts`
- Tests: `uv run pytest -q`

## Project structure

- `app/main.py` creates the app; one `APIRouter` per domain in `app/routers/`.
- Pydantic schemas in `app/schemas/`, business logic in `app/services/`.

## How to work in this repo

- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.

## Python + FastAPI

- Type-hint every function. Use `Annotated[..., Depends(...)]` for dependencies.
- Request and response bodies are Pydantic v2 models; set `response_model` so output is filtered.
- Use `async def` only when the endpoint awaits async I/O. Blocking libraries go in plain `def` endpoints.
- Inject DB sessions, settings and the current user with dependencies, not globals.
- Load settings with `pydantic-settings` from env vars.
- Raise `HTTPException` with a clear `detail` for expected errors.
- Manage dependencies with `uv add <pkg>`; do not hand-edit lock files.

## Supabase

- Enable Row Level Security on every table and write explicit policies. No table ships without RLS.
- The anon/publishable key is public. The `service_role`/secret key bypasses RLS: use it only in trusted server code, never in the client.
- Change the schema with migration files in `supabase/migrations/`, not by clicking in the dashboard.
- On the server, verify the user with `supabase.auth.getUser()` (or `getClaims()`); do not trust `getSession()` alone for authorization.

## pytest

- Tests live in `tests/` named `test_*.py`. Use plain `assert`.
- Share setup with fixtures in `conftest.py`; use `@pytest.mark.parametrize` for input tables.
- Mock external services (HTTP, LLM APIs, payment providers); tests must not hit the network.
- Every bug fix adds a regression test.

## Reference docs

- [FastAPI docs](https://fastapi.tiangolo.com)
- [Supabase docs](https://supabase.com/docs)
- [pytest docs](https://docs.pytest.org)

Commands your agent should run

TaskCommand
Install depsuv sync
Dev serveruv run fastapi dev
Lint and formatuv run ruff check . && uv run ruff format .
Testsuv run pytest
New migrationnpx supabase migration new <name>
Generate TS typesnpx supabase gen types typescript --local > types/supabase.ts
Testsuv run pytest -q

What the rules cover

Python + FastAPI

FastAPI service with Pydantic v2 and uv. Scoped to **/*.py in Cursor, Copilot and Windsurf.

  • Type-hint every function. Use Annotated[..., Depends(...)] for dependencies.
  • Request and response bodies are Pydantic v2 models; set response_model so output is filtered.
  • Use async def only when the endpoint awaits async I/O. Blocking libraries go in plain def endpoints.
  • Inject DB sessions, settings and the current user with dependencies, not globals.
  • Load settings with pydantic-settings from env vars.
  • Raise HTTPException with a clear detail for expected errors.
  • Manage dependencies with uv add <pkg>; do not hand-edit lock files.

Source docs: FastAPI docs

Supabase

Postgres, auth and storage from Supabase. Scoped to supabase/**, **/supabase/**/*.ts, lib/supabase/** in Cursor, Copilot and Windsurf.

  • Enable Row Level Security on every table and write explicit policies. No table ships without RLS.
  • The anon/publishable key is public. The service_role/secret key bypasses RLS: use it only in trusted server code, never in the client.
  • Change the schema with migration files in supabase/migrations/, not by clicking in the dashboard.
  • On the server, verify the user with supabase.auth.getUser() (or getClaims()); do not trust getSession() alone for authorization.

Source docs: Supabase docs

pytest

Python tests with pytest. Scoped to tests/**/*.py, **/test_*.py in Cursor, Copilot and Windsurf.

  • Tests live in tests/ named test_*.py. Use plain assert.
  • Share setup with fixtures in conftest.py; use @pytest.mark.parametrize for input tables.
  • Mock external services (HTTP, LLM APIs, payment providers); tests must not hit the network.
  • Every bug fix adds a regression test.

Source docs: pytest docs

How to install

  1. Copy AGENTS.md to your repo root. That covers Codex, Cursor, GitHub Copilot and most other agents.
  2. Using Claude Code? Add a CLAUDE.md with the single line @AGENTS.md, or use the standalone CLAUDE.md tab above.
  3. Want rules that only load for certain files in Cursor? Add the .cursor/rules/*.mdc files.
  4. Commit the files so your whole team (and every agent) shares them.

FAQ

Where do I put the AGENTS.md for Python + FastAPI + Supabase + pytest?

Save it as AGENTS.md in the root of your repository, next to your main config file. Codex, Cursor and GitHub Copilot pick it up automatically. For Claude Code, add a CLAUDE.md containing @AGENTS.md (or use the standalone CLAUDE.md on this page).

What is the most common mistake AI agents make with Python + FastAPI?

The service-role key is used for every query, silently bypassing RLS.

Which commands should the agent run to check its work?

For this stack: uv sync, uv run fastapi dev, uv run ruff check . && uv run ruff format ., uv run pytest. They are listed in the generated files so the agent runs them before finishing a task.

Do these Python + FastAPI + Supabase + pytest rules work with Cursor and Claude Code?

Yes. This page includes the same rules as AGENTS.md, CLAUDE.md, Cursor .mdc project rules, a legacy .cursorrules file, GitHub Copilot instructions, Windsurf rules and GEMINI.md.

Can I customise these rules?

Yes. Open this stack in the generator to add or remove libraries, set your project name and package manager, switch beginner explanations on, and download everything as a zip.

Related stacks