@customable/docu-mcp (2.0.0)
Installation
@customable:registry=npm install @customable/docu-mcp@2.0.0"@customable/docu-mcp": "2.0.0"About this package
📚 docu-mcp
MCP Server for automatic documentation generation from code - featuring multi-language parsing, format support, and comprehensive testing.
What's New in v2.0.0
✨ Complete Refactor - Modular architecture with 57% code reduction
🧪 29 Unit Tests - Full test coverage with Vitest
🎯 100% Type Safety - Eliminated all any types
📚 Complete JSDoc - Comprehensive API documentation
📦 MCP SDK 1.20.0 - Latest SDK with improved capabilities
Features
Core Features
- 📊
analyze_codebase- Analyze codebase structure and extract code elements (classes, functions, methods) with documentation - 📝
generate_docs- Generate comprehensive documentation from codebase in multiple formats (Markdown, HTML, JSON) - ✍️
update_readme- Update or create a specific section in README.md with new content - 🔍
extract_comments- Extract all documentation comments and docblocks from source files
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 pathDOC_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 |
|---|---|
| zod | ^3.23.8 |
Development dependencies
| ID | Version |
|---|---|
| @modelcontextprotocol/sdk | ^1.20.0 |
| @types/node | ^22.0.0 |
| @vitest/coverage-v8 | ^3.2.4 |
| typescript | ^5.5.0 |
| vitest | ^3.2.4 |
Keywords
mcp
documentation
code-analysis
markdown
jsdoc
phpdoc
mcp-server
Details
2025-10-10 12:43:27 +02:00
Assets (1)
Versions (2)
View all
npm
1
Customable Team
MIT
latest
22 KiB
docu-mcp-2.0.0.tgz
22 KiB