MCP DocGen Documentation

MCP DocGen is a powerful documentation generator specifically designed for Model Control Protocol (MCP) servers. It automatically analyzes your code and generates beautiful, comprehensive documentation sites.

🚀 Currently in Development
This project is actively being developed. Check the GitHub repository for the latest updates and contribute to the development!

What is MCP DocGen?

MCP DocGen solves the common problem of maintaining up-to-date documentation for MCP server implementations. Instead of manually writing and updating docs, simply point MCP DocGen at your codebase and get:

Automatic API Documentation - Extract endpoints, parameters, and responses
Interactive Examples - Generate working code samples
Beautiful UI - Professional-looking documentation sites
Zero Configuration - Works out of the box with sensible defaults

Key Features

📖 Smart Analysis

Automatically discovers and documents your MCP server structure, endpoints, and capabilities.

🎨 Multiple Themes

Choose from built-in themes or create custom themes to match your brand.

🚀 Easy Deployment

Deploy to GitHub Pages, Netlify, or any static hosting platform with one command.

Installation

Install MCP DocGen globally using npm:

                        # Install globally
npm install -g mcp-docgen

# Or install locally in your project
npm install --save-dev mcp-docgen

# Or use npx to run without installing
npx mcp-docgen --help
                    

⚠️ Development Status
The npm package is not yet published. Please clone the repository from GitHub and build from source during development.

Quick Start

Get your documentation up and running in minutes:

1. Generate Documentation

                        # Generate docs for your MCP server
mcp-docgen generate ./path/to/your/mcp-server

# Specify output directory
mcp-docgen generate ./my-server --output ./docs
                    

2. Preview Locally

                        # Serve documentation locally
mcp-docgen serve ./docs

# Custom port
mcp-docgen serve ./docs --port 8080
                    

3. Deploy

                        # Deploy to GitHub Pages
mcp-docgen deploy --platform github-pages

# Deploy to Netlify
mcp-docgen deploy --platform netlify
                    

Contributing

MCP DocGen is an open-source project and we welcome contributions! Here's how you can help:

Development Setup

                        # Clone the repository
git clone https://github.com/masterthefly/mcp-docgen.git
cd mcp-docgen

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build the project
npm run build

# Run tests
npm test
                    

How to Contribute

🐛 Report Bugs - Open an issue on GitHub
💡 Feature Requests - Suggest new features
📝 Documentation - Improve docs and examples
💻 Code - Submit pull requests

Visit the GitHub repository to get started!