Report · marked 25 Aug 2026

KeygraphHQ/shannon

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

TypeScript · 47,198 stars · 227 files · branch main

87 /100 A

Instructions 22/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 18/20Whether an agent can install the project and get it running without a human. Losing marks on pinned runtime version.Verification loop 20/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 static type checking.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on repository weight.Navigability 10/10How quickly anything new can orient itself. Full marks.

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

Fix these first

Tests exist

Coverage is thin enough that an agent can break real behavior and still see green.

Agent instruction file

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.

Pinned runtime version

Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

The full marking

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

Instructions 22/27 A-

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

✗Agent instruction file 9/12

CLAUDE.md is present, but not the vendor-neutral AGENTS.md.

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.

✗Instruction quality 10/12

Specific enough that an agent can act on it.

Worth fixing: it's 28k characters, which burns context on every single turn.

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 18/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, check, biome, biome:fix, clean, temporal:worker…)

✓Environment config 4/4

.env.example documents what the app needs to 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 20/25 A-

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✗Tests exist 4/8

1 test file against 123 source files.

Coverage is thin enough that an agent can break real behavior and still see green.

e.g. apps/cli/src/model-spec.ts

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

4 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

biome.json encodes the house style.

✗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 19/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 4/5

About 63.0MB 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 KeygraphHQ/shannon

undefined

Open the raw markdown or curl -o AGENTS.md agentreadme.com/draft/KeygraphHQ/shannon.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/KeygraphHQ/shannon.svg)](https://agentreadme.com/KeygraphHQ/shannon)

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