Optional integration for running external vector databases like ChromaDB and Qdrant to support the documentation system
Supports indexing and searching through codebases, enabling documentation generation based on source code repositories
Required runtime environment for the MCP server, with support for Node.js 20.11.24+
Can be used as an embedding provider for generating vector embeddings with models like bge-m3, supporting the semantic search capabilities of the documentation system
DocuMCP
š¤ An MCP server for intelligent code documentation generation with RAG capabilities
DocuMCP enables Claude to generate, search, and manage documentation for your codebase using vector embeddings and semantic search. It provides tools for creating user guides, technical documentation, code explanations, and architectural diagrams.
āØ Features
š Generate and update documentation based on your codebase
š Semantic search across code, documentation, and diagrams
š Create and merge architectural diagrams
š Generate user guides
š¾ Support for multiple vector databases (LanceDB, ChromaDB, Qdrant)
š§ Flexible embedding providers (built-in or Ollama)
Related MCP server: Claude AI Documentation Assistant
š Quick Start
Installation via NPX (Recommended)
The easiest way to use DocuMCP is to configure Claude Desktop with the published npm package:
Add the following to your Claude Desktop configuration:
MacOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%/Claude/claude_desktop_config.json
That's it! Restart Claude Desktop and DocuMCP will be available.
Alternative Installation Methods
Using Smithery CLI
Install the server via Smithery CLI:
š Manual Start
1. Clone and Install
2. Build the MCP Server
3. Advanced Configuration
Add the following to your Claude Desktop configuration:
MacOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%/Claude/claude_desktop_config.json
4. Start Required Services (if using external providers)
For Qdrant:
For ChromaDB:
5. Restart Claude Desktop
Restart Claude Desktop to load the new configuration.
š ļø Configuration Options
Vector Database Providers
Provider | Description | Configuration |
LanceDB | File-based local database (default) |
|
ChromaDB | Simple vector database with web UI |
|
Qdrant | Production-grade vector database |
|
Embedding Providers
Provider | Description | Configuration |
Built-in | Uses all-MiniLM-L6-v2 model (default) |
|
Ollama | Use any Ollama model |
|
š§ Available Tools
DocuMCP provides the following tools to Claude:
š File Operations:
read_file,write_file,create_directory,read_directoryš Search Tools:
search_codebase,search_documentation,search_diagram,search_user_guideš Documentation:
generate_documentation,generate_user_guide,explain_codeš Diagrams:
generate_diagram,merge_diagramšļø Indexing:
index_file,index_directoryš Merging:
merge_documentation
š Requirements
Node.js 20.11.24+
Claude Desktop
(Optional) Docker for running external vector databases
š¤ Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Made with ā¤ļø