Add your description here
Project description
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
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!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_mcp-0.1.0.tar.gz.
File metadata
- Download URL: mkdocs_mcp-0.1.0.tar.gz
- Upload date:
- Size: 31.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
527b955ebab8babcdd728a0cd4e87b1200f063c9866913ca94874a1feb3f850d
|
|
| MD5 |
d7f35ff2d5af2d896b577c99ddeb26a5
|
|
| BLAKE2b-256 |
2062df57bdd1d7f3cc45a5e308e3f0eabbd56ce3f1b28475c9a253ba63ee69e4
|
Provenance
The following attestation bundles were made for mkdocs_mcp-0.1.0.tar.gz:
Publisher:
main.yaml on ubaumann/mkdocs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_mcp-0.1.0.tar.gz -
Subject digest:
527b955ebab8babcdd728a0cd4e87b1200f063c9866913ca94874a1feb3f850d - Sigstore transparency entry: 200451198
- Sigstore integration time:
-
Permalink:
ubaumann/mkdocs-mcp@f5b7735a3f6bdb8ba6b59cc39ff129629e91ea72 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/ubaumann
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
main.yaml@f5b7735a3f6bdb8ba6b59cc39ff129629e91ea72 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkdocs_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91157774783cfd9b7a9dac5e6e360002a44b3d3a9d5d21f08fec0c34aee80c36
|
|
| MD5 |
f181c7e812dbbbafc8b041b2d3c817e1
|
|
| BLAKE2b-256 |
afc6f923daeea9ea082dbdb1b52508516b9785e349419a24908fa15d6a6cbbb4
|
Provenance
The following attestation bundles were made for mkdocs_mcp-0.1.0-py3-none-any.whl:
Publisher:
main.yaml on ubaumann/mkdocs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_mcp-0.1.0-py3-none-any.whl -
Subject digest:
91157774783cfd9b7a9dac5e6e360002a44b3d3a9d5d21f08fec0c34aee80c36 - Sigstore transparency entry: 200451204
- Sigstore integration time:
-
Permalink:
ubaumann/mkdocs-mcp@f5b7735a3f6bdb8ba6b59cc39ff129629e91ea72 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/ubaumann
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
main.yaml@f5b7735a3f6bdb8ba6b59cc39ff129629e91ea72 -
Trigger Event:
push
-
Statement type: