Report · marked 9 Oct 2026

mingrammer/diagrams

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

Python · 42,698 stars · 5,507 files · branch master

60 /100 B-

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 14/16Whether an agent can install the project and get it running without a human. Losing marks on pinned runtime version.Verification loop 13/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and test command is discoverable.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on 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

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Test command is discoverable

Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.

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

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

✓Deterministic install 6/6

poetry.lock pins the dependency tree.

Found poetry.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

pyproject.toml scripts

scripts/ directory

–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 13/25 C+

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

✗Tests exist 6/8

31 test files against 328 source files.

e.g. playground/e2e/playground.spec.ts, playground/scripts/test_gen_catalog.py, playground/scripts/test_shim.py

✗Test command is discoverable 0/7

There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.

✓Continuous integration 4/4

6 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

pyproject.toml encodes the house style.

✗Static type checking 0/3

No static type checking.

A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

Context economy 19/20 A+

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

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✗Repository weight 4/5

About 74.1MB 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 mingrammer/diagrams

# AGENTS.md

:art: Diagram as Code for prototyping cloud system architectures

## Setup

```
poetry install
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `diagrams/`   257 source files
- `playground/` 55 source files
- `tests/`      6 source files
- `scripts/`    4 source files
- `website/`    4 source files

## Conventions

- Tests live alongside the code they cover, following `playground/e2e/playground.spec.ts`.
- CI defines what passing means. See `.github/workflows/codeql-analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/mingrammer/diagrams.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Python 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](https://agentreadme.com/badge/mingrammer/diagrams.svg)](https://agentreadme.com/mingrammer/diagrams)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 89 A yt-dlp/yt-dlp 54 C+ microsoft/markitdown 48 C+ Significant-Gravitas/AutoGPT 65 B

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