Report · marked 26 Aug 2026

pingcap/tidb

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

Go · 40,472 stars · 7,604 files · branch master

85 /100 A

Instructions 27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup 16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 22/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Full marks.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 10/10How quickly anything new can orient itself. Full marks.

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

Fix these first

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.

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.

Repository weight

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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.

Also found: CLAUDE.md

✓Instruction quality 12/12

Specific enough that an agent can act on it.

13,031 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 16/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 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 2/2

dockerfile gives a known-good environment.

Verification loop 22/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

3821 test files against 5142 source files.

e.g. br/COMPATIBILITY_TEST.md, br/cmd/br/main_test.go, br/pkg/aws/ebs_test.go

✓Test command is discoverable 7/7

An agent can find and run `make test`.

✓Continuous integration 4/4

7 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

.golangci.yml encodes the house style.

–Static type checking n/a

Not applicable — the Go compiler type checks every build.

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 59 patterns.

✗File sizes fit in context 0/6

69 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.

pkg/parser/parser.go — 8001KB

pkg/util/collate/ucadata/unicode_0900_ai_ci_data_generated.go — 2107KB

pkg/util/collate/ucadata/unicode_ci_data_generated.go — 735KB

✗Repository weight 0/5

About 750MB 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 pingcap/tidb

# AGENTS.md

TiDB is built for agentic workloads that grow unpredictably, with ACID guarantees and native support for transactions, analytics, and vector search. No data silos. No noisy neighbors. No infrastructure ceiling.

## Setup

```
go mod download
```

## Commands

```
make help
make help
make default
make server-admin-check
make buildsucc
make dev                  # run locally
```

## Layout

- `pkg/`       3684 source files
- `lightning/` 631 source files
- `br/`        485 source files
- `tests/`     128 source files
- `dumpling/`  116 source files
- `build/`     53 source files

## Conventions

- Tests live alongside the code they cover, following `br/COMPATIBILITY_TEST.md`.
- CI defines what passing means. See `.github/workflows/bazel-build-crossbuild.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `pkg/parser/parser.go` is 8001KB. 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/pingcap/tidb.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](https://agentreadme.com/badge/pingcap/tidb.svg)](https://agentreadme.com/pingcap/tidb)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 85 A golang/go 31 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 82 A- fatedier/frp 96 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