mcpField
M
mkdocs-mcp

mkdocs-mcp

本地服务
github.com/ubaumann开发工具958 周前更新
代码仓库

关于 mkdocs-mcp

mkdocs-mcp 是一款实验性 MkDocs 插件，可启动 MCP 服务来提供文档页面，适用于希望通过 MCP 提供页面的 MkDocs 项目维护者。由于无法覆盖原生 serve 命令，它使用独立脚本构建并启动服务。

主要功能

  1. 01用于 MCP 服务的 MkDocs 插件
  2. 02可配置页面命名方式
  3. 03选择源 Markdown 或转换后的 HTML
  4. 04合并项目或文件夹中的页面

适用场景

  1. 01通过 MCP 客户端提供 MkDocs 文档页面
  2. 02选择所提供页面的名称
  3. 03将文档页面聚合为组合资源

MCP 相关

它会启动 MCP 服务，将 MkDocs 页面作为资源提供。项目通过 mkdocs_mcp 脚本构建并启动服务。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "ubaumann-mkdocs": {
      "command": "uvx",
      "args": [
        "mkdocs-mcp"
      ],
      "env": {
        "MKDOCS_PROJECT_PATH": "<MKDOCS_PROJECT_PATH>"
      }
    }
  }
}
启动命令uvx mkdocs-mcp
需要配置的环境变量
MKDOCS_PROJECT_PATHPath to the MkDocs project

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
pypimkdocs-mcp0.1.2

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具，维护者暂未提供工具列表。

详细介绍

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"(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，请按如下方式配置 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

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。