MkDocs MCP Поисковый сервер

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

Краткое руководство по работе с Claude Desktop

Следуйте инструкциям по установке, пожалуйста, следуйте краткому руководству Model Context Protocol для пользователей Claude Desktop . Вам нужно будет добавить раздел в файл конфигурации MCP следующим образом:

{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@serverless-dna/mkdocs-mcp",
        "https://your-doc-site",
        "Describe what you are enabling search for to help your AI Agent"
      ]
    }
  }
}

Related MCP server: MkDocs MCP Server

Обзор

Этот проект реализует сервер MCP, который позволяет моделям больших языков (LLM) осуществлять поиск по любому опубликованному сайту документации mkdocs. Он использует lunr.js для эффективных возможностей локального поиска и предоставляет результаты, которые можно суммировать и представлять пользователям.

Функции

• MCP-совместимый сервер для интеграции с LLM

• Локальный поиск с использованием индексов lunr.js

• Возможность поиска документации по конкретной версии

Установка

# Install dependencies
pnpm install

# Build the project
pnpm build

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

Сервер может быть запущен как сервер MCP, взаимодействующий через stdio:

npx -y @serverless-dna/mkdocs-mcp https://your-doc-site.com

Инструмент поиска

Сервер предоставляет инструмент search_docs со следующими параметрами:

• search : строка поискового запроса

• version : Необязательная строка версии (по умолчанию «последняя»)

Разработка

Здание

pnpm build

Тестирование

pnpm test

Конфигурация MCP рабочего стола Клода

Во время разработки вы можете запустить MCP Server с Claude Desktop, используя следующую конфигурацию.

Конфигурация ниже показывает запуск в Windows Claude Desktop при разработке с использованием Windows Subsystem for Linux (WSL). Среды Mac или Linux можно запустить аналогичным образом.

На выходе получается связанный файл, который позволяет Node, установленному в Windows, запускать сервер MCP, поскольку все зависимости связаны.

{
  "mcpServers": {
    "powertools": {
	"command": "node",
	"args": [
	  "\\\\wsl$\\Ubuntu\\home\\walmsles\\dev\\serverless-dna\\mkdocs-mcp\\dist\\index.js",
    "Search online documentation"
	]
    }
  }
}

Как это работает

1. Сервер загружает предварительно созданные индексы lunr.js для каждой поддерживаемой среды выполнения.

2. При получении поискового запроса он:

   • Загружает соответствующий индекс на основе версии (в настоящее время установлена последняя версия)

   • Выполняет поиск с использованием lunr.js

   • Возвращает результаты поиска в формате JSON

3. Затем LLM может использовать эти результаты для поиска соответствующих страниц документации.

Лицензия

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