Mkdocs Mcp

io.github.ubaumannPublished by GitHub account ubaumannv0.1.2Updated Oct 24, 2026

An MCP server that provides serves MkDocs as resources.

VerifiedSTDIODesktop onlyKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

An experimental MkDocs plugin that runs a local MCP server exposing a MkDocs project's documentation pages as resources for an assistant.

What you can do
  • Serve the pages of a configured MkDocs project to the assistant as MCP resources.
  • Name resources by source file, destination URL or page title, depending on the plugin's naming_style setting.
  • Deliver page content as source Markdown by default, or as Markdown converted from the built HTML when prefer_markdown is disabled.
  • Optionally aggregate all pages into one resource, or aggregate pages folder by folder.
  • Build the site and launch the server through the mkdocs_mcp script, since mkdocs serve cannot be overridden.
When to use it
Useful when you keep documentation in a MkDocs project and want an assistant to read those pages directly while you write or edit them, instead of pasting content into the chat. It is a proof-of-concept, so it suits experimentation rather than production documentation workflows.
Requirements
Runs locally as a stdio process started with the mkdocs_mcp script (for example via uv run mkdocs-mcp -mt stdio). Needs a MkDocs project path, given with the --mkdocs-project-path option or the MKDOCS_PROJECT_PATH environment variable, and the mcp plugin added to the project's mkdocs.yml. The README uses uv for dependencies and virtual environments.
Before you install
The project describes itself as an early proof-of-concept, so behavior and configuration may change. It reads and builds the MkDocs project it is pointed at, so set the project path deliberately. No authentication is declared; it is a local stdio process, not a remote endpoint.

Installation

In SourceWeft

  1. Open Mkdocs Mcp in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

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:

bash
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:

yaml
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):

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"      ]    }  }}

Inspecting the MCP Server

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

bash
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

Source: README.md at commit 46c9534

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.1.2LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts