Report · marked 25 Aug 2026
LAION-AI/Open-Assistant
An agent will struggle here, mostly for fixable reasons.
Python · 37,405 stars · 1,576 files · branch main
47
/100
C
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
6/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and discoverable commands.Verification loop
11/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and test command is discoverable.Context economy
18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability
10/10How quickly anything new can orient itself. Full marks.
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
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
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 6/20 D
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✗Discoverable commands
0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
✗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
2/2
The language runtime version is pinned.
Found .python-version
✓Reproducible environment
2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 11/25 C
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
4/8
25 test files against 760 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. backend/tests/__init__.py, backend/tests/test_settings.py, backend/tests/test_tree_manager_config.py
✗Test command is discoverable
0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
✓Continuous integration
4/4
11 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
pyproject.toml encodes the house style.
✗Static type checking
0/3
No static type checking.
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 18/20 A
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 17 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.
data/datasets/safety_directory/child_help/child_help.py — 155KB
✓Repository weight
5/5
About 35.5MB checked out, which is comfortable.
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 OpenAssistant is a chat-based assistant that understands tasks, can interact with third-party systems, and retrieve information dynamically to do so. ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` ruff check . # lint ``` ## Layout - `website/` 335 source files - `backend/` 122 source files - `inference/` 71 source files - `model/` 69 source files - `data/` 51 source files - `discord-bots/` 48 source files ## Conventions - Tests live alongside the code they cover, following `backend/tests/__init__.py`. - CI defines what passing means. See `.github/workflows/build-frontend.yaml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `data/datasets/safety_directory/child_help/child_help.py` is 155KB. It will not fit comfortably in context, so read it in parts. - No lockfile is committed, so an install here may not match what CI produced. --- 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/LAION-AI/Open-Assistant.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/LAION-AI/Open-Assistant)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.