Mkdocs MCP

🚀 mkdocs - mcp

MCPを提供するMkDocsプラグイン
概念実証です — フィードバックを歓迎します！

🚀 クイックスタート

必要条件

このプロジェクトでは、依存関係の管理と仮想環境の作成に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"(デフォルト), "dst_url" または "title"
      prefer_markdown: True  # デフォルトではソースのMarkdownが使用されます。出力HTMLをMarkdownに変換するにはFalseに設定します
      combine_all_pages: False  # すべてのページを1つのファイルに集約する
      combine_by_folder: False  # 各フォルダを集約する

💻 使用例

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 Registry mcp - name: io.github.ubaumann/mkdocs - mcp