English Français العربية

io.github.ubaumann/mkdocs-mcp

Registre officiel Autres

An MCP server that provides serves MkDocs as resources.

Code source Documentation

Installation

Ajoutez ceci à la configuration MCP de votre client (Claude Desktop : claude_desktop_config.json ; Cursor : .cursor/mcp.json ; VS Code et les autres utilisent la même forme « 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
Configuration JSON (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "mkdocs-mcp": {
            "command": "uvx",
            "args": [
                "mkdocs-mcp==0.1.2"
            ],
            "env": {
                "MKDOCS_PROJECT_PATH": "<MKDOCS_PROJECT_PATH>"
            }
        }
    }
}

Variables d'environnement

  • MKDOCS_PROJECT_PATH obligatoire Path to the MkDocs project

Documentation

Tirée du README du projet sur GitHub, actualisée chaque semaine. Les liens ouvrent GitHub.

Sommaire
  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

Questions fréquentes

Qu'est-ce que io.github.ubaumann/mkdocs-mcp ?

An MCP server that provides serves MkDocs as resources.

Comment installer io.github.ubaumann/mkdocs-mcp ?

Il s'exécute sur votre machine. Dans Claude Code : claude mcp add mkdocs-mcp -e 'MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH>' -- uvx mkdocs-mcp==0.1.2. Pour les autres clients, collez la configuration JSON de cette page dans leurs réglages MCP.

Faut-il une clé API pour io.github.ubaumann/mkdocs-mcp ?

Oui. Il attend MKDOCS_PROJECT_PATH, à renseigner dans sa configuration.

io.github.ubaumann/mkdocs-mcp est-il open source ?

Oui. Son code est sur GitHub sous licence MIT.

Qui maintient io.github.ubaumann/mkdocs-mcp ?

Il est publié par ubaumann. AI.tn le référence sans le maintenir ni le recommander.

Issu du registre MCP officiel. Être listé n'est pas une recommandation : vérifiez le code et les permissions d'un serveur avant de lui donner accès à vos données.