mkdocs-mcp
An MCP server that provides serves MkDocs as resources.
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"mkdocs-mcp": {
"args": [
"mkdocs-mcp@0.1.2"
],
"command": "uvx"
}
}
}可用工具 （5 个）
该服务在 MCP 协议中暴露的工具，AI 可按需调用
tavily_search 14 个参数 需填 1 项
Search the web for current information on any topic. Use for news, facts, or data beyond your knowledge cutoff. Returns snippets and source URLs.
必填参数：query
tavily_extract 6 个参数 需填 1 项
Extract content from URLs. Returns raw page content in markdown or text format.
必填参数：urls
tavily_crawl 11 个参数 需填 1 项
Crawl a website starting from a URL. Extracts content from pages with configurable depth and breadth.
必填参数：url
tavily_map 8 个参数 需填 1 项
Map a website's structure. Returns a list of URLs found starting from the base URL.
必填参数：url
tavily_research 2 个参数 需填 1 项
Perform comprehensive research on a given topic or question. Use this tool when you need to gather information from multiple sources to answer a question or complete a task. Returns a detailed response based on the research findings.
必填参数：input
服务介绍
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
