Grounded Docs: ваш эксперт по актуальной документации для ИИ

Docs MCP Server решает проблему галлюцинаций ИИ и устаревших знаний, предоставляя персональный, всегда актуальный индекс документации для вашего ИИ-помощника по программированию. Он извлекает официальную документацию с веб-сайтов, GitHub, npm, PyPI и из локальных файлов, позволяя вашему ИИ запрашивать именно ту версию, которую вы используете.

✨ Почему Grounded Docs MCP Server?

Альтернатива с открытым исходным кодом для Context7, Nia и Ref.Tools.

• ✅ Актуальный контекст: извлекает документацию напрямую из официальных источников по запросу.

• 🎯 Версионность: запросы нацелены на конкретные версии библиотек в вашем проекте.

• 💡 Снижение галлюцинаций: основывает ответы LLM на реальной документации.

• 🔒 Приватно и локально: работает полностью на вашем компьютере; ваш код никогда не покидает вашу сеть.

• 🧩 Широкая совместимость: работает с любым MCP-совместимым клиентом (Claude, Cline и т. д.).

• 📁 Множество источников: индексируйте веб-сайты, репозитории GitHub, локальные папки и ZIP-архивы.

• 📄 Поддержка множества файлов: обрабатывает HTML, Markdown, PDF, документы Office (Word, Excel, PowerPoint), OpenDocument, RTF, EPUB, Jupyter Notebooks и более 90 языков программирования.

Related MCP server: Documentation Search MCP Server

📄 Поддерживаемые форматы

См. Поддерживаемые форматы для получения полного справочника, включая MIME-типы и детали обработки.

🚀 Быстрый старт

CLI в первую очередь

Для агентов и скриптов CLI обычно является самым простым способом использования Grounded Docs.

1. Индексация документации (требуется Node.js 22+):

npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

Для сайтов документации SPA с хеш-маршрутизацией явно включите сохранение хешей:

npx @arabold/docs-mcp-server@latest scrape my-spa https://docs.example.com/#/guide --preserve-hashes

2. Запрос к индексу:

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

3. Получение одной страницы в формате Markdown:

npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect

Поведение вывода

• Структурированные команды по умолчанию выводят чистый JSON в stdout при неинтерактивном запуске.

• Используйте --output json|yaml|toon для выбора структурированного формата.

• Команды с обычным текстом, такие как fetch-url, сохраняют свой текстовый вывод в stdout.

• Диагностические сообщения проходят через общий логгер и не выводятся в stdout при неинтерактивном запуске.

• Используйте --quiet для подавления некритических диагностических сообщений или --verbose для включения отладочного вывода.

Навыки агента

Каталог skills/ содержит навыки агента, которые обучают ИИ-помощников по программированию использованию CLI — включая поиск по документации, управление индексами и получение URL-адресов.

MCP-сервер

Если вам нужен постоянно работающий MCP-эндпоинт для Claude, Cline, Copilot, Gemini CLI или других MCP-клиентов:

1. Запустите сервер:

npx @arabold/docs-mcp-server@latest

2. Откройте веб-интерфейс по адресу http://localhost:6280 для добавления документации.

3. Подключите ваш ИИ-клиент, добавив это в настройки MCP (например, claude_desktop_config.json):

{
  "mcpServers": {
    "docs-mcp-server": {
      "type": "sse",
      "url": "http://localhost:6280/sse"
    }
  }
}

См. Подключение клиентов для VS Code (Cline, Roo) и других вариантов настройки.

scrape_docs также принимает preserveHashes: true для сайтов документации, использующих клиентскую маршрутизацию на основе хешей. Используйте это только для SPA с хеш-маршрутизацией; обычные сайты обычно используют хеш-фрагменты для внутренних якорей на странице.

docker run --rm \
  -v docs-mcp-data:/data \
  -v docs-mcp-config:/config \
  -p 6280:6280 \
  ghcr.io/arabold/docs-mcp-server:latest \
  --protocol http --host 0.0.0.0 --port 6280

🧠 Настройка модели эмбеддингов (рекомендуется)

Использование модели эмбеддингов необязательно, но значительно улучшает качество поиска за счет семантического векторного поиска.

Пример: включение эмбеддингов OpenAI

OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest

См. Модели эмбеддингов для настройки Ollama, Gemini, Azure и других.

📚 Документация

Начало работы

• Установка: подробные руководства по настройке для Docker, Node.js (npx) и встроенного режима.

• Подключение клиентов: как подключить Claude, VS Code (Cline/Roo) и другие MCP-клиенты.

• Базовое использование: использование веб-интерфейса, CLI и сбор локальных файлов.

• Конфигурация: полный справочник по файлам конфигурации и переменным окружения.

• Поддерживаемые форматы: полный справочник форматов файлов и MIME-типов.

• Модели эмбеддингов: настройка OpenAI, Ollama, Gemini и других провайдеров.

SPA с хеш-маршрутизацией

• Используйте --preserve-hashes, MCP preserveHashes или флажок "Preserve Hash Routes" в веб-интерфейсе только для сайтов документации, которые используют маршрутизацию с URL вида #/guide.

• При включении с scrapeMode=fetch скрапер автоматически переключает задачу на Playwright, так как обычный fetch не может обрабатывать клиентскую хеш-маршрутизацию.

• Обновление по умолчанию повторно использует сохраненную настройку preserveHashes, а точки входа обновления CLI/Web могут явно переопределить ее.

Ключевые концепции и архитектура

• Режимы развертывания: автономный или распределенный (Docker Compose).

• Аутентификация: защита вашего сервера с помощью OAuth2/OIDC.

• Телеметрия: сбор данных об использовании с приоритетом конфиденциальности.

• Архитектура: глубокое погружение в проектирование системы.

🤝 Участие в разработке

Мы приветствуем вклад! Пожалуйста, ознакомьтесь с CONTRIBUTING.md для получения руководств по разработке и инструкций по настройке.

Лицензия

Этот проект лицензирован по лицензии MIT. Подробности см. в LICENSE.