← AgentReady
davidcjw/agents-md-generator

Generate an AGENTS.md for any GitHub repo using Claude AI

TypeScript⭐ 1
7.3out of 10
Ready
AgentReady Score
7.3/10
Ready

Strengths

  • ✓ File type: AGENTS.md
  • ✓ Contains executable commands (code blocks)
  • ✓ Test / build commands documented
  • ✓ Structured sections (3+ headers)
  • ✓ Contains code examples / commands

Top improvements

  • Explicit constraints (ALWAYS / NEVER / AVOID…) (+12 pts)
  • Contains runnable commands (+6 pts)
  • Architecture / project overview (+5 pts)
  • Test / build workflow documented (+4 pts)

Detailed Report

🤖

AI Instruction File

AGENTS.md
53/65
✓
File type: AGENTS.md20/20

Vendor-neutral — recognized by all major agents

✓
Contains executable commands (code blocks)15/15

Agents can copy-paste commands directly

·
Explicit constraints (ALWAYS / NEVER / AVOID…)0/12

No ALWAYS/NEVER/AVOID directives — agents respond well to explicit rules

✓
Test / build commands documented10/10

Test or build commands found

✓
Structured sections (3+ headers)5/5

Well-organized with clear sections

✓
Architecture / directory overview3/3

Codebase structure described

📖

README

20/25
✓
Contains code examples / commands8/8

Executable examples present

✓
Structured with 3+ sections7/7

Well-sectioned README

✓
Setup / installation instructions5/5

Installation or setup section found

·
Architecture / project overview0/5

No architecture section — helps agents understand the project structure

🤝

CONTRIBUTING.md

Not found
0/10
·
Contains runnable commands0/6

Add CONTRIBUTING.md with test/lint commands

·
Test / build workflow documented0/4

Add CONTRIBUTING.md with test/lint commands

🏷️

Embed Badge

AgentReady Score badge previewLive preview
[![AgentReady Score](https://agentready.davidcjw.com/api/badge/davidcjw/agents-md-generator)](https://agentready.davidcjw.com/results/davidcjw/agents-md-generator)

Analyzed 8/7/2026, 2:15:05 PM · Analyze another repo