Skip to main content
Glama
serverless-dna

MkDocs MCP Search Server

MkDocs MCP 搜索服务器

一个模型上下文协议 (MCP) 服务器,为任何基于MkDocs的站点提供搜索功能。该服务器依赖于使用Lunr.Js搜索引擎的现有 MkDocs 搜索实现。

Claude 桌面快速入门

按照安装说明操作,请遵循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: Claude AI Documentation Assistant

概述

该项目实现了一个 MCP 服务器,使大型语言模型 (LLM) 能够搜索任何已发布的 mkdocs 文档站点。它使用 lunr.js 实现高效的本地搜索功能,并提供可汇总并呈现给用户的搜索结果。

特征

  • 符合 MCP 标准的服务器,用于与 LLM 集成

  • 使用 lunr.js 索引进行本地搜索

  • 特定版本的文档搜索功能

安装

# Install dependencies pnpm install # Build the project pnpm build

用法

该服务器可以作为通过 stdio 进行通信的 MCP 服务器运行:

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

搜索工具

服务器提供了一个search_docs工具,其参数如下:

  • search :搜索查询字符串

  • version :可选版本字符串(默认为“最新”)

发展

建筑

pnpm build

测试

pnpm test

Claude Desktop MCP 配置

在开发过程中,您可以使用以下配置通过 Claude Desktop 运行 MCP 服务器。

以下配置展示了如何在使用 Windows Subsystem for Linux (WSL) 进行开发时在 Windows Claude 桌面上运行。在 Mac 或 Linux 环境中,您可以以类似的方式运行。

输出是一个捆绑文件,由于所有依赖项都已捆绑,因此它使安装在 Windows 中的 Node 能够运行 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. 然后,法学硕士可以使用这些结果来查找相关的文档页面

执照

麻省理工学院

-
security - not tested
A
license - permissive license
-
quality - not tested

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/serverless-dna/mkdocs-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server