Report · marked 25 Aug 2026
RocketChat/Rocket.Chat
An agent can work here, but it will waste turns finding its footing.
TypeScript · 46,032 stars · 10,197 files · branch develop
63
/100
B
Instructions
17/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop
15/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 static type checking.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
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.
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 17/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
6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
2,467 characters, a workable length
uses headings, so an agent can skim it
✗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 16/20 A-
Whether an agent can install the project and get it running without a human.
✓Deterministic install
6/6
yarn.lock pins the dependency tree.
Found yarn.lock
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
package.json scripts (build, build:services, dev, dsv, ms, fossify…)
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.
Found .tool-versions
✓Reproducible environment
2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 15/25 B-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
1443 test files against 9013 source files.
e.g. apps/meteor/app/apps/server/bridges/router.spec.ts, apps/meteor/app/emoji-native/lib/generateEmojiData.spec.ts, apps/meteor/app/emoji-native/lib/getEmojiConfig.spec.ts
✗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
16 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
eslint.config.mjs encodes the house style.
✗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 41 patterns.
✗File sizes fit in context
0/6
11 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.
.yarn/releases/yarn-4.18.0.cjs — 3696KB
apps/meteor/tests/end-to-end/api/users.ts — 202KB
packages/livechat/src/lib/emoji/emojis.ts — 176KB
✗Repository weight
0/5
About 2114MB 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 The Secure CommsOS™ for mission-critical operations ## Setup ``` yarn install ``` ## Commands ``` yarn dev # run locally yarn build # produce a build yarn lint # lint yarn build:services yarn dsv yarn ms yarn fossify yarn fuselage ``` ## Layout - `apps/` 5821 source files - `packages/` 2873 source files - `ee/` 304 source files - `scripts/` 9 source files ## Conventions - Tests live alongside the code they cover, following `apps/meteor/app/apps/server/bridges/router.spec.ts`. - CI defines what passing means. See `.github/workflows/auto-close-duplicates.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `.yarn/releases/yarn-4.18.0.cjs` is 3696KB. It will not fit comfortably in context, so read it in parts. --- 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/RocketChat/Rocket.Chat.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/RocketChat/Rocket.Chat)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.