article
README
🚀 Confluence Cloud MCP 服务器
Confluence Cloud MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器,它提供了与 Confluence Cloud 交互的工具。借助该服务器,AI 助手能够通过统一接口对 Confluence 空间、页面和内容进行管理。
🚀 快速开始
将此服务器集成到支持 MCP 的 AI 助手中,只需在它们的 MCP 配置中添加即可:
{
"servers": {
"confluence-cloud-mcp": {
"url": "http://localhost:3000",
"type": "mcp"
}
}
}
✨ 主要特性
- 空间管理
- 列出所有空间
- 获取特定空间的详细信息
- 页面操作
- 创建、读取、更新页面
- 列出特定空间中的页面
- 将 Confluence 存储格式内容转换为 Markdown
- 搜索与标签
- 使用 CQL 搜索内容
- 管理页面标签
📦 安装指南
选项1:使用 Docker(推荐)
最简单的方式是使用预构建的 Docker 镜像:
docker run --rm -i \
-e CONFLUENCE_API_TOKEN=your-api-token \
-e CONFLUENCE_EMAIL=your-email@domain.com \
-e CONFLUENCE_DOMAIN=your-domain.atlassian.net \
ghcr.io/aaronsb/confluence-cloud-mcp:latest
选项2:本地构建
- 克隆仓库:
git clone https://github.com/aaronsb/confluence-cloud-mcp.git
cd confluence-cloud-mcp
- 使用本地构建脚本运行:
# 构建 Docker 镜像
./scripts/build-local.sh
# 运行服务器
CONFLUENCE_API_TOKEN=your-token CONFLUENCE_EMAIL=your-email ./scripts/run-local.sh
选项3:从源代码构建
- 安装依赖:
npm install
- 配置环境变量:
创建一个
.env文件,添加你的 Confluence 凭据:
CONFLUENCE_DOMAIN=your-domain.atlassian.net
CONFLUENCE_EMAIL=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token
- 构建项目:
npm run build
- 运行服务器:
node build/index.js
💻 使用示例
基础用法
将此服务器集成到支持 MCP 的 AI 助手中,只需在它们的 MCP 配置中添加即可:
{
"servers": {
"confluence-cloud-mcp": {
"url": "http://localhost:3000",
"type": "mcp"
}
}
}
📚 详细文档
可用工具
- 配置管理
configure: 配置 MCP 服务器get-config: 获取当前配置update-config: 更新现有配置
- 认证管理
auth/login: 用户登录auth/logout: 用户注销auth/status: 检查认证状态
🔧 技术细节
CI/CD 管道
项目使用 GitHub Actions 实现持续集成和交付:
- 提交请求时自动运行测试和代码检查
- 主分支提交自动构建 Docker 镜像
- 多架构镜像构建(amd64, arm64)
- 自动将容器推送到 GitHub Container Registry
本地开发
使用提供的脚本进行本地开发:
./scripts/build-local.sh: 构建项目并生成本地 Docker 镜像./scripts/run-local.sh: 运行本地 Docker 镜像,并配置你的凭据
📄 许可证
MIT
扫码联系在线客服