Cover image
Try Now
2025-04-14

MkDocs Plugin to serve MCP

3 years

Works with Finder

1

Github Watches

0

Github Forks

1

Github Stars

mkdocs-mcp

MkDocs Plugin to Serve MCP
A proof-of-concept — feedback welcome!


mkdocs-mcp is an experimental plugin designed to integrate an MCP server into the MkDocs workflow. Due to limitations in MkDocs, the native mkdocs serve command cannot be overridden. Instead, this project provides the mkdocs_mcp script to handle the build process and launch the MCP server.

Quick Start

Requirements

This project uses uv for dependency management and virtual environments.

Running the MCP Server

To start the MCP server:

uv run python src/mkdocs_mcp/ -mt stdio

MkDocs Configuration

Make sure to include mcp in your mkdocs.yml plugin list:

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

Using Claude Desktop with WSL

If you're working with Claude Desktop and WSL, configure your claude_desktop_config.json as follows (adjust paths as needed):

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

Inspecting the MCP Server

For development and debugging, you can directly inspect the MCP server:

uv run mcp dev src/mkdocs_mcp/__main__.py

Notes

  • This project is still in the early proof-of-concept stage.
  • Contributions and feedback are highly encouraged!

Thanks for checking out mkdocs-mcp!

相关推荐

  • av
  • Effortlessly run LLM backends, APIs, frontends, and services with one command.

  • WangRongsheng
  • 🧑‍🚀 全世界最好的LLM资料总结(Agent框架、辅助编程、数据处理、模型训练、模型推理、o1 模型、MCP、小语言模型、视觉语言模型) | Summary of the world's best LLM resources.

  • 1Panel-dev
  • 🔥 1Panel provides an intuitive web interface and MCP Server to manage websites, files, containers, databases, and LLMs on a Linux server.

  • rulego
  • ⛓️RuleGo is a lightweight, high-performance, embedded, next-generation component orchestration rule engine framework for Go.

  • Byaidu
  • PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/MCP/Docker/Zotero

  • lasso-security
  • A plugin-based gateway that orchestrates other MCPs and allows developers to build upon it enterprise-grade agents.

  • hkr04
  • Lightweight C++ MCP (Model Context Protocol) SDK

  • sigoden
  • Easily create LLM tools and agents using plain Bash/JavaScript/Python functions.

  • RockChinQ
  • 😎简单易用、🧩丰富生态 - 大模型原生即时通信机器人平台 | 适配 QQ / 微信(企业微信、个人微信)/ 飞书 / 钉钉 / Discord / Telegram / Slack 等平台 | 支持 ChatGPT、DeepSeek、Dify、Claude、Gemini、xAI、PPIO、Ollama、LM Studio、阿里云百炼、火山方舟、SiliconFlow、Qwen、Moonshot、ChatGLM、SillyTraven、MCP 等 LLM 的机器人 / Agent | LLM-based instant messaging bots platform, supports Discord, Telegram, WeChat, Lark, DingTalk, QQ, Slack

    Reviews

    3.3 (4)
    Avatar
    user_dYMIPPpR
    2025-04-26

    I've been using mkdocs-mcp by ubaumann and it has significantly improved my documentation workflow. It's simple to use and highly customizable, making it a great tool for developers. The welcome information is clear, and starting with the provided URL is straightforward. If you need efficient documentation management, I highly recommend mkdocs-mcp!

    Avatar
    user_EZbT1zwS
    2025-04-26

    I've been using mkdocs-mcp for a while now and I'm highly impressed by its functionality. Created by ubaumann, this tool has significantly streamlined my documentation process. The interface is user-friendly and the customization options are excellent. If you're looking for a reliable documentation generator, mkdocs-mcp is definitely worth considering!

    Avatar
    user_eX0WbuTM
    2025-04-26

    I've been using mkdocs-mcp for a while now and I'm thoroughly impressed. The integration with MkDocs is seamless and it makes managing my documentation project a breeze. Kudos to ubaumann for creating such a reliable and user-friendly tool. Highly recommended!

    Avatar
    user_sNya19w4
    2025-04-26

    As an ardent user of mkdocs-mcp, I can confidently say this tool is a game-changer. Its seamless integration and intuitive design, crafted by ubaumann, make documentation a breeze. It significantly enhances my productivity and the quality of my projects. Highly recommend it to anyone who needs efficient and effective documentation solutions!