DocuMCP

🤖 Ein MCP-Server zur intelligenten Codedokumentationsgenerierung mit RAG-Funktionen

DocuMCP ermöglicht Claude das Generieren, Durchsuchen und Verwalten von Dokumentationen für Ihre Codebasis mithilfe von Vektoreinbettungen und semantischer Suche. Es bietet Tools zum Erstellen von Benutzerhandbüchern, technischer Dokumentation, Codeerklärungen und Architekturdiagrammen.

✨ Funktionen

• 📚 Erstellen und aktualisieren Sie Dokumentation basierend auf Ihrer Codebasis

• 🔍 Semantische Suche in Code, Dokumentation und Diagrammen

• 📊 Erstellen und Zusammenführen von Architekturdiagrammen

• 📝 Benutzerhandbücher erstellen

• 💾 Unterstützung für mehrere Vektordatenbanken (LanceDB, ChromaDB, Qdrant)

• 🧠 Flexible Einbettungsanbieter (integriert oder Ollama)

Related MCP server: Claude AI Documentation Assistant

🚀 Schnellstart

Installation über NPX (empfohlen)

Die einfachste Möglichkeit, DocuMCP zu verwenden, besteht darin, Claude Desktop mit dem veröffentlichten npm-Paket zu konfigurieren:

Fügen Sie Ihrer Claude Desktop-Konfiguration Folgendes hinzu:

• MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json

• Windows : %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docu-mcp": {
      "command": "npx",
      "args": ["@myjungle/docu-mcp-server"]
    }
  }
}

Das war's! Starten Sie Claude Desktop neu und DocuMCP ist verfügbar.

Alternative Installationsmethoden

Verwenden der Smithery-CLI

Installieren Sie den Server über Smithery CLI:

# Install Smithery CLI if you don't have it
npm install -g @smithery/cli

# Then install the Docu MCP server
npx -y @smithery/cli@latest install @YannickTM/docu-mcp --client claude

🚀 Manueller Start

1. Klonen und installieren

git clone https://github.com/YannickTM/docu-mcp
cd docu-mcp
npm install

2. Erstellen Sie den MCP-Server

cd mcp
npm run build
cd ..

3. Erweiterte Konfiguration

Fügen Sie Ihrer Claude Desktop-Konfiguration Folgendes hinzu:

• MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json

• Windows : %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docuassistant": {
      "command": "node",
      "env": {
        "VECTOR_DB_PROVIDER": "qdrant",
        "QDRANT_URL": "http://localhost:6333",
        "EMBEDDING_PROVIDER": "ollama",
        "EMBEDDING_MODEL": "bge-m3:latest",
        "EMBEDDING_DIMENSION": "1024",
        "OLLAMA_URL": "http://localhost:11434"
      },
      "args": ["/absolute/path/to/DocuMCP/mcp/dist/index.js"]
    }
  }
}

4. Erforderliche Dienste starten (bei Verwendung externer Anbieter)

Für Qdrant:

cd qdrant
npm run start

Für ChromaDB:

cd chromadb
npm run start

5. Starten Sie Claude Desktop neu

Starten Sie Claude Desktop neu, um die neue Konfiguration zu laden.

🛠️ Konfigurationsoptionen

Vektordatenbankanbieter

Einbettungsanbieter

🔧 Verfügbare Tools

DocuMCP stellt Claude die folgenden Tools zur Verfügung:

• 📁 Dateioperationen : read_file , write_file , create_directory , read_directory

• 🔎 Suchwerkzeuge : search_codebase , search_documentation , search_diagram , search_user_guide

• 📚 Dokumentation : generate_documentation , generate_user_guide , explain_code

• 📊 Diagramme : generate_diagram , merge_diagram

• 🗃️ Indizierung : index_file , index_directory

• 🔀 Zusammenführen : merge_documentation

📋 Voraussetzungen

• Node.js 20.11.24+

• Claude Desktop

• (Optional) Docker zum Ausführen externer Vektordatenbanken

🤝 Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.

Mit ❤️ gemacht