AGENTS.md Generator MCP server

<!-- mcp-name: io.github.nushey/agents-md-generator -->

agents-md-generator

MCP server that analyzes codebases with tree-sitter and generates AGENTS.md files.

Python · C# · TypeScript · JavaScript · Go

Installation · Usage · Configuration · How It Works · Contributing

Compatible with any MCP-capable client: Claude Code, Gemini CLI, Cursor, Windsurf, Codex CLI, and others.

The server exposes three tools with a clear separation of concerns:

• generateagentsmd — main entry point. Runs the analysis pipeline internally, embeds writing rules into the payload, and returns chunked read instructions to your client.
• scancodebase** — standalone context tool for when you want deep codebase understanding without generating any file.
• readpayloadchunk — streams the payload back in chunks regardless of which tool produced it.

No large data travels over the MCP wire.

Table of Contents

• Installation
• Option A — pip install + setup wizard
• Option B — uvx
• Usage
• Tools
• Tool Parameters
• What Gets Generated
• How Incremental Scanning Works
• How Large Payloads Are Streamed
• Cache and Payload Location
• Project Configuration
• Options

Installation

Requirements: Python 3.11+, Git, and any MCP-compatible client.

See INSTALLATION.md for the full guide including prerequisites and troubleshooting.

Option A — pip install + setup wizard (recommended)

pip install agents-md-generator
agents-md-generator setup

The setup wizard detects your installed clients, asks whether to configure globally or per-project, and patches the config files automatically. Supports Claude Code, Gemini CLI, Cursor, Windsurf, and Codex CLI.

Option B — uvx (no install needed)

If you have uv installed, uvx runs the package without a prior install step. Add the entry manually to your client's MCP config:

{
  "mcpServers": {
    "agents-md": {
      "command": "uvx",
      "args": ["agents-md-generator"]
    }
  }
}

For Claude Code specifically:

claude mcp add agents-md -- uvx agents-md-generator

claude mcp add defaults to --scope local (current project only). Add -s user to register it for all projects.

Usage

Once registered, ask your AI client:

"Generate the AGENTS.md for this project"

The client will call generateagentsmd automatically. To scan a different directory:

"Generate the AGENTS.md for the project at /path/to/project"

Tools

Shortened. The full README is on GitHub.