Pmwiki MCP

🚀 PmWiki MCP Server

PmWikiとLLMを接続するためのMCP (Model Context Protocol) サーバーです。このサーバーにより、LLMがPmWikiインスタンスと相互作用できるようになります。

Version française / French version

🚀 クイックスタート

Docker Composeを使用する場合 (Docker Hubイメージ)

最も簡単な方法は、Docker Hubから公開されているイメージを使用することです。

docker compose up -d

Docker Composeを使用する場合 (ローカルビルド)

イメージをローカルでビルドする場合は、以下の手順を実行します。

1. docker-compose.yml を編集し、image: 行をコメントアウトし、build: . 行のコメントを解除します。
2. 以下のコマンドを実行します。

docker compose up -d --build

直接Dockerを使用する場合

docker-composeを使用せずに直接実行することもできます。

docker run -d \
  --name pmwiki-mcp-server \
  -p 3000:3000 \
  -v /path/to/your/wiki.d:/wiki_data:ro \
  -e WIKI_DIR=/wiki_data \
  kcofoni/pmwiki-mcp:latest

サーバーは http://localhost:3000 (またはネットワーク上の他のマシンからは http://vmtest:3000) でアクセスできます。

動作確認

# サーバーが実行中であることを確認
docker logs pmwiki-mcp-server

# SSE接続をテスト
curl -N http://localhost:3000/sse

✨ 主な機能

サーバーは、SSE (Server-Sent Events) トランスポートを使用したMCPプロトコルを利用して、LLMがPmWikiインスタンスと相互作用できるようにします。

エンドポイント

• GET /sse: 双方向通信を確立するためのSSE接続
• POST /messages/: MCPクライアントからのメッセージを受信

💻 使用例

クライアント設定 (Claude Desktop)

Claude Desktopの設定ファイルに以下の設定を追加します。 macOSの場合: ~/Library/Application Support/Claude/claude_desktop_config.json Windowsの場合: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "pmwiki": {
      "command": "mcp-proxy",
      "args": [
        "--transport=sse",
        "http://vmtest:3000/sse"
      ]
    }
  }
}

重要な注意事項:

• vmtest は、MCPサーバーのDockerコンテナをホストしているマシンのホスト名です。
• vmtest を以下のように置き換えます。
  • Claude Desktopがサーバーと同じマシンで実行されている場合は localhost
  • Dockerコンテナを実行しているマシンのホスト名またはIPアドレス (例: 192.168.1.100:3000/sse)
• mcp-proxy ツールはインストールされている必要があります (通常はClaude Desktopと一緒に提供されます)。
• プロキシはClaude DesktopとMCPサーバー間のSSE接続を処理します。

利用可能な機能

接続後、LLMは以下のリソースとツールにアクセスできます。

リソース

• すべてのウィキページは、URI pmwiki://Group.PageName でリソースとして公開されます。

ツール

1. search_wiki: すべてのページでテキストを検索します。
   • パラメータ:
     • query (必須): 検索するテキスト
     • case_sensitive (オプション): 大文字小文字を区別する検索 (デフォルト: false)
2. read_page: ページの完全な内容を読み取ります。
   • パラメータ:
     • page_name (必須): ページ名 (例: Main.HomePage または Main/HomePage)
3. list_pages: すべてのウィキページをリストします。
   • パラメータ:
     • group (オプション): グループでフィルタリング

📚 ドキュメント

設定

ウィキディレクトリのマウント

PmWikiディレクトリは、ホストマシンからDockerコンテナにマウントされます。

volumes:
  - /home/docker/appdata/html/wiki.d:/wiki_data:ro

重要:

• /home/docker/appdata/html/wiki.d は ホストマシン上の パスです - これは適宜変更する必要がある例です。
• このパスを、実際のPmWikiの wiki.d ディレクトリのパスに置き換えます。
• セキュリティ上の理由から、ボリュームは読み取り専用 (:ro) でマウントされます。
• /wiki_data はコンテナ内のパスです (変更しないでください)。

Docker Hub

イメージはDocker Hubで公開されています。

• リポジトリ: kcofoni/pmwiki-mcp
• 最新タグ: kcofoni/pmwiki-mcp:latest
• 安定版: kcofoni/pmwiki-mcp:v1.0.2

最新バージョンを取得するには:

docker pull kcofoni/pmwiki-mcp:latest

特定のバージョンを取得するには:

docker pull kcofoni/pmwiki-mcp:v1.0.2

技術的なアーキテクチャ

• 言語: Python 3.11
• Webフレームワーク: Starlette + Uvicorn
• プロトコル: SSE上のMCP
• ページ形式: PmWiki (wiki.d/ 内のファイル)

ログ

# リアルタイムでログを表示
docker logs -f pmwiki-mcp-server

# 最後の50行を表示
docker logs --tail 50 pmwiki-mcp-server

トラブルシューティング

サーバーが起動しない場合

ウィキディレクトリが存在することを確認します。

ls -la /home/docker/appdata/html/wiki.d

ページで404エラーが発生する場合

list_pages ツールを使用して、すべての利用可能なページを確認します。正確なPmWikiファイル名形式を使用する必要があります (例: ファイル名は Main.HomePage で Main/HomePage ではない)。

SSE接続が失敗する場合

ポート3000が適切に公開されていることを確認します。

docker ps | grep pmwiki-mcp-server

開発

ファイル構造

pmwiki-mcp/
├── pmwiki_mcp_server.py    # MCPサーバー
├── requirements.txt         # Python依存関係
├── Dockerfile              # Dockerイメージ
├── docker-compose.yml      # Docker Compose設定
├── README.md              # このドキュメント (英語)
└── README_fr.md           # フランス語のドキュメント

コードの変更

コードを変更した後は、以下のコマンドを実行します。

docker compose up -d --build

🔧 技術詳細

このサーバーは、Python 3.11を使用し、StarletteとUvicornをWebフレームワークとして採用しています。MCPプロトコルをSSE上で使用し、PmWiki形式のページを扱います。

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細については LICENSE ファイルを参照してください。