Mkdocs Mcp
What is Mkdocs Mcp
mkdocs-mcp is an experimental MkDocs plugin designed to integrate an MCP server into the MkDocs workflow, allowing for a seamless development experience.
Use cases
Use cases for mkdocs-mcp include serving documentation in a local development environment, debugging documentation builds, and integrating with tools like Claude Desktop and WSL.
How to use
To use mkdocs-mcp, include ‘mcp’ in your mkdocs.yml plugin list and run the MCP server using the command ‘uv run python src/mkdocs_mcp/ -mt stdio’.
Key features
Key features include integration with MkDocs, the ability to run an MCP server, and support for development and debugging through direct inspection.
Where to use
mkdocs-mcp is suitable for developers working on documentation projects that utilize MkDocs and require an MCP server for enhanced functionality.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Mkdocs Mcp
mkdocs-mcp is an experimental MkDocs plugin designed to integrate an MCP server into the MkDocs workflow, allowing for a seamless development experience.
Use cases
Use cases for mkdocs-mcp include serving documentation in a local development environment, debugging documentation builds, and integrating with tools like Claude Desktop and WSL.
How to use
To use mkdocs-mcp, include ‘mcp’ in your mkdocs.yml plugin list and run the MCP server using the command ‘uv run python src/mkdocs_mcp/ -mt stdio’.
Key features
Key features include integration with MkDocs, the ability to run an MCP server, and support for development and debugging through direct inspection.
Where to use
mkdocs-mcp is suitable for developers working on documentation projects that utilize MkDocs and require an MCP server for enhanced functionality.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
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
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!
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
