Minhoyoodev Confluence MCP Server

🚀 Confluence MCP 服務器

Confluence MCP 服務器是一個用於訪問 Confluence API 的模型上下文協議（Model Context Protocol）服務器系統。它藉助個人訪問令牌與 Confluence 進行通信，在 VPN 區域內充當訪問 Confluence API 的中介服務器。

🚀 快速開始

Confluence MCP 服務器能讓你方便地與 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}
• 描述：刪除指定的空間。

問題解決

常見問題

1. 無法連接到 Confluence 服務器

   • 檢查 .env 文件中的 CONFLUENCE_BASE_URL 是否正確。
   • 確保個人訪問令牌有效且格式正確。
   • 檢查網絡設置，確保沒有防火牆或代理阻止連接。

2. MCP 服務器與代理服務器之間的通信問題

   • 確保 MCP_SERVER_URL 設置正確。
   • 檢查兩臺服務器之間的網絡連接是否正常。

測試

執行所有測試

bun test

運行特定測試

bun test src/test/getSpaces.test.ts

部署配置

推薦生產配置

1. MCP 服務器：部署在 VPN 內部或能夠訪問 Confluence 服務器的網絡中。
2. 代理服務器：部署在允許 MCP 客戶端訪問的網絡中。

安全注意事項

• 建議在 MCP 服務器和代理服務器之間使用 HTTPS 進行通信，以確保數據安全。
• 定期更新個人訪問令牌，並確保其存儲安全。
• 在生產環境中，建議添加適當的身份驗證機制，防止未經授權的訪問。

🔧 技術細節

該項目由兩臺服務器組成：

1. MCP 服務器 (server.ts)：負責與 Confluence API 通信以處理數據的主要服務器。

   • 默認端口：3000
   • 提供 RESTful API
   • 處理 MCP 協議

2. 代理服務器 (proxyServer.ts)：在 MCP 客戶端和 MCP 服務器之間充當代理角色。

   • 默認端口：3001
   • 接收來自 MCP 客戶端的請求並將其傳遞給主服務器

這種架構設計是為了解決 VPN 區域問題。MCP 服務器在 VPN 內部運行以訪問 Confluence API，而代理服務器在可外部訪問的環境中運行。