Confluence Cloud MCP

汇流云MCP服务器

一种模型上下文协议（MCP）服务器，提供与Confluence Cloud交互的工具。该服务器使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：使用npx（直接来自GitHub）

直接从GitHub运行，无需安装：

# With inline environment variables
CONFLUENCE_DOMAIN=your-domain.atlassian.net \
CONFLUENCE_EMAIL=your-email@domain.com \
CONFLUENCE_API_TOKEN=your-api-token \
npx github:aaronsb/confluence-cloud-mcp

# Or with an environment file
npx github:aaronsb/confluence-cloud-mcp --env /path/to/.env

创建一个 .env 使用您的Confluence凭据文件：

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

选项4：来源

1. 安装依赖项：

npm install

1. 配置环境变量：

创建一个 .env 使用您的Confluence凭据文件：

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助手集成：

使用克劳德代码CLI：

claude mcp add confluence-cloud npx -- github:aaronsb/confluence-cloud-mcp --env /path/to/.env

在MCP配置中使用npx：

{
  "mcpServers": {
    "confluence": {
      "command": "npx",
      "args": ["github:aaronsb/confluence-cloud-mcp", "--env", "/path/to/.env"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

使用Docker：

{
  "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这样的人工智能助手，试图安装此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：从页面中删除标签

备注：所有工具名称都跟在\[动词\]后面_汇流_\[名词\]一致性和清晰性的命名约定。

发展

这个项目是用TypeScript编写的，遵循MCP SDK实现服务器功能的约定。代码库组织为：

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

CI/CD管道

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

• 自动测试和linting on pull请求
• 自动Docker镜像基于主分支提交构建
• 多架构镜像构建（amd64、arm64）
• 容器发布到GitHub容器注册表

地方发展

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

• ./scripts/build-local.sh：构建项目并创建本地Docker镜像
• ./scripts/run-local.sh：使用您的凭据运行本地Docker映像

许可证

麻省理工学院