Report · marked 25 Aug 2026

typicode/json-server

An agent can work here, but it will waste turns finding its footing.

JavaScript · 75,686 stars · 33 files · branch main

68 /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 14/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 6/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

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Written documentation

Prose that explains why the architecture is the way it is saves an agent from re-deriving it wrong.

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 14/14 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 (dev, build, prepublishOnly, typecheck, test, lint…)

–Environment config n/a

Not applicable — this reads as a library, with no environment to configure.

✓Pinned runtime version 2/2

The language runtime version is pinned.

package.json engines.node >=22.12.0

–Reproducible environment n/a

Not applicable — a library doesn't need a container to be worked on.

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

6 test files against 16 source files.

e.g. src/adapters/normalized-adapter.test.ts, src/app.test.ts, src/matches-where.test.ts

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

2 GitHub Actions workflows define what "passing" means.

✗Lint and format rules 0/3

No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.

A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

✓Static type checking 3/3

Strict type checking is on, which catches a whole class of agent mistakes before they run.

Context economy 20/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 7 patterns.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✓Repository weight 5/5

About 4.3MB 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 — drafted for typicode/json-server

# AGENTS.md

Get a full fake REST API with zero coding in less than 30 seconds (seriously)

## Setup

```
pnpm install
```

## Commands

```
pnpm dev              # run locally
pnpm build            # produce a build
pnpm test             # run the test suite, must pass before any commit
pnpm typecheck        # type check without emitting
pnpm lint             # lint
pnpm prepublishOnly
pnpm fmt
pnpm fmt:check
```

## Layout

- `src/` 16 source files

## Conventions

- Tests live alongside the code they cover, following `src/adapters/normalized-adapter.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/node.js.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/typicode/json-server.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](https://agentreadme.com/badge/typicode/json-server.svg)](https://agentreadme.com/typicode/json-server)

Other JavaScript repositories, marked

react/react 71 B+ affaan-m/ECC 90 A trekhleb/javascript-algorithms 69 B Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 77 B+

All JavaScript 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