agentreadme

Report · marked 25 Aug 2026

danny-avila/LibreChat

Solid foundations, held back in a few specific places.

TypeScript · 42,450 stars · 4,569 files · branch main

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
Instruction quality
Worth fixing: it never states a build, test, or run command; has no code blocks.
03
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.

The full marking

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

Instructions 20/27 B+

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.
Also found: CLAUDE.md
Instruction quality 6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
912 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 20/20 A+

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 (update, add-balance, set-balance, list-balances, user-stats, rebuild:package-lock…)
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
.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
1402 test files against 4187 source files.
e.g. api/app/clients/prompts/formatAgentMessages.spec.js, api/app/clients/prompts/formatGoogleInputs.spec.js, api/app/clients/prompts/formatMessages.spec.js
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
27 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 13/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 133 patterns.
File sizes fit in context 2/6
40 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.
packages/api/src/stream/GenerationJobManager.ts — 291KB
packages/api/src/stream/implementations/RedisJobStore.ts — 211KB
api/server/controllers/agents/client.test.js — 201KB
Repository weight 2/5
About 226MB 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 danny-avila/LibreChat
# AGENTS.md

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

## Setup

```
bun install
```

## Commands

```
bun build           # produce a build
bun lint            # lint
bun format          # format
bun update
bun add-balance
bun set-balance
bun list-balances
bun user-stats
```

## Layout

- `client/`   1783 source files
- `packages/` 1637 source files
- `api/`      573 source files
- `e2e/`      124 source files
- `config/`   47 source files
- `otel/`     4 source files

## Conventions

- Tests live alongside the code they cover, following `api/app/clients/prompts/formatAgentMessages.spec.js`.
- CI defines what passing means. See `.github/workflows/a11y.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/api/src/stream/GenerationJobManager.ts` is 291KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/danny-avila/LibreChat.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 75 out of 100

[![agent ready](https://agentreadme.com/badge/danny-avila/LibreChat.svg)](https://agentreadme.com/danny-avila/LibreChat)

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