agentreadme

Report · marked 10 Oct 2026

DayuanJiang/next-ai-draw-io

Solid foundations, held back in a few specific places.

TypeScript · 36,162 stars · 411 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
Pinned runtime version
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

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 18/20 A

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

✓Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (predev, dev, prebuild, build, start, lint…)
✓Environment config 4/4
env.example documents what the app needs to 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 2/2
dockerfile gives a known-good environment.
Verification loop 25/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
95 test files against 284 source files.
e.g. packages/mcp-server/tests/diagram-operations.test.ts, packages/mcp-server/tests/edit-diagram.test.ts, packages/mcp-server/tests/edit-gate.test.ts
✓Test command is discoverable 7/7
An agent can find and run `npm run check`.
✓Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
.eslintrc.json encodes the house style.
✓Static type checking 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 18/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 51 patterns.
✗File sizes fit in context 4/6
1 source file is 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.
tests/e2e/workspace.spec.ts — 238KB
✓Repository weight 5/5
About 8.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 DayuanJiang/next-ai-draw-io
# AGENTS.md

A next.js web application that integrates AI capabilities with draw.io diagrams. This app allows you to create, modify, and enhance diagrams through natural language commands and AI-assisted visualization.

## Setup

```
npm ci
```

## Commands

```
npm run dev      # run locally
npm run start    # run the app
npm run build    # produce a build
npm run test     # run the test suite, must pass before any commit
npm run lint     # lint
npm run format   # format
npm run check    # lint and type check
npm run predev
```

## Layout

- `tests/`      84 source files
- `components/` 58 source files
- `lib/`        45 source files
- `packages/`   34 source files
- `app/`        25 source files
- `electron/`   15 source files

## Conventions

- Tests live alongside the code they cover, following `packages/mcp-server/tests/diagram-operations.test.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/auto-format.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `tests/e2e/workspace.spec.ts` is 238KB. 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/DayuanJiang/next-ai-draw-io.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 72 out of 100

[![agent ready](https://agentreadme.com/badge/DayuanJiang/next-ai-draw-io.svg)](https://agentreadme.com/DayuanJiang/next-ai-draw-io)

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