Confluence Cloud MCP 服务器

这是一个提供与 Confluence Cloud 交互工具的模型上下文协议 (MCP) 服务器。该服务器使 AI 助手能够通过标准化接口管理 Confluence 空间、页面和内容。

特性

• 空间管理
  • 列出空间
  • 获取空间详情
• 页面操作
  • 创建、读取、更新页面
  • 列出空间中的页面
  • 将页面内容从 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：本地构建

1. 克隆仓库：

git clone https://github.com/aaronsb/confluence-cloud-mcp.git
cd confluence-cloud-mcp

1. 使用本地构建脚本构建并运行：

# Build the Docker image
./scripts/build-local.sh

# Run the server
CONFLUENCE_API_TOKEN=your-token CONFLUENCE_EMAIL=your-email ./scripts/run-local.sh

选项 3：从源码开始

1. 安装依赖项：

npm install

1. 配置环境变量：
   创建一个包含你的 Confluence 凭证的 .env 文件：

CONFLUENCE_DOMAIN=your-domain.atlassian.net
CONFLUENCE_EMAIL=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token

1. 构建项目：

npm run build

1. 运行服务器：

node build/index.js

使用

可以通过将此服务器添加到它们的 MCP 配置中，将其与支持 MCP 的 AI 助手集成：

{
  "mcpServers": {
    "confluence": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "ghcr.io/aaronsb/confluence-cloud-mcp:latest"],
      "env": {
        "CONFLUENCE_DOMAIN": "your-domain.atlassian.net",
        "CONFLUENCE_EMAIL": "your-email@domain.com",
        "CONFLUENCE_API_TOKEN": "your-api-token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

AI 助手注意：如果你是像 Cline 这样的 AI 助手，尝试安装此 MCP 服务器，请参阅 llms-install.md 文件以获取详细的安装说明。

可用工具

空间工具

• list_confluence_spaces: 列出 Confluence 中的所有空间
• get_confluence_space: 获取特定空间的详细信息

页面工具

• list_confluence_pages: 列出空间中的页面
• get_confluence_page: 获取特定页面及其内容（现在包括 Markdown 转换）
• create_confluence_page: 在空间中创建新页面
• update_confluence_page: 更新现有页面

get_confluence_page 工具现在会自动将 Confluence 存储格式的内容转换为 Markdown，使得处理页面内容更加容易。转换处理了以下内容：

• 标题 (h1-h6)
• 列表（有序和无序）
• 链接
• 强调（粗体/斜体）
• 代码块
• 表格
• 段落和换行

搜索与标签工具

• search_confluence_pages: 使用 CQL 搜索 Confluence 内容
• get_confluence_labels: 获取页面的标签
• add_confluence_label: 向页面添加标签
• remove_confluence_label: 从页面移除标签

注意：所有工具名称遵循 [动词]confluence[名词] 命名约定，以保持一致性和清晰度。

开发

该项目使用 TypeScript 编写，并遵循 MCP SDK 规范来实现服务器功能。代码库组织如下：

• src/client/ - Confluence API 客户端实现
• src/handlers/ - MCP 工具请求处理器
• src/schemas/ - 工具输入的 JSON 模式
• src/types/ - TypeScript 类型定义
• src/utils/ - 实用函数，包括内容格式转换

CI/CD 流水线

该项目使用 GitHub Actions 进行持续集成和部署：

• 在拉取请求上自动进行测试和代码检查
• 在主分支提交时自动构建 Docker 镜像
• 多架构镜像构建（amd64, arm64）
• 将容器发布到 GitHub Container Registry

本地开发

对于本地开发，请使用提供的脚本：

• ./scripts/build-local.sh：构建项目并创建一个本地 Docker 镜像
• ./scripts/run-local.sh：使用你的凭证运行本地 Docker 镜像

许可证

MIT