项目简介

MkDocs MCP Search Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，专门为由 MkDocs 构建的文档网站提供上下文信息和功能。它允许兼容 MCP 的 LLM 客户端（如某些AI助手应用）通过结构化的方式搜索文档内容或获取特定页面的详细信息。

主要功能点

• MCP 兼容性: 作为一个完整的 MCP 服务器运行，与 LLM 客户端进行标准化的 JSON-RPC 通信。
• 文档搜索: 利用 MkDocs 网站内嵌的搜索索引（基于 Lunr.js），提供高效的本地文档搜索能力。
• 版本支持: 支持搜索 MkDocs 网站中包含的多个版本文档（如果网站配置了多版本）。
• 内容获取: 允许 LLM 客户端获取指定 URL 的文档页面内容，并将其转换为 Markdown 格式。
• 工具暴露: 通过 MCP 工具机制，向 LLM 客户端暴露 'search' 和 'fetch' 等功能，使 LLM 可以调用这些能力来获取文档信息。

安装步骤

要安装和构建此服务器，请在仓库目录下执行以下命令：

1. 安装项目依赖：

   pnpm install
   

2. 构建项目：

   pnpm build
   

   这将会生成可执行的服务器文件。

服务器配置 (针对 MCP 客户端)

本服务器需要通过 MCP 客户端（如支持 MCP 的 AI 助手应用）进行配置和启动。配置信息通常以 JSON 格式提供给客户端。以下是一个示例配置结构，您需要根据您的 MkDocs 网站 URL 进行修改：

• 'mcpServers': 这是 MCP 客户端配置中用于定义 MCP 服务器的顶级键。
• '"my-docs"': 这是一个自定义的服务器名称，您可以随意命名，用于在客户端中标识此服务器。
• '"command"': 指定启动此 MCP 服务器的可执行命令。对于此项目，通常是 'npx' 或构建后生成的 Node.js 命令。
• '"args"': 指定传递给启动命令的参数列表。
  • 第一个参数是您要提供搜索和访问能力的 MkDocs 文档网站的根 URL (例如 'https://your-doc-site.com')。请将其替换为您的实际文档网站 URL。
  • 第二个参数是一个描述性的字符串，用于告诉 AI Agent 这个服务器提供什么内容的搜索，以便 AI Agent 更好地使用这个工具 (例如 '"Describe what you are enabling search for..."')。

请参考您的 MCP 客户端文档，将类似上述结构的配置添加到客户端的 MCP 配置中。

基本使用方法 (通过 LLM 客户端)

一旦在 MCP 客户端中正确配置并连接了 MkDocs MCP Search Server，LLM 客户端就可以利用它提供的工具：

1. 搜索文档: LLM 可以调用 'search' 工具，提供搜索查询字符串。服务器将返回相关的文档页面摘要列表，LLM 可以利用这些结果来回答问题或引导用户到相关文档。工具调用时可以指定 'version' 参数来搜索特定版本的文档。
2. 获取页面内容: LLM 可以调用 'fetch' 工具，提供一个具体的文档页面 URL。服务器将获取该页面内容，转换为 Markdown 格式返回给 LLM，LLM 可以进一步处理或总结这些内容。

服务器本身通常在后台运行，通过标准输入/输出来与 LLM 客户端通信，无需用户直接与服务器进程交互。