Minhoyoodev Confluence MCP Server

🚀 Confluence MCP サーバー

Confluence API をアクセスするためのモデルコンテキストプロトコル（Model Context Protocol）サーバーシステムです。個人用アクセストークンを使用して Confluence と通信し、VPN エリア内で Confluence API へのアクセスに際して仲介サーバーとして機能します。

🚀 クイックスタート

この Confluence MCP サーバーシステムは、VPN エリア内で Confluence API へのアクセスを容易にするための仲介サーバーとして機能します。以下の手順でセットアップと起動を行うことができます。

✨ 主な機能

• すべての Confluence スペースを表示
• 特定のスペースの詳細情報を表示
• 新しいスペースを作成
• 既存のスペースを更新
• 指定されたスペースを削除

📦 インストール

必要なコンポーネント

• Node.js（推奨バージョン 14 以上）
• npm（Node パッケージマネージャー）

インストール手順

1. このリポジトリをクローンします：

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. 依存関係をインストールします：

   npm install
   

3. env ファイルを作成します：

   • プロジェクトのルートディレクトリに .env という名前のファイルを作成します。
   • 以下の内容を追加し（必要に応じて修正）ます：

     CONFLUENCE_BASE_URL=your_confluence_server_url
     PERSONAL_ACCESS_TOKEN=your_personal_access_token
     MCP_SERVER_URL=http://localhost:3000
     

4. サーバーを起動します：

   npm start
   

💻 使用例

サーバーの起動

npm start

サーバーの停止

npm stop

すべてのスペースを取得

• リクエストメソッド：GET
• パス：/api/spaces
• 説明：Confluence 内のすべてのスペースを返します。

特定のスペースを取得

• リクエストメソッド：GET
• パス：/api/spaces/{spaceId}
• 説明：指定されたスペースの詳細情報を返します。

新しいスペースを作成

• リクエストメソッド：POST
• パス：/api/spaces
• 説明：新しい Confluence スペースを作成します。

既存のスペースを更新

• リクエストメソッド：PUT
• パス：/api/spaces/{spaceId}
• 説明：指定されたスペースの詳細情報を更新します。

指定されたスペースを削除

• リクエストメソッド：DELETE
• パス：/api/spaces/{spaceId}
• 説明：指定されたスペースを削除します。

📚 ドキュメント

システムアーキテクチャ

このプロジェクトは 2 台のサーバーで構成されています：

1. MCP サーバー (server.ts)：Confluence API と通信してデータを処理する主要なサーバーです。

   • デフォルトポート：3000
   • RESTful API を提供
   • MCP プロトコルを処理

2. プロキシサーバー (proxyServer.ts)：MCP クライアントと MCP サーバーの間でプロキシとして機能します。

   • デフォルトポート：3001
   • MCP クライアントからのリクエストを受け取り、メインサーバーに転送

このアーキテクチャは、VPN エリアの問題を解決するために設計されています。MCP サーバーは VPN 内で実行されて Confluence API にアクセスし、プロキシサーバーは外部からアクセス可能な環境で実行されます。

🔧 技術詳細

テストの実行

すべてのテストを実行

bun test

特定のテストを実行

bun test src/test/getSpaces.test.ts

デプロイ構成

推奨される本番環境構成

1. MCP サーバー：VPN 内または Confluence サーバーにアクセスできるネットワークにデプロイします。
2. プロキシサーバー：MCP クライアントからアクセスできるネットワークにデプロイします。

セキュリティ上の注意事項

• MCP サーバーとプロキシサーバーの間では HTTPS を使用して通信することをおすすめします。これにより、データの安全性が確保されます。
• 個人用アクセストークンを定期的に更新し、安全に保管するようにしてください。
• 本番環境では、適切な認証機構を追加して、不正アクセスを防止することをおすすめします。