agentreadme

Report · marked 10 Oct 2026

QuantumNous/new-api

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

Go · 49,626 stars · 2,592 files · branch main

Fix these first

01
Instruction quality
Worth fixing: it's 27k characters, which burns context on every single turn; has no code blocks.
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
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

The full marking

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

Instructions 23/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.
Also found: CLAUDE.md
✗Instruction quality 8/12
Real instructions, with gaps.
Worth fixing: it's 27k characters, which burns context on every single turn; has no code blocks.
names the actual commands to run
uses headings, so an agent can skim it
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 20/20 A+

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

✓Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
✓Environment config 4/4
.env.example documents what the app needs to run.
✓Pinned runtime version 2/2
The language runtime version is pinned.
go.mod declares a Go version
✓Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 19/22 A

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

✓Tests exist 8/8
466 test files against 2424 source files.
e.g. bin/time_test.sh, common/api_type_task_plugin_test.go, common/audio_case_test.go
✓Test command is discoverable 7/7
An agent can find and run `make test`.
✓Continuous integration 4/4
6 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 15/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 43 patterns.
✗File sizes fit in context 2/6
4 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.
web/src/features/channels/components/drawers/channel-mutate-drawer.tsx — 178KB
relay/channel/task/jsplugin/adaptor_test.go — 112KB
web/src/features/channels/components/dialogs/param-override-editor-dialog.tsx — 110KB
✗Repository weight 4/5
About 81.5MB 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 QuantumNous/new-api
# AGENTS.md

A unified AI model hub for aggregation & distribution. It supports cross-converting various LLMs into OpenAI-compatible, Claude-compatible, or Gemini-compatible formats. A centralized gateway for personal and enterprise model management.

## Setup

```
go mod download
```

## Commands

```
make build-web
make build-all-web
make start-api
make dev-api
make dev-api-rebuild
make dev-web
```

## Layout

- `web/`        1371 source files
- `relay/`      248 source files
- `relaykit/`   132 source files
- `controller/` 128 source files
- `model/`      112 source files
- `service/`    111 source files

## Conventions

- Tests live alongside the code they cover, following `bin/time_test.sh`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `web/src/features/channels/components/drawers/channel-mutate-drawer.tsx` is 178KB. 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/QuantumNous/new-api.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Go AGENTS.md looks like covers what to add by hand, and 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 88 out of 100

[![agent ready](https://agentreadme.com/badge/QuantumNous/new-api.svg)](https://agentreadme.com/QuantumNous/new-api)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- JuliusBrussee/caveman 81 A-

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