Confluence MCP Server

🚀 Confluence MCP 服務器

Confluence MCP 服務器是一個用於訪問 Confluence API 的模型上下文協議服務器系統。它藉助個人訪問令牌與 Confluence 進行通信，並在 VPN 區域內充當訪問 Confluence API 的中間服務器，為用戶提供便捷、安全的 API 訪問途徑。

🚀 快速開始

Confluence MCP 服務器旨在簡化對 Confluence API 的訪問，通過獨特的架構設計，有效解決了 VPN 區域訪問限制問題。以下是快速上手該系統的步驟：

1. 確保滿足安裝的先決條件，包括安裝 Node.js 16.x 或更高版本、Bun 1.0.0 或更高版本。
2. 按照安裝步驟克隆存儲庫並安裝依賴項。
3. 完成配置文件的設置，填寫必要的環境變量。
4. 根據需求選擇開發模式或生產模式啟動服務器。

✨ 主要特性

• 多功能 API 支持：提供豐富的 API 端點，可查看所有 Confluence 空間、特定空間中的所有頁面，還能通過頁面 ID 查看特定頁面信息，同時支持創建、更新和刪除頁面等操作。
• 架構設計合理：由 MCP 服務器和代理服務器組成，MCP 服務器負責與 Confluence API 通信並處理數據，代理服務器在 MCP 客戶端和 MCP 服務器之間充當代理角色，有效解決 VPN 區域訪問問題。
• 易於部署和配置：提供詳細的安裝、配置和運行說明，方便用戶快速搭建和使用。

📦 安裝指南

先決條件

• Node.js 16.x 或更高版本
• Bun 1.0.0 或更高版本

安裝步驟

# 克隆存儲庫
git clone https://github.com/your-repository.git
cd your-repository

# 安裝依賴項
bun install

配置

1. 複製 .env.example 文件為 .env
2. 根據要求填寫配置文件中的環境變量

cp .env.example .env

💻 使用示例

基礎用法

以下是啟動服務器的基本命令：

# 開發模式啟動
bun dev

# 生產模式啟動
bun run

高級用法

通過調用不同的 API 端點，可實現更多功能。例如：

# 獲取所有空間
curl -X GET http://your-server/api/spaces

# 創建新頁面
curl -X POST http://your-server/api/pages -d '{"title": "New Page", "content": "This is a new page."}'

# 更新現有頁面
curl -X PUT http://your-server/api/pages/123 -d '{"title": "Updated Page", "content": "This page has been updated."}'

# 刪除頁面
curl -X DELETE http://your-server/api/pages/123

📚 詳細文檔

系統構成

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

1. MCP 服務器（server.ts）：負責與 Confluence API 通信並處理數據的主要服務器。
   • 默認端口：3000
   • 提供 RESTful API
   • 處理 MCP 協議
2. 代理服務器（proxyServer.ts）：在 MCP 客戶端和 MCP 服務器之間充當代理角色。
   • 默認端口：3001
   • 接收來自 MCP 客戶端的請求並轉發到主服務器

此架構設計用於解決 VPN 區域問題。MCP 服務器在 VPN 內部運行以訪問 Confluence API，而代理服務器則在可外部訪問的環境中運行。

端點

以下是 MCP 服務器的主要 API 端點：

• GET /api/spaces - 獲取所有空間
• POST /api/pages - 創建新頁面
• PUT /api/pages/:id - 更新現有頁面
• DELETE /api/pages/:id - 刪除頁面

問題解決

常見問題

1. 無法連接到 Confluence 服務器
   • 檢查 .env 文件中的 CONFLUENCE_BASE_URL
   • 確保個人訪問令牌有效且正確
   • 查看防火牆設置以確認可以訪問 Confluence 服務器
   • 聯繫網絡管理員確認訪問權限
2. MCP 服務器和代理服務器之間通信失敗
   • 檢查 MCP_SERVER_URL 設置是否正確
   • 確保兩臺服務器之間的網絡連接暢通

測試

# 執行所有測試
bun test

# 運行特定測試
bun test src/test/getSpaces.test.ts

部署配置

推薦部署配置

在生產環境中，建議採用以下部署架構：

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

安全注意事項

• 建議使用 HTTPS 實現代理服務器與 MCP 服務器之間的通信加密。
• 安全管理個人訪問令牌，並定期更新。
• 在生產環境中，建議添加適當的認證機制以防止對代理服務器的未授權訪問。

📄 許可證

本項目採用 MIT 許可證。