Docs MCP Server

Документы MCP Сервер

Этот проект предоставляет гибкий сервер Model Context Protocol (MCP) на базе Probe , предназначенный для обеспечения возможности поиска документации или кодовых баз с помощью помощников на основе искусственного интеллекта.

Вы можете общаться с кодом или документацией, просто указав на репозиторий git или папку.

Варианты использования:

• Общайтесь с любым репозиторием GitHub: укажите серверу публичный или частный репозиторий Git, чтобы включить запросы на естественном языке о его содержимом.
• Поиск в документации: Интегрируйте документацию вашего проекта (из локального каталога или Git) для удобства поиска.
• Создание собственных серверов MCP: используйте этот проект в качестве шаблона для создания собственных официальных серверов MCP, адаптированных под конкретные наборы документации или даже кодовые базы.

Источник контента (документация или код) может быть предварительно встроен в пакет во время этапа npm run build или настроен динамически во время выполнения с использованием локальных каталогов или репозиториев Git. По умолчанию при использовании gitUrl без включения автообновлений сервер загружает архив .tar.gz для более быстрого запуска. Полное клонирование Git используется только в том случае, если autoUpdateInterval больше 0.

Функции

• На базе Probe: использует поисковую систему Probe для получения эффективных и релевантных результатов.
• Гибкие источники контента: включите определенный локальный каталог или клонируйте репозиторий Git.
• Предварительно собранный контент: опционально можно объединить документацию/код непосредственно в пакет.
• Динамическая конфигурация: настройте источники контента, параметры Git и сведения об инструменте MCP с помощью файла конфигурации, аргументов CLI или переменных среды.
• Автоматические обновления Git: поддерживайте актуальность контента, автоматически извлекая изменения из репозитория Git с настраиваемым интервалом.
• Настраиваемый инструмент MCP: определите название и описание инструмента поиска, доступного помощникам ИИ.
• Интеграция с ИИ: легко интегрируется с помощниками на основе ИИ, поддерживающими протокол контекста модели (MCP).

Использование

Основной способ использования этого сервера — через npx , который загружает и запускает пакет без необходимости локальной установки. Это упрощает интеграцию с помощниками AI и клиентами MCP (например, расширениями IDE).

Установка через Smithery

Чтобы автоматически установить Docs MCP Server для Claude Desktop через Smithery :

Интеграция с клиентами MCP (например, IDE)

Вы можете настроить свой клиент MCP для запуска этого сервера с помощью npx . Вот примеры того, как можно настроить клиент (синтаксис может различаться в зависимости от конкретного клиента):

Пример 1: Динамический поиск в репозитории Git (Tyk Docs)

Эта конфигурация сообщает клиенту о необходимости запустить последний пакет @buger/docs-mcp с помощью npx , динамически указав ему репозиторий документации Tyk. Аргумент -y автоматически подтверждает запрос на установку npx . Аргументы --toolName и --toolDescription настраивают то, как инструмент поиска отображается для помощника AI.

В качестве альтернативы некоторые клиенты могут позволить указать полную команду напрямую. Вы можете добиться того же, что и в примере 1, используя:

Пример 2: использование готового фирменного сервера MCP (например, пакета Tyk)

Если команда публикует готовый пакет, содержащий определенную документацию (например, @tyk-technologies/docs-mcp ), конфигурация упрощается, поскольку источник контента и сведения об инструменте запекаются в этом пакете. Аргумент -y по-прежнему рекомендуется для npx .

Этот подход идеально подходит для распространения стандартизированных поисковых возможностей для официальной документации или кодовых баз. См. раздел «Создание собственного предварительно собранного сервера MCP» ниже.

Вот пример того, как команда Tyk создала собственный сервер документации MCP https://github.com/TykTechnologies/docs-mcp .

Конфигурация

Создайте файл docs-mcp.config.json в корневом каталоге, чтобы определить источник контента по умолчанию и сведения об инструменте MCP, используемые во время сборки и во время выполнения (если это не переопределено аргументами CLI или переменными среды).

Пример 1: Использование локального каталога

Пример 2: Использование репозитория Git

Параметры конфигурации

• includeDir : (Сборка/Время выполнения) Абсолютный путь к локальному каталогу, содержимое которого будет скопировано в каталог data во время сборки или использовано непосредственно во время выполнения, если dataDir не указан. Используйте это ИЛИ gitUrl .
• gitUrl : (Сборка/время выполнения) URL репозитория Git. Используйте это ИЛИ includeDir .
  • Если autoUpdateInterval равен 0 (по умолчанию), сервер пытается загрузить архив .tar.gz напрямую (в настоящее время предполагается структура URL GitHub: https://github.com/{owner}/{repo}/archive/{ref}.tar.gz ). Это быстрее, но не поддерживает обновления.
  • Если autoUpdateInterval > 0, сервер выполняет git clone и включает периодические обновления.
• gitRef : (Сборка/время выполнения) Ветка, тег или хэш коммита для использования из gitUrl (по умолчанию: main ). Используется как для загрузки tarball, так и для клонирования/вытягивания Git.
• autoUpdateInterval : (время выполнения) Интервал в минутах для автоматической проверки обновлений Git (по умолчанию: 0, что означает отключено). Установка этого значения > 0 включает клонирование Git и периодические операции git pull . Требует, чтобы команда git была доступна в системном пути.
• dataDir : (Runtime) Путь к каталогу, содержащему контент для поиска во время выполнения. Переопределяет контент, полученный из includeDir или gitUrl , определенных в файле конфигурации или встроенных в пакет. Полезно для указания серверу на живые данные без перестройки.
• toolName : (Build/Runtime) Имя инструмента MCP, предоставляемого сервером (по умолчанию: search_docs ). Выберите описательное имя, соответствующее содержанию.
• toolDescription : (Сборка/время выполнения) Описание инструмента MCP, показываемое помощникам ИИ (по умолчанию: «Поиск документации с помощью поисковой системы зонда»).
• ignorePatterns : (Сборка/Время выполнения) Массив шаблонов глобусов.
• enableBuildCleanup : (Сборка) Если true (по умолчанию), удаляет общие двоичные/медиафайлы (изображения, видео, архивы и т. д.) и файлы размером более 100 КБ из каталога data после этапа сборки. Установите false , чтобы отключить эту очистку.
  • При использовании includeDir во время сборки: файлы, соответствующие этим шаблонам, исключаются при копировании в data . Правила .gitignore также соблюдаются.
  • При использовании gitUrl или dataDir во время выполнения: файлы, соответствующие этим шаблонам в каталоге data игнорируются поисковым индексатором.

Приоритет:

1. Конфигурация среды выполнения (высшая): аргументы CLI ( --dataDir , --gitUrl и т. д.) и переменные среды ( DATA_DIR , GIT_URL и т. д.) переопределяют все остальные настройки. Аргументы CLI имеют приоритет над переменными среды.
2. Конфигурация во время сборки: Настройки в docs-mcp.config.json ( includeDir , gitUrl , toolName и т. д.) определяют значения по умолчанию, используемые во время npm run build , а также служат значениями по умолчанию во время выполнения, если не переопределены.
3. Значения по умолчанию (минимальные): Если конфигурация не указана, используются внутренние значения по умолчанию (например, toolName: 'search_docs' , autoUpdateInterval: 5 ).

Примечание: если оба includeDir и gitUrl указаны в одном и том же источнике конфигурации (например, оба в файле конфигурации или оба в качестве аргументов CLI), приоритет имеет gitUrl .

Создание собственного готового сервера MCP

Вы можете использовать этот проект как шаблон для создания и публикации собственного пакета npm с документацией или предварительно встроенным в него кодом. Это обеспечивает пользователям опыт нулевой конфигурации (как в примере 2 выше).

1. Форк/клонирование этого репозитория: начните с кода этого проекта.
2. Настройте docs-mcp.config.json : Определите includeDir или gitUrl , указывающие на ваш источник контента. Установите toolName и toolDescription по умолчанию.
3. Обновление package.json : изменение name (например, @my-org/my-docs-mcp ), version , description и т. д.
4. Сборка: Запустите npm run build . Это клонирует/копирует ваш контент в каталог data и делает пакет готовым.
5. Публикация: Запустите npm publish (вам потребуется настроить аутентификацию npm).

Теперь пользователи могут легко запустить ваш сервер документации: npx @my-org/my-docs-mcp@latest .

(Предыдущие разделы «Выполнение», «Динамическая конфигурация во время выполнения» и «Переменные среды» были удалены, поскольку использование npx с аргументами в клиентских конфигурациях теперь является основным документированным методом.)

Использование с помощниками на основе искусственного интеллекта

Этот сервер MCP предоставляет инструмент поиска подключенным помощникам AI через протокол контекста модели. Имя и описание инструмента настраиваются (см. раздел «Конфигурация»). Он ищет содержимое в текущем активном каталоге data (определяется настройками сборки, файлом конфигурации, аргументами CLI или переменными среды).

Параметры инструмента:

• query : естественный языковой запрос или ключевые слова, описывающие, что искать (например, «как настроить шлюз», «пример подключения к базе данных», «аутентификация пользователя»). Сервер использует возможности поиска Probe для поиска соответствующего контента. (Обязательно)
• page : Номер страницы для результатов при работе с большим количеством совпадений. По умолчанию 1, если не указано иное. (Необязательно)

Пример вызова инструмента (с использованием search_tyk_docs из примера использования 1):

Пример вызова инструмента (с использованием инструмента из пакета @tyk/docs-mcp ):

Предположим, что предварительно собранный пакет @tyk/docs-mcp определил имя своего инструмента как search_tyk_official_docs :

(Предыдущий раздел «Публикация в виде пакета npm» был заменен разделом «Создание собственного готового сервера MCP» выше.)

Лицензия

Массачусетский технологический институт