Report · marked 26 Aug 2026
zylon-ai/private-gpt
An agent can work here, but it will waste turns finding its footing.
Python · 57,466 stars · 1,025 files · branch main
65
/100
B
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop
24/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy
15/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
8/10How quickly anything new can orient itself. Losing marks on written documentation.
Higher is better. Accent marks what is costing you most.
Fix these first
01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
The full marking
Every deduction below names the file or setting it came from.
Instructions 3/27 F
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
✗Instruction quality
0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
✓README as an entry point
3/3
README has a clear getting-started section.
Setup 16/20 A-
Whether an agent can install the project and get it running without a human.
✓Deterministic install
6/6
uv.lock pins the dependency tree.
Found uv.lock
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
Makefile
pyproject.toml scripts
scripts/ directory
✗Environment config
2/4
Env vars are mentioned in the README but there's no example file to copy.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
✗Pinned runtime version
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✓Reproducible environment
2/2
dockerfile gives a known-good environment.
Verification loop 24/25 A+
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
211 test files against 845 source files.
e.g. settings-test.yaml, tests/__init__.py, tests/arq/tasks/chat/test_callback.py
✓Test command is discoverable
7/7
An agent can find and run `make test`.
✓Continuous integration
4/4
10 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
pyproject.toml encodes the house style.
✗Static type checking
2/3
Type checking is configured, but not in strict mode.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 15/20 B+
Whether the repo fits in a context window, or fights it.
✓No committed build output
6/6
No generated directories committed.
✓.gitignore hygiene
3/3
.gitignore covers 31 patterns.
✗File sizes fit in context
4/6
1 source file is over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
tests/server/chat/test_chat_routes.py — 112KB
✗Repository weight
2/5
About 226MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
Here is your AGENTS.md
Drafted from what is actually in this repository: the install
command from your lockfile, the commands you already declare, your real directory layout. Anything
marked TODO needs a person. Save it at the root as AGENTS.md.
# 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.
Open the raw markdown
or
curl -o AGENTS.md agentreadme.com/draft/zylon-ai/private-gpt.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/zylon-ai/private-gpt)Other Python repositories, marked
Think this mark is wrong?
Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.