English Français العربية

io.github.ubaumann/mkdocs-mcp

السجل الرسمي أخرى

An MCP server that provides serves MkDocs as resources.

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

PYPI package mkdocs-mcp
Claude Code 
claude mcp add mkdocs-mcp -e 'MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH>' -- uvx mkdocs-mcp==0.1.2
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "mkdocs-mcp": {
            "command": "uvx",
            "args": [
                "mkdocs-mcp==0.1.2"
            ],
            "env": {
                "MKDOCS_PROJECT_PATH": "<MKDOCS_PROJECT_PATH>"
            }
        }
    }
}

متغيرات البيئة

  • MKDOCS_PROJECT_PATH إلزامي Path to the MkDocs project

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. mkdocs-mcp
  2. Quick Start
  3. Using Claude Desktop with WSL
  4. Inspecting the MCP Server
  5. Notes

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 mkdocs-mcp -mt stdio

Use the --mkdocs-project-path option to specify the path to your MkDocs project if it's not in the current directory. The environment variable MKDOCS_PROJECT_PATH can also be set for this purpose.

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
      combine_all_pages: False  # Aggregate all pages into one file
      combine_by_folder: False  # Aggregate each folder

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 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!

GitHub MCP Registry mcp-name: io.github.ubaumann/mkdocs-mcp

الأسئلة الشائعة

ما هو io.github.ubaumann/mkdocs-mcp؟

An MCP server that provides serves MkDocs as resources.

كيف أثبّت io.github.ubaumann/mkdocs-mcp؟

يعمل على جهازك. في Claude Code: claude mcp add mkdocs-mcp -e 'MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH>' -- uvx mkdocs-mcp==0.1.2. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.ubaumann/mkdocs-mcp إلى مفتاح API؟

نعم. يتطلب MKDOCS_PROJECT_PATH، وتضبطها في إعداداته.

هل io.github.ubaumann/mkdocs-mcp مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.ubaumann/mkdocs-mcp؟

ينشره ubaumann. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.