agentreadme

Report Β· marked 10 Oct 2026

TanStack/query

Solid foundations, held back in a few specific places.

TypeScript Β· 50,411 stars Β· 3,606 files Β· branch main

Fix these first

01
Instruction quality
Worth fixing: it never states a build, test, or run command; 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 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.
βœ—Instruction quality 6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
455 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 14/14 A+

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

βœ“Deterministic install 6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
βœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (clean, test, test:pr, test:ci, test:eslint, test:oxlint…)
scripts/ directory
–Environment config n/a
Not applicable β€” this reads as a library, with no environment to configure.
βœ“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 22/25 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
347 test files against 1281 source files.
e.g. packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts, packages/angular-query-experimental/src/__tests__/infinite-query-options.test.ts, packages/angular-query-experimental/src/__tests__/inject-devtools-panel.test.ts
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
4 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 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
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.
packages/react-query/src/__tests__/useQuery.test.tsx β€” 185KB
packages/preact-query/src/__tests__/useQuery.test.tsx β€” 181KB
packages/solid-query/src/__tests__/useQuery.test.tsx β€” 154KB
βœ—Repository weight 4/5
About 131.2MB 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 TanStack/query
# AGENTS.md

πŸ€– Powerful asynchronous state management, server-state utilities and data fetching for the web. TS/JS, React Query, Solid Query, Svelte Query and Vue Query.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
pnpm build         # produce a build
pnpm test          # run the test suite, must pass before any commit
pnpm format        # format
pnpm clean
pnpm test:pr
pnpm test:ci
pnpm test:eslint
```

## Layout

- `packages/`     807 source files
- `examples/`     409 source files
- `integrations/` 55 source files
- `scripts/`      7 source files

## Conventions

- Tests live alongside the code they cover, following `packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/autofix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/react-query/src/__tests__/useQuery.test.tsx` is 185KB. 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/TanStack/query.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript 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 84 out of 100

[![agent ready](https://agentreadme.com/badge/TanStack/query.svg)](https://agentreadme.com/TanStack/query)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 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