mkdocs-mcp

🚀 mkdocs - mcp

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  # 按文件夹合并页面

💻 使用示例

在 WSL 中使用 Claude Desktop

如果你在 WSL 环境中使用 Claude Desktop，请按如下方式配置 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 名称：io.github.ubaumann/mkdocs-mcp