Releases: tosin2013/documcp
Releases · tosin2013/documcp
Release v0.5.1
DocuMCP Release v0.5.1
Release v0.5.1
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-project🚀 v0.5.0: LLM Context Generation & CI Improvements
🚀 Features
- New Tool: generate_llm_context - Dynamically generates LLM-friendly context from documentation and code
- Enhanced ListRoots - Auto-detects and lists documentation directories
- MCP Protocol Enhancements - Implemented progress notifications, logging support, and roots permission system
🐛 Bug Fixes
- Fixed CI test isolation issues preventing knowledge graph file conflicts
- Resolved memory storage directory creation errors
- Fixed sitemap test failures and type issues
📚 Documentation
- Comprehensive documentation improvements
- Updated deployment pipeline to use Docusaurus instead of Jekyll
🧪 Testing
- Improved branch coverage to 81.2%
- Added cleanup step between test runs in CI
⚠️ Breaking Changes
- GitHub Actions workflow now requires Docusaurus instead of Jekyll for documentation deployment
Full Changelog: v0.4.1...v0.5.0
Release v0.4.1
DocuMCP Release v0.4.1
Release v0.4.1
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-project🚀 v0.4.0: Complete API Documentation & User Onboarding System
🎉 Major Release: Complete Documentation System
This release represents a major milestone in DocuMCP's evolution, transforming it from a tool with minimal documentation to a professionally documented system with world-class developer experience.
🚀 Key Features
Complete API Documentation
- 73 functions documented with comprehensive JSDoc comments
- Professional TypeDoc generation creating searchable HTML documentation
- Integrated API Reference accessible from the main documentation site
- Complete type information with TypeScript definitions
- Error handling documentation for all functions
User Onboarding System
- Comprehensive user onboarding guide with step-by-step instructions
- Extensive usage examples for all documented functions
- Environment setup documentation for all platforms (Node.js, Docker, CI/CD)
- Troubleshooting guides for common issues
- Best practices documentation for optimal usage
Technical Infrastructure
- TypeDoc integration for automated API documentation generation
- Docusaurus platform providing modern documentation website
- GitHub Actions CI/CD for automated deployment
- Local development environment with Docker support
- Link checking and validation systems
📚 Documentation System
The documentation follows the Diataxis framework with four main sections:
- 📚 Tutorials - Learning-oriented guides for new users
- 🔧 How-To Guides - Task-oriented instructions with practical examples
- 📖 Reference - Information-oriented API documentation
- 💡 Explanation - Understanding-oriented architecture guides
🌐 Live Documentation
Access the complete documentation system at:
https://tosin2013.github.io/documcp/
🔧 Technical Improvements
- Updated GitHub Actions to latest versions (resolves deprecation warnings)
- Improved build pipeline with automated API documentation generation
- Enhanced local development experience with comprehensive setup guides
- Better error handling and validation throughout the system
📊 Impact
Before this release:
- 0 documented functions
- No user onboarding guides
- Basic documentation structure
- Manual documentation processes
After this release:
- 73 functions with comprehensive documentation
- Complete user onboarding system
- Professional documentation platform
- Automated documentation generation and deployment
🎯 For Users
This release provides:
- Easy onboarding for new developers
- Complete API reference with searchable documentation
- Practical examples for every use case
- Professional documentation integrated with the main site
- Automated deployment ensuring always up-to-date docs
Full Changelog: v0.3.4...v0.4.0
Release v0.3.4
DocuMCP Release v0.3.4
Release v0.3.4
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-projectRelease v0.3.3 - Memory System & MCP Enhancements
DocuMCP Release v0.3.3
🚀 Major Features
- Memory System Implementation: Complete memory system with advanced AI capabilities including contextual retrieval, knowledge graphs, and temporal analysis
- MCP Prompts & Resources: Full implementation of MCP prompts and resources system (ADR-007) for guided workflows
- Enhanced Test Coverage: Achieved 85%+ test coverage with comprehensive test suite
- Project-Local Storage: Configured project-local storage with startup visibility for better isolation
🐛 Bug Fixes
- Fixed Docusaurus configuration issues and deployment workflows
- Resolved GitHub Actions workflow problems with Docker-based builds
- Fixed memory system import/export issues and performance bottlenecks
- Corrected TypeScript compilation errors across the codebase
- Improved error handling for cross-environment compatibility
♻️ Improvements
- Simplified documentation deployment with GitHub Actions linting
- Added comprehensive pre-commit hooks configuration
- Enhanced documentation with memory-enhanced capabilities
- Improved test reliability to 99.3%
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-projectRelease v0.3.2
DocuMCP Release v0.3.2
🐛 Bug Fixes
- resolve documentation inconsistencies and improve type safety (eeb5dde)
- update deploy-docs workflow from Jekyll to Docusaurus (26b4a30)
- update deprecated GitHub Actions to latest versions (e219410)
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-projectRelease v0.3.1
DocuMCP Release v0.3.1
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-projectRelease v0.3.0
DocuMCP Release v0.3.0
🐛 Bug Fixes
- add error handling for package.json parsing in project context analyzer (0a5a3e6)
- disable strict ESLint rules to resolve CI pipeline failures on main branch (5a1dda4)
- regenerate package-lock.json to resolve CodeQL workflow failure (613e6c0), closes #25
- resolve all failing test cases in optimize-readme.test.ts (7353338)
- Resolve ESLint errors in generate-technical-writer-prompts.ts (5a176f6)
- resolve ESLint errors in README Technical Writer tools (68810b0)
- Resolve ESLint errors in validate-readme-checklist.ts (0b3beab)
- Update index.ts to use new Diataxis-aligned prompt API (28dc2c0)
🚀 Features
- Achieve 85%+ branch coverage for critical DocuMCP tools (0111a1b)
- add comprehensive technical writer prompts system (7509f91)
- add Dependabot config for Docusaurus documentation dependencies and security updates (16fbee7)
- Add README template generator and checklist validator tools (4899e12), closes #11
- Implement Diataxis-aligned technical writer prompts (f32558a)
- implement README Technical Writer MCP tools (728da0a), closes #10
- improve validate-content.ts test coverage from 79.31% to 83.15% (a51c0a7), closes #7
- integrate main branch updates and fix merge conflicts (6d30ddf)
Installation
npm install -g [email protected]System Requirements
- Node.js 20.x or higher
- npm 9.x or higher
Quick Start
# Install globally
npm install -g documcp
# Use with MCP client
documcp analyze-repository --path ./my-projectRelease v0.2.4
DocuMCP Release v0.2.4
Features
- MCP Server for intelligent documentation deployment
- Repository analysis and SSG recommendations
- Automated GitHub Pages deployment workflows
Coverage
- Test Coverage: 80%+ (requirement met)
- Performance: PERF-001 compliant
- Security: Automated dependency scanning
Installation
npm install -g [email protected]