@customable/docu-mcp (1.0.5)

Published 2025-10-07 17:12:43 +02:00 by jack in customable-mcp/docu-mcp

Installation

@customable:registry=
npm install @customable/docu-mcp@1.0.5
"@customable/docu-mcp": "1.0.5"

About this package

📚 docu-mcp

MCP Server for automatic documentation generation from code with support for multiple languages and formats.

Features

Core Features

  • 📝 generate_docs - Generate documentation from codebase
  • ✍️ update_readme - Update README sections
  • 📊 analyze_codebase - Analyze code structure
  • 🔍 extract_comments - Extract comments and docstrings
  • 📄 generate_api_docs - Generate API documentation

Advanced Features

  • 🎨 Support for PHPDoc, JSDoc, TypeDoc
  • 🚀 Framework-specific docs (Symfony, TYPO3)
  • 📖 Multi-format export (Markdown, HTML, JSON)
  • 🤖 AI-enhanced documentation improvements
  • 📋 Template system for different doc types

Installation

npm install
npm run build

Configuration

Optional environment variables:

  • PROJECT_PATH - Default project path
  • DOC_FORMAT - Default output format (markdown, html, json)
  • LLM_API_URL - LLM API URL for AI enhancements (optional)

Usage

npm start

Examples

Generate documentation

{
  "tool": "generate_docs",
  "arguments": {
    "projectPath": "/path/to/project",
    "outputFormat": "markdown"
  }
}

Update README

{
  "tool": "update_readme",
  "arguments": {
    "projectPath": "/path/to/project",
    "section": "API",
    "content": "## API\n\n..."
  }
}

Analyze codebase

{
  "tool": "analyze_codebase",
  "arguments": {
    "projectPath": "/path/to/project",
    "languages": ["php", "typescript"]
  }
}

Supported Languages

  • PHP: PHPDoc parsing, class/method extraction
  • TypeScript/JavaScript: JSDoc/TypeDoc parsing
  • Python: Docstring parsing
  • General: Comment extraction from any language

Documentation Formats

Markdown

Standard Markdown with code blocks and tables.

HTML

Styled HTML documentation with navigation.

JSON

Structured JSON for programmatic use.

License

MIT

Dependencies

Dependencies

ID Version
@modelcontextprotocol/sdk ^0.5.0

Development dependencies

ID Version
@types/node ^18.0.0
typescript ^5.3.0

Keywords

mcp documentation code-analysis markdown
Details
npm
2025-10-07 17:12:43 +02:00
1
Customable Team
MIT
14 KiB
Assets (1)
Versions (2) View all
2.0.0 2025-10-10
1.0.5 2025-10-07