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+
DocuMCP
🤖 MCP-сервер для интеллектуальной генерации документации кода с возможностями RAG
DocuMCP позволяет Claude генерировать, искать и управлять документацией для вашей кодовой базы с помощью векторных вложений и семантического поиска. Он предоставляет инструменты для создания руководств пользователя, технической документации, пояснений кода и архитектурных диаграмм.
✨ Особенности
- 📚 Создавайте и обновляйте документацию на основе вашей кодовой базы
- 🔍 Семантический поиск по коду, документации и диаграммам
- 📊 Создавайте и объединяйте архитектурные схемы
- 📝 Создавайте руководства пользователя
- 💾 Поддержка нескольких векторных баз данных (LanceDB, ChromaDB, Qdrant)
- 🧠 Гибкие провайдеры встраивания (встроенные или Ollama)
🚀 Быстрый старт
Установка через NPX (рекомендуется)
Самый простой способ использования DocuMCP — настроить Claude Desktop с опубликованным пакетом npm:
Добавьте следующее в конфигурацию Claude Desktop:
- MacOS :
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows :
%APPDATA%/Claude/claude_desktop_config.json
Вот и все! Перезапустите Claude Desktop и DocuMCP будет доступен.
Альтернативные методы установки
Использование интерфейса командной строки Smithery
Установите сервер через Smithery CLI:
🚀 Ручной запуск
1. Клонировать и установить
2. Создайте сервер MCP
3. Расширенная конфигурация
Добавьте следующее в конфигурацию Claude Desktop:
- MacOS :
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows :
%APPDATA%/Claude/claude_desktop_config.json
4. Запустите необходимые службы (при использовании внешних поставщиков)
Для Кдранта:
Для ChromaDB:
5. Перезагрузите Claude Desktop.
Перезапустите Claude Desktop, чтобы загрузить новую конфигурацию.
🛠️ Варианты конфигурации
Поставщики векторных баз данных
Провайдер | Описание | Конфигурация |
---|---|---|
LanceDB | Локальная база данных на основе файлов (по умолчанию) | VECTOR_DB_PROVIDER=lance LANCE_PATH=~/lanceDB |
ChromaDB | Простая векторная база данных с веб-интерфейсом | VECTOR_DB_PROVIDER=chroma CHROMA_URL=http://localhost:8000 |
Квдрант | База данных векторов промышленного уровня | VECTOR_DB_PROVIDER=qdrant QDRANT_URL=http://localhost:6333 |
Поставщики встраивания
Провайдер | Описание | Конфигурация |
---|---|---|
Встроенный | Использует модель all-MiniLM-L6-v2 (по умолчанию) | EMBEDDING_PROVIDER=buildin EMBEDDING_MODEL=all-MiniLM-L6-v2 EMBEDDING_DIMENSION=384 |
Оллама | Используйте любую модель Ollama | EMBEDDING_PROVIDER=ollama EMBEDDING_MODEL=bge-m3:latest EMBEDDING_DIMENSION=1024 OLLAMA_URL=http://localhost:11434 |
🔧 Доступные инструменты
DocuMCP предоставляет Клоду следующие инструменты:
- 📁 Операции с файлами :
read_file
,write_file
,create_directory
,read_directory
- 🔎 Инструменты поиска :
search_codebase
,search_documentation
,search_diagram
,search_user_guide
- 📚 Документация :
generate_documentation
,generate_user_guide
,explain_code
- 📊 Диаграммы :
generate_diagram
,merge_diagram
- 🗃️ Индексация :
index_file
,index_directory
- 🔀 Объединение :
merge_documentation
📋 Требования
- Node.js 20.11.24+
- Клод Десктоп
- (Необязательно) Docker для запуска внешних векторных баз данных
🤝 Вклад
Вклады приветствуются! Пожалуйста, не стесняйтесь отправлять запрос на включение.
Сделано с ❤️
This server cannot be installed
Сервер MCP, который позволяет Клоду генерировать, искать и управлять документацией для кодовых баз с использованием векторных вложений и семантического поиска, предоставляя инструменты для создания руководств пользователя, технической документации, пояснений кода и архитектурных диаграмм.
Related MCP Servers
- 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 -78715TypeScriptMIT License
- -securityFlicense-qualityAn MCP server that enables Claude Desktop to interact with Sanity.io content, providing tools to create, edit, list documents and get schema templates.Last updated -TypeScript
- 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 -151PythonMIT License