agentreadme

Report · marked 10 Oct 2026

sortie-ai/docs

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

HTML · 1 stars · 164 files · branch main

63 /100 B
Instructions 19/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 14/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and reproducible environment.Verification loop 4/22Whether 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 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 5/10How quickly anything new can orient itself. Losing marks on written documentation and license.

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

Fix these first

01
Tests exist
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.
02
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.
03
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.

The full marking

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

Instructions 19/27 B+

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 8/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command.
4,891 characters, a workable length
uses headings, so an agent can skim it
includes copyable code blocks
✗README as an entry point 2/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 14/20 B+

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

✓Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (unshallow, prebuild, build, server, lint:links)
scripts/ directory
✗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.
go.mod declares a Go version
✗Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 4/22 F

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

✗Tests exist 0/8
No test files found. An agent has no way to know whether its change broke anything.
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.
✗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
3 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 n/a
Not applicable — the Go compiler type checks every build.
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 6 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 6.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 sortie-ai/docs 
# AGENTS.md

Documentation for Sortie - AI coding agent orchestrator

## Setup

```
npm ci
```

## Commands

```
npm run build        # produce a build
npm run unshallow
npm run prebuild
npm run server
npm run lint:links
```

## Layout

- `assets/`  5 source files
- `static/`  3 source files
- `scripts/` 1 source file

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- CI defines what passing means. See `.github/workflows/links.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/sortie-ai/docs.md

A draft gets the commands right and stops at the things only a maintainer knows. what AGENTS.md is explains the format itself.

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 63 out of 100

[![agent ready](https://agentreadme.com/badge/sortie-ai/docs.svg)](https://agentreadme.com/sortie-ai/docs)

Other HTML repositories, marked

f/prompts.chat 85 A docker/awesome-compose 38 D QSCTech/zju-icicles 26 F PKUanonym/REKCARC-TSC-UHT 30 D dejan23/agentreadme 98 A+

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