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