@j0kz/doc-generator-mcp

Auto-generate JSDoc, README, and API documentation from code

🎉 What's New in v1.0.26

• 📚 Comprehensive Examples: New example files in examples/doc-generator/
• 🎯 Better Error Messages: Improved validation and error handling
• ✅ Production Ready: Enhanced JSDoc generation and API documentation

🚀 Quick Start

⭐ Option 1: Install ALL 8 Tools (Recommended)

Get the complete suite with ONE command:

Claude Code:

# Mac/Linux
curl -fsSL https://raw.githubusercontent.com/j0kz/mcp-agents/main/install-all.sh | bash

# Windows (PowerShell)
irm https://raw.githubusercontent.com/j0kz/mcp-agents/main/install-all.ps1 | iex

Cursor/Windsurf:

# Download complete config
curl -o ~/.cursor/mcp_config.json https://raw.githubusercontent.com/j0kz/mcp-agents/main/mcp_config_all.json

# Or for Windsurf
curl -o ~/.windsurf/mcp_config.json https://raw.githubusercontent.com/j0kz/mcp-agents/main/mcp_config_all.json

Option 2: Install Only This Tool

Claude Code:

claude mcp add doc-generator "npx @j0kz/doc-generator-mcp" --scope user

Cursor/Windsurf: Add to mcp_config.json:

{
  "mcpServers": {
    "doc-generator": {
      "command": "npx",
      "args": ["@j0kz/doc-generator-mcp"]
    }
  }
}

Start Using Immediately

After setup, just chat naturally with your AI:

💬 You: "Document the API endpoints in server.js"
🤖 AI: *Generates OpenAPI spec* Created swagger.json with 12 endpoints, parameters, responses, and examples...

💬 You: "Create JSDoc comments for UserService"
🤖 AI: *Adds documentation* Added @param, @returns, @throws for all 8 methods with descriptions and type info...

💬 You: "Generate README for this project"
🤖 AI: *Analyzes code* Created README with: Overview, Installation, API Reference, Usage Examples, Configuration...

✨ Features

📝 JSDoc Generation - Complete function and class documentation 📚 README Creation - Professional project documentation 🔌 API Docs - OpenAPI/Swagger specs from code ⚡ Markdown Tables - Clean documentation formatting

📦 Complete @j0kz MCP Suite

Get all 8 professional development tools - install individually or all at once:

# 🎯 Code Quality Suite
npx @j0kz/smart-reviewer-mcp      # AI code review
npx @j0kz/test-generator-mcp      # Auto-generate tests
npx @j0kz/refactor-assistant-mcp  # Refactoring help

# 🏗️ Architecture & Design
npx @j0kz/architecture-analyzer-mcp  # Architecture analysis
npx @j0kz/api-designer-mcp           # API design
npx @j0kz/db-schema-mcp              # Database schemas

# 📚 Documentation & Security
npx @j0kz/doc-generator-mcp       # Auto-generate docs
npx @j0kz/security-scanner-mcp    # Security scanning

👉 View complete collection on GitHub

🎯 How It Works

1. Install once - Run the setup command for your editor
2. Restart editor - Reload to activate the MCP
3. Chat naturally - Just ask your AI assistant to help
4. Get results - The MCP tools work behind the scenes

No configuration files, no complex setup, no API keys needed!

🔧 Editor Support

| Editor | Status | Notes | | --------------- | --------------- | -------------- | | Claude Code | ✅ Full support | Recommended | | Cursor | ✅ Full support | Native MCP | | Windsurf | ✅ Full support | Built-in MCP | | Roo Code | ✅ Full support | MCP compatible | | Continue | ✅ Full support | MCP plugin | | Zed | ✅ Full support | MCP support |

Any MCP-compatible editor works!

❓ Troubleshooting

MCP not showing up?

• Restart your editor after installation
• Check: claude mcp list (Claude Code) to verify connection

Commands not working?

• Make sure Node.js is installed (node --version)
• Try reinstalling: Remove and re-add the MCP

Still stuck?

• Open an issue
• Check full documentation

📄 License

MIT © j0KZ

Explore more tools: github.com/j0KZ/mcp-agents | npm: @j0kz