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)
🚀 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.json
- Windows:
%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.json
- Windows:
%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) | VECTOR_DB_PROVIDER=lance LANCE_PATH=~/lanceDB |
ChromaDB | Simple vector database with web UI | VECTOR_DB_PROVIDER=chroma CHROMA_URL=http://localhost:8000 |
Qdrant | Production-grade vector database | VECTOR_DB_PROVIDER=qdrant QDRANT_URL=http://localhost:6333 |
Embedding Providers
Provider | Description | Configuration |
---|---|---|
Built-in | Uses all-MiniLM-L6-v2 model (default) | EMBEDDING_PROVIDER=buildin EMBEDDING_MODEL=all-MiniLM-L6-v2 EMBEDDING_DIMENSION=384 |
Ollama | Use any Ollama model | EMBEDDING_PROVIDER=ollama EMBEDDING_MODEL=bge-m3:latest EMBEDDING_DIMENSION=1024 OLLAMA_URL=http://localhost:11434 |
🔧 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 ❤️
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
An MCP server that enables Claude to generate, search, and manage documentation for codebases using vector embeddings and semantic search, providing tools for creating user guides, technical documentation, code explanations, and architectural diagrams.
Related MCP Servers
- -securityAlicense-qualityAn MCP server implementation that provides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context. Uses Ollama or OpenAI to generate embeddings. Docker files includedLast updated -5920TypeScriptMIT License
- AsecurityAlicenseAqualityAn MCP server implementation that integrates Claude with Salesforce, enabling natural language interactions with Salesforce data and metadata for querying, modifying, and managing objects and records.Last updated -718045TypeScriptMIT License
- AsecurityAlicenseAqualityAn MCP server implementation that integrates Claude with Salesforce, enabling natural language interactions with Salesforce data and metadata for querying, modifying, and managing objects and records.Last updated -7184TypeScriptMIT License
- -securityAlicense-qualityAn MCP server that implements Claude Code-like functionality, allowing the AI to analyze codebases, modify files, execute commands, and manage projects through direct file system interactions.Last updated -179PythonMIT License