next-agents-md

What does this tool actually do?

This tool helps AI coding agents like Claude or Cursor access the correct Next.js documentation for your project. It detects your Next.js version, downloads the matching docs, and adds a reference index to your CLAUDE.md or AGENTS.md file. The agent then reads the docs from local files instead of relying on outdated training data.

Deep dive

next-agents-md is a command-line tool that bridges the gap between AI coding agents and up-to-date Next.js documentation. When an AI agent works on a Next.js project, it often relies on its training data, which may be outdated or incomplete. This tool solves that by automatically detecting the Next.js version in your project, downloading the corresponding official documentation from the Next.js website, and injecting a compressed index into your CLAUDE.md or AGENTS.md file. The index contains references to documentation files stored in a local `.next-docs/` directory. When the AI agent encounters a Next.js task, it can read the relevant documentation from these local files, ensuring it always uses the correct and most current information. The tool is designed to be non-intrusive: it only modifies the markdown file between special markers (`<!-- NEXT-AGENTS-MD-START -->` and `<!-- NEXT-AGENTS-MD-END -->`), so you can easily update or remove the index. It supports both interactive and non-interactive modes, allowing you to specify the version or target file via command-line flags. This is particularly useful for teams that want to ensure consistent documentation access across different AI agents and projects.

Additional use cases

• Automate documentation updates in CI/CD pipelines for Next.js projects.
• Quickly onboard new developers by providing AI agents with accurate Next.js references.