byDeusz agent MD docs

A CLI tool that downloads up-to-date framework documentation and generates a minified docs index for your AGENTS.md or CLAUDE.md file -- so AI coding agents always know where to find the right docs.

Inspiration

This project was inspired by Vercel's research showing that a compressed docs index in AGENTS.md achieved a 100% pass rate on their agent evals, outperforming skill-based approaches. The key insight: passive context (always available in AGENTS.md) beats active retrieval (skills the agent must decide to invoke).

Read the full article: AGENTS.md outperforms skills in our agent evals

This tool extends that approach beyond Next.js to 12 frameworks across multiple categories, so any project can benefit from retrieval-led reasoning.

Supported Frameworks

Frontend

• React - Full documentation from reactjs/react.dev
• Next.js - Full documentation from vercel/next.js
• Vue - Full documentation from vuejs/docs
• Nuxt - Full documentation from nuxt/nuxt

Backend

• NestJS - Full documentation from nestjs/docs.nestjs.com
• Django - Full documentation from django/django
• FastAPI - Full documentation from fastapi/fastapi
• Django REST Framework - Full documentation from encode/django-rest-framework
• Express - Full documentation from expressjs/expressjs.com

Bundlers

• Vite - Full documentation from vitejs/vite

ORMs

• Prisma - Full documentation from prisma/docs
• TypeORM - Full documentation from typeorm/typeorm
• Drizzle ORM - Full documentation from drizzle-team/drizzle-orm-docs

Styling

• Tailwind CSS - Full documentation from tailwindlabs/tailwindcss.com

Usage

The CLI will:

1. Ask which AI tool you use (GitHub Copilot, Cursor, or Claude Code)
2. Ask which framework documentation to download (frontend / backend / bundler / ORM / styling)
3. Clear the .docs/ folder and download fresh docs
4. Generate a minified index and insert it into AGENTS.md or CLAUDE.md
5. Save a manifest (.docs/manifest.json) to track installed docs

Via npx

npx @bydeusz/agent-md-docs

Upgrade existing docs

To re-download and update all previously installed docs without going through the prompts:

npx @bydeusz/agent-md-docs --upgrade

This reads the manifest and re-downloads everything in one go.

Local development

npm install
npm run build
node dist/index.js

What it does

The tool downloads markdown documentation from a framework's GitHub repository and saves it locally in a .docs/ folder. It then scans the downloaded docs and generates a compact, single-line index wrapped in HTML comment markers, like:

<!-- NESTJS-AGENTS-MD-START -->[NestJS Docs Index]|root: ./.docs/nestjs|...|cli:{libraries.md,overview.md,...}|...<!-- NESTJS-AGENTS-MD-END -->

This index is inserted into your AGENTS.md or CLAUDE.md file. AI agents can use this index to quickly locate and read the relevant documentation for the framework being used in the project.

Adding more frameworks

To add a new framework, create a config file in src/frameworks/ and register it in src/frameworks/registry.ts. Each framework config specifies:

• Category (frontend, backend, bundler, orm, or styling)
• GitHub repository and branch
• Path to the documentation content
• File extensions to download (.md, .mdx, etc.)
• Optional extension conversion (e.g. .txt → .md for Django)
• Comment markers for the index block