🚀 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
获取访问令牌的方法：
- 登录到您的 Atlassian 账户。
- 进入 Account Settings > Security > Create and manage API tokens。
- 创建新的 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 部署
- 构建 Docker 镜像：
docker build -t confluence-mcp .
- 打标签并推送到 Google Container Registry：
docker tag confluence-mcp gcr.io/[PROJECT-ID]/confluence-mcp
docker push gcr.io/[PROJECT-ID]/confluence-mcp
- 部署到 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": "错误信息"}。
安全注意事项
- 总是使用环境变量存储敏感数据。
- 考虑使用 Cloud Run 的内置密钥管理功能。
- 为您的端点实现适当的认证。
- 确保 Confluence 访问令牌的安全性。
贡献指南
欢迎贡献！请参考项目文档了解如何参与开发。
📄 许可证
该项目遵守 [LICENSE] 协议。