mkdocs-mcp

mkdocs-mcp

MCP を提供する MkDocs プラグイン
概念実証版です。ご意見をお待ちしています！

---

mkdocs-mcp は、MCP サーバーを MkDocs のワークフローに統合するために設計された実験的なプラグインです。MkDocs の制限により、標準の mkdocs serve コマンドはオーバーライドできません。 その代わり、このプロジェクトでは mkdocs_mcp スクリプトを提供し、ビルドプロセスの処理と MCP サーバーの起動を行います。

クイックスタート

要件

このプロジェクトでは、依存関係の管理と仮想環境に uv を使用しています。

MCP サーバーの起動

MCP サーバーを起動するには、次のコマンドを実行します。

uv run mkdocs-mcp -mt stdio

MkDocs プロジェクトが現在のディレクトリにない場合は、--mkdocs-project-path オプションを使用してプロジェクトのパスを指定します。この目的には、環境変数 MKDOCS_PROJECT_PATH も設定できます。

MkDocs の設定

mkdocs.yml のプラグインリストに mcp を含めてください。

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

WSL で Claude Desktop を使用する

Claude Desktop と WSL を使用している場合は、claude_desktop_config.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"
      ]
    }
  }
}

MCP サーバーの確認

開発やデバッグでは、MCP サーバーを直接確認できます。

uv run mcp dev src/mkdocs_mcp/__main__.py

注意事項

• このプロジェクトはまだ初期の概念実証段階です。
• コントリビューションやフィードバックを歓迎します！

---

mkdocs-mcp をご覧いただき、ありがとうございます！

---

GitHub MCP レジストリ mcp-name: io.github.ubaumann/mkdocs-mcp