agentreadme

Report ยท marked 25 Aug 2026

FuelLabs/sway

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

Rust ยท 61,484 stars ยท 8,017 files ยท branch master

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 2/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 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/16 A

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

โœ“Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
โœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
justfile
โ€“Environment config n/a
Not applicable โ€” this reads as a library, with no environment to configure.
โœ—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 2/2
.devcontainer/devcontainer.json 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
6463 test files against 773 source files.
e.g. docs/book/src/forc/commands/forc_test.md, forc-pkg/tests/invalid/duplicate_keys/Forc.toml, forc-pkg/tests/invalid/namespace_without_version/Forc.toml
โœ“Test command is discoverable 7/7
An agent can find and run `cargo test`.
โœ“Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
โœ“Lint and format rules 3/3
clippy.toml encodes the house style.
โ€“Static type checking n/a
Not applicable โ€” the Rust 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 23 patterns.
โœ—File sizes fit in context 2/6
7 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.
sway-core/src/ir_generation/function.rs โ€” 248KB
sway-core/src/transform/to_parsed_lang/convert_parse_tree.rs โ€” 198KB
sway-error/src/error.rs โ€” 183KB
โœ—Repository weight 4/5
About 125.6MB 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 FuelLabs/sway
# AGENTS.md

๐ŸŒด Empowering everyone to build reliable and efficient smart contracts.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `sway-core/`    256 source files
- `forc-plugins/` 79 source files
- `sway-lsp/`     74 source files
- `swayfmt/`      71 source files
- `test/`         59 source files
- `sway-ir/`      47 source files

## Conventions

- Tests live alongside the code they cover, following `docs/book/src/forc/commands/forc_test.md`.
- CI defines what passing means. See `.github/workflows/benchmark.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `sway-core/src/ir_generation/function.rs` is 248KB. 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/FuelLabs/sway.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 66 out of 100

[![agent ready](https://agentreadme.com/badge/FuelLabs/sway.svg)](https://agentreadme.com/FuelLabs/sway)

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