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"
      ]
    }
  }
}

Обзор

Этот проект реализует сервер 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"
	]
    }
  }
}

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

Сервер загружает предварительно созданные индексы lunr.js для каждой поддерживаемой среды выполнения.
При получении поискового запроса он:
- Загружает соответствующий индекс на основе версии (в настоящее время установлена последняя версия)
- Выполняет поиск с использованием lunr.js
- Возвращает результаты поиска в формате JSON
Затем LLM может использовать эти результаты для поиска соответствующих страниц документации.

Лицензия

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

This server cannot be installed

security - not tested

license - permissive license

quality - not tested

How are these scores calculated?

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Позволяет Клоду и другим магистрам права осуществлять поиск по любому опубликованному сайту документации MkDocs с помощью поисковой системы Lunr.js, что позволяет ИИ находить и обобщать соответствующую документацию для пользователей.

Related MCP Servers

MCP DuckDuckGo Search Server
spences10
-
security
A
license
-
quality
Enables integration with DuckDuckGo search capabilities for LLMs, supporting comprehensive web search, regional filtering, result types, and safe browsing with caching and customizable search parameters.
Last updated -
16
3
TypeScript
MIT License
Claude AI Documentation Assistant
XPE-7
-
security
F
license
-
quality
An MCP server that integrates with Claude to provide smart documentation search capabilities across multiple AI/ML libraries, allowing users to retrieve and process technical information through natural language queries.
Last updated -
Python
DevDocs MCP Server
cyberagiinc
-
security
A
license
-
quality
Integrates with Claude to enable intelligent querying of documentation data, transforming crawled technical documentation into an actionable resource that LLMs can directly interact with.
Last updated -
1,818
TypeScript
Apache 2.0
Documentation MCP Server
sagacious-satadru
A
security
F
license
A
quality
A server that enables Claude to search and access documentation from popular libraries like LangChain, LlamaIndex, and OpenAI directly within conversations.
Last updated -
1
3
Python

View all related MCP servers

MkDocs MCP Search Server