agentreadme

Report · marked 10 Oct 2026

Comfy-Org/ComfyUI

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

Python · 136,729 stars · 1,281 files · branch master

Fix these first

01
Instruction quality
Worth fixing: it's 25k characters, which burns context on every single turn; it never states a build, test, or run command; has no code blocks.
02
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
03
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

The full marking

Every deduction below names the file or setting it came from.

Instructions 19/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 4/12
Present but too thin to change an agent's behavior.
Worth fixing: it's 25k characters, which burns context on every single turn; it never states a build, test, or run command; has no code blocks.
uses headings, so an agent can skim it
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 5/20 F

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

✗Deterministic install 3/6
Only requirements.txt, which pins loosely at best.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✗Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
✗Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
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 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
244 test files against 982 source files.
e.g. tests-unit/app_test/custom_node_manager_test.py, tests-unit/app_test/database_path_test.py, tests-unit/app_test/frontend_manager_test.py
✓Test command is discoverable 7/7
An agent can find and run `pytest`.
✓Continuous integration 4/4
28 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 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 26 patterns.
✗File sizes fit in context 2/6
11 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.
comfy_api_nodes/apis/__init__.py — 209KB
comfy_api_nodes/nodes_bytedance.py — 162KB
comfy_extras/nodes_mesh_postprocess.py — 148KB
✗Repository weight 4/5
About 102.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 Comfy-Org/ComfyUI
# AGENTS.md

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

## Setup

```
pip install -r requirements.txt
```

## Commands

```
ruff check .   # lint
```

## Layout

- `comfy/`           323 source files
- `tests-unit/`      234 source files
- `comfy_extras/`    169 source files
- `comfy_api_nodes/` 95 source files
- `app/`             47 source files
- `comfy_api/`       36 source files

## Conventions

- Tests live alongside the code they cover, following `tests-unit/app_test/custom_node_manager_test.py`.
- CI defines what passing means. See `.github/workflows/api-node-template.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `comfy_api_nodes/apis/__init__.py` is 209KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/Comfy-Org/ComfyUI.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 68 out of 100

[![agent ready](https://agentreadme.com/badge/Comfy-Org/ComfyUI.svg)](https://agentreadme.com/Comfy-Org/ComfyUI)

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