Report · marked 26 Aug 2026
mattermost/mattermost
An agent can work here, but it will waste turns finding its footing.
TypeScript · 38,901 stars · 15,597 files · branch master
57
/100
B-
Instructions
27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup
2/18Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and discoverable commands.Verification loop
12/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on test command is discoverable and lint and format rules.Context economy
9/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
7/10How quickly anything new can orient itself. Losing marks on license.
Higher is better. Accent marks what is costing you most.
Fix these first
01
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.
02
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
03
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
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.
1,105 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 2/18 F
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✗Discoverable commands
0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
✗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.
Found .nvmrc
–Reproducible environment
n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 12/25 C+
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
3657 test files against 8055 source files.
e.g. .github/actions/save-junit-report-tms/src/__tests__/fixtures/report-basic.xml, .github/actions/save-junit-report-tms/src/__tests__/fixtures/report-duplicate-keys.xml, .github/actions/save-junit-report-tms/src/__tests__/fixtures/report-multiple-suites.xml
✗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
45 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
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 9/20 C
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 145 patterns.
✗File sizes fit in context
0/6
51 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.
webapp/channels/src/components/help/avatar.svg.tsx — 1856KB
webapp/channels/src/components/admin_console/admin_definition.tsx — 512KB
server/channels/store/retrylayer/retrylayer.go — 452KB
✗Repository weight
0/5
About 1262MB 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 Mattermost is an open source platform for secure collaboration across the entire software development lifecycle.. ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` # TODO: nothing declares a build or test command, so an agent has to guess. # This is the single most valuable section of this file. Fill it in. ``` ## Layout - `webapp/` 4270 source files - `server/` 2211 source files - `e2e-tests/` 1385 source files - `tools/` 133 source files - `docs/` 39 source files - `api/` 4 source files ## Conventions - Tests live alongside the code they cover, following `.github/actions/save-junit-report-tms/src/__tests__/fixtures/report-basic.xml`. - CI defines what passing means. See `.github/workflows/api.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `webapp/channels/src/components/help/avatar.svg.tsx` is 1856KB. It will not fit comfortably in context, so read it in parts. - No lockfile is committed, so an install here may not match what CI produced. --- 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/mattermost/mattermost.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/mattermost/mattermost)Other TypeScript repositories, marked
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.