agentreadme

Report · marked 25 Aug 2026

paperclipai/paperclip

Ready for an agent to work in without hand-holding.

TypeScript · 79,354 stars · 5,039 files · branch master

86 /100 A
Instructions 27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 21/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 and static type checking.Context economy 11/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability 9/10How quickly anything new can orient itself. Losing marks on repository description.

Higher is better. Accent marks what is costing you most.

Fix these first

01
File sizes fit in context
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.
02
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
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 27/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.
✓Instruction quality 12/12
Specific enough that an agent can act on it.
9,769 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 3/3
README has a clear getting-started section.
Setup 20/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 (postinstall, preflight:workspace-links, dev, dev:watch, dev:once, dev:list…)
scripts/ directory
✓Environment config 4/4
.env.example documents what the app needs to run.
✓Pinned runtime version 2/2
The language runtime version is pinned.
Found .nvmrc
✓Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 21/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
1517 test files against 3841 source files.
e.g. .agents/skills/company-creator/references/companies-spec.md, .agents/skills/garden-inbox/scripts/garden-inbox.test.mjs, .agents/skills/paperclip-page/scripts/publish.test.mjs
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
10 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 2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
Context economy 11/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 60 patterns.
✗File sizes fit in context 0/6
71 source files are 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.
server/src/services/heartbeat.ts — 751KB
server/src/routes/issues.ts — 504KB
server/src/services/issues.ts — 349KB
✗Repository weight 2/5
About 207MB 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 paperclipai/paperclip 
undefined

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/paperclipai/paperclip.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 86 out of 100

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

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