agentreadme

Report · marked 25 Aug 2026

unionlabs/union

An agent can work here, but it will waste turns finding its footing.

Rust · 73,827 stars · 4,439 files · branch main

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
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 3/27 F

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
README as an entry point 3/3
README has a clear getting-started section.
Setup 12/20 B-

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 (prepare, docgen)
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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 20/22 A

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

Tests exist 6/8
220 test files against 2496 source files.
e.g. 11-cometbls/zk_verifier_test.go, app2/src/demo.spec.ts, app2/src/lib/typeclass/Writer.test.ts
Test command is discoverable 7/7
An agent can find and run `cargo test`.
Continuous integration 4/4
13 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
biome.json encodes the house style.
Static type checking n/a
Not applicable — the Rust compiler type checks every build.
Context economy 11/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 101 patterns.
File sizes fit in context 0/6
12 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.
lib/ssz/tests/spec_conformance/basic_vector_invalid.rs — 6545KB
lib/ssz/tests/spec_conformance/containers_valid.rs — 4370KB
lib/ssz/tests/spec_conformance/basic_vector_valid.rs — 3580KB
Repository weight 2/5
About 485MB 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 unionlabs/union
# AGENTS.md

The trust-minimized, zero-knowledge bridging protocol, designed for censorship resistance, extremely high security, and usage in decentralized finance.

## Setup

```
pnpm install
```

## Commands

```
pnpm prepare
pnpm docgen
```

## Layout

- `lib/`       637 source files
- `app2/`      469 source files
- `cosmwasm/`  240 source files
- `generated/` 202 source files
- `ts-sdk/`    173 source files
- `voyager/`   164 source files

## Conventions

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

## Gotchas

- `lib/ssz/tests/spec_conformance/basic_vector_invalid.rs` is 6545KB. 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/unionlabs/union.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 57 out of 100

[![agent ready](https://agentreadme.com/badge/unionlabs/union.svg)](https://agentreadme.com/unionlabs/union)

Other Rust repositories, marked

ultraworkers/claw-code 69 B farion1231/cc-switch 64 B rustdesk/rustdesk 68 B openai/codex 82 A- rust-lang/rust 65 B tauri-apps/tauri 62 B

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