Confluence MCP Server K7o

🚀 Confluence MCP 服務器

Confluence MCP 服務器是一個用於 Atlassian Confluence 的 Model Context Protocol (MCP) 服務器實現。它提供了一系列工具，可通過 MCP 協議與 Confluence 進行交互，讓 AI 代理能夠無縫處理 Confluence 內容。此服務器基於 Flask 構建，方便部署到 Cloud Run。

🚀 快速開始

Confluence MCP 服務器能助力開發者藉助 MCP 協議與 Confluence 交互，實現對 Confluence 內容的高效處理。以下是快速開啟使用的步驟。

✨ 主要特性

• 使用 Confluence 查詢語言（CQL）搜索頁面和空間。
• 列出所有可用的 Confluence 空間。
• 創建、讀取、更新和刪除 Confluence 頁面。
• 豐富的 Confluence 資源元數據支持。
• 基於 Flask 的服務器，適用於 Cloud Run 部署。
• 配備 MCP 工具，便於 AI 代理集成。

📦 安裝指南

克隆倉庫

安裝依賴項

pip install -r requirements.txt

📚 詳細文檔

配置

在項目根目錄中創建一個 .env 文件，並添加以下變量：

CONFLUENCE_URL=https://your-instance.atlassian.net/wiki
CONFLUENCE_ACCESS_TOKEN=your_access_token
PORT=8080  # 可選，默認為 8080

獲取訪問令牌的方法：

1. 登錄到您的 Atlassian 賬戶。
2. 進入 Account Settings > Security > Create and manage API tokens。
3. 創建新的 API 令牌並複製它。

可用工具

服務器提供了以下 MCP 工具：

基礎用法

# 搜索內容
@tool("search_confluence")
def search(query: str) -> Dict[str, Any]

# 獲取空間
@tool("get_spaces")
def get_spaces() -> Dict[str, Any]

# 獲取頁面內容
@tool("get_page_content")
def get_page_content(space_key: str, page_id: str) -> Dict[str, Any]

高級用法

# 創建頁面
@tool("create_page")
def create_page(space_key: str, title: str, content: str) -> Dict[str, Any]

# 更新頁面
@tool("update_page")
def update_page(space_key: str, page_id: str, content: str) -> Dict[str, Any]

# 刪除頁面
@tool("delete_page")
def delete_page(space_key: str, page_id: str) -> Dict[str, Any]

本地運行

在本地運行服務器：

python example.py

服務器將在 http://localhost:8080 啟動。

Cloud Run 部署

1. 構建 Docker 鏡像：

docker build -t confluence-mcp .

2. 打標籤並推送到 Google Container Registry：

docker tag confluence-mcp gcr.io/[PROJECT-ID]/confluence-mcp
docker push gcr.io/[PROJECT-ID]/confluence-mcp

3. 部署到 Cloud Run：

gcloud run deploy confluence-mcp \
  --image gcr.io/[PROJECT-ID]/confluence-mcp \
  --platform managed \
  --allow-unauthenticated \
  --set-env-vars="CONFLUENCE_URL=[YOUR_URL],CONFLUENCE_ACCESS_TOKEN=[YOUR_TOKEN]"

錯誤處理

所有工具都包含適當的錯誤處理，並將返回格式正確的錯誤消息。響應格式包括：

• 成功情況：指定格式的相關數據。
• 錯誤情況：{"error": "錯誤信息"}。

安全注意事項

1. 總是使用環境變量存儲敏感數據。
2. 考慮使用 Cloud Run 的內置密鑰管理功能。
3. 為您的端點實現適當的認證。
4. 確保 Confluence 訪問令牌的安全性。

貢獻指南

歡迎貢獻！請參考項目文檔瞭解如何參與開發。

📄 許可證

該項目遵守 [LICENSE] 協議。