AI导哈

MkDocs MCP插件

一个实验性的MkDocs插件，用于集成MCP服务器到MkDocs工作流程中，支持自定义配置和开发调试。

  • by ubaumann
  • Python
  • 本地部署
  • 9 星标
  • 更新于
在 GitHub 查看 ubaumann/mkdocs-mcp

使用说明

mkdocs-mcp 翻译为中文可以是“mkdocs 多配置处理器”或根据具体上下文可能翻译为“mkdocs 多项目配置”等，但“mkdocs-mcp”本身是一个特定的项目或工具名称，直接翻译可能无法完全传达其原意，因此通常保留原名并在必要时加以解释。如果这是一个特定于某个领域或项目的术语，建议查阅相关资料以获取准确的翻译。在这里，为了简洁明了，我们可以将其翻译为“mkdocs 多配置工具”或保持原样使用“mkdocs-mcp”

用于服务MCP的MkDocs插件
概念验证——欢迎反馈！

mkdocs-mcp 这是一个实验性插件，旨在将MCP服务器集成到MkDocs的工作流程中。由于MkDocs的限制，原生的（功能/方法） mkdocs serve 命令无法被覆盖。 相反，这个项目提供了 mkdocs_mcp 用于处理构建过程并启动MCP服务器的脚本。

快速入门

要求

这个项目使用 uv 用于依赖管理和虚拟环境。

运行MCP服务器

启动MCP服务器：

uv run mkdocs-mcp -mt stdio

使用 --mkdocs-project-path 如果您的 MkDocs 项目不在当前目录中，可以选择指定其路径。环境变量 MKDOCS_PROJECT_PATH 也可以为此目的进行设置。

MkDocs 配置

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

plugins:
  - mcp:
      naming_style: src_file  # "src_file"(default), "dst_url" or "title"
      prefer_markdown: True  # By default the source markdown is used, set to False to convert the output HTML to markdown
      combine_all_pages: False  # Aggregate all pages into one file
      combine_by_folder: False  # Aggregate each folder

使用WSL运行Claude Desktop

如果你正在使用Claude Desktop和WSL（Windows Subsystem for Linux），请配置你的 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 注册表 插件名称：io.github.ubaumann/mkdocs-mcp

相关 MCP