# AGENTS.md

Complete API layer for private AI applications on local models: RAG, skills, tools, MCP, text-to-sql, and more. Works with any OpenAI-compatible inference server.

## Setup

```
uv sync
```

## Commands

```
make test                   # run the test suite, must pass before any commit
make test-changed
make test-coverage
make quality-dependencies
make format                 # format
make lint                   # lint
```

## Layout

- `private_gpt/` 664 source files
- `tests/`       173 source files
- `scripts/`     8 source files

## Conventions

- Tests live alongside the code they cover, following `settings-test.yaml`.
- CI defines what passing means. See `.github/workflows/actions/install_dependencies/action.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `tests/server/chat/test_chat_routes.py` is 112KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.