mkdocs-mcp

用于提供MCP服务的MkDocs插件
这是一个概念验证项目——欢迎反馈！

---

mkdocs-mcp 是一个实验性插件，旨在将MCP服务器集成到MkDocs工作流程中。由于MkDocs的限制，无法覆盖原生的 mkdocs serve 命令。 因此，该项目提供了 mkdocs_mcp 脚本来处理构建过程并启动MCP服务器。

快速开始

需求

本项目使用了 uv 进行依赖管理和虚拟环境管理。

启动MCP服务器

要启动MCP服务器，请执行以下命令：

uv run mkdocs-mcp -mt stdio

如果您的MkDocs项目不在当前目录下，请使用 --mkdocs-project-path 选项指定项目的路径。也可以设置环境变量 MKDOCS_PROJECT_PATH 来达到同样的目的。

MkDocs配置

确保在您的 mkdocs.yml 插件列表中包含 mcp：

plugins:
  - mcp:
      naming_style: src_file  # 默认值为 "src_file"，也可选择 "dst_url" 或 "title"
      prefer_markdown: True  # 默认情况下使用源Markdown，设为False以将输出HTML转换为Markdown
      combine_all_pages: False  # 将所有页面合并成一个文件
      combine_by_folder: False  # 按文件夹合并

使用Claude Desktop与WSL

如果您正在使用Claude Desktop和WSL，请按如下方式配置您的 claude_desktop_config.json 文件（根据需要调整路径）：

{
  "mcpServers": {
    "mkdocs": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "/home/urs/.cargo/bin/uv run --directory /home/urs/projects/mkdocs-mcp mkdocs-mcp -mt stdio"
      ]
    }
  }
}

查看MCP服务器

为了开发和调试，您可以直接查看MCP服务器：

uv run mcp dev src/mkdocs_mcp/__main__.py

注意事项

• 本项目仍处于早期概念验证阶段。
• 鼓励贡献和反馈！

---

感谢您关注 mkdocs-mcp！

---

GitHub MCP注册表 mcp-name: io.github.ubaumann/mkdocs-mcp