agentreadme

Report Β· marked 25 Aug 2026

directus/directus

Solid foundations, held back in a few specific places.

TypeScript Β· 37,462 stars Β· 4,624 files Β· branch main

Fix these first

01
Environment config
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.
02
README as an entry point
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
03
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.

The full marking

Every deduction below names the file or setting it came from.

Instructions 25/27 A+

Whether the repo tells an agent how to behave before it starts guessing.

βœ“Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: Copilot instructions
βœ“Instruction quality 12/12
Specific enough that an agent can act on it.
7,947 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
βœ—README as an entry point 1/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 16/20 A-

Whether an agent can install the project and get it running without a human.

βœ“Deterministic install 6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
βœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (build, format, lint, lint:style, test, test:blackbox…)
βœ—Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
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.
package.json engines.node 22
βœ“Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 22/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
1412 test files against 3785 source files.
e.g. api/src/ai/chat/controllers/chat.post.test.ts, api/src/ai/chat/controllers/object.post.test.ts, api/src/ai/chat/lib/create-ui-stream.test.ts
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
19 GitHub Actions workflows define what "passing" means.
βœ“Lint and format rules 3/3
eslint.config.js 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 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 41 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.
api/src/services/mcp-oauth/index.test.ts β€” 143KB
βœ—Repository weight 2/5
About 452MB 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 β€” drafted for directus/directus
# AGENTS.md

The flexible backend for all your projects 🐰 Turn your DB into a headless CMS, admin panels, or apps with a custom UI, instant APIs, auth & more.

## Setup

```
pnpm install
```

## Commands

```
pnpm build           # produce a build
pnpm test            # run the test suite, must pass before any commit
pnpm lint            # lint
pnpm format          # format
pnpm lint:style
pnpm test:blackbox
pnpm test:coverage
```

## Layout

- `app/`      1421 source files
- `api/`      1099 source files
- `packages/` 760 source files
- `tests/`    261 source files
- `sdk/`      235 source files
- `directus/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `api/src/ai/chat/controllers/chat.post.test.ts`.
- CI defines what passing means. See `.github/workflows/assign-next-release-milestone.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `api/src/services/mcp-oauth/index.test.ts` is 143KB. 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/directus/directus.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 81 out of 100

[![agent ready](https://agentreadme.com/badge/directus/directus.svg)](https://agentreadme.com/directus/directus)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

All TypeScript repositories

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.

Open an issue, already filled in