Confluence MCP

用于Confluence的模型上下文协议（MCP）服务器，使AI助手能够通过标准化接口与Confluence内容进行交互。

ℹ️ 有一个单独的MCP服务器针对Jira

功能

• 使用个人API令牌对Confluence进行身份验证
• 获取和搜索Confluence页面和空间
• 创建和更新Confluence内容
• 获取并添加页面评论
• 获取并添加页面附件
• 清理和转换Confluence内容以供AI消费
• 处理API通信、错误处理和数据转换
• 基本速率限制以防止滥用API

预备条件

• Bun（v1.0.0或更高版本）
• 具有API访问权限的Confluence账户

安装

# 克隆仓库
git clone https://github.com/cosmix/confluence-mcp.git
cd confluence-mcp

# 安装依赖
bun install

# 构建项目
bun run build

配置

要使用此MCP服务器，您需要设置以下环境变量：

CONFLUENCE_API_TOKEN=your_api_token
CONFLUENCE_BASE_URL=your_confluence_instance_url  # 例如：https://your-domain.atlassian.net/wiki
CONFLUENCE_USER_EMAIL=your_email

Claude Desktop / Cline配置

在您的设置文件中添加以下配置：

{
  "mcpServers": {
    "confluence": {
      "command": "bun",
      "args": ["/absolute/path/to/confluence-mcp/dist/index.js"],
      "env": {
        "CONFLUENCE_API_TOKEN": "your_api_token",
        "CONFLUENCE_BASE_URL": "your_confluence_instance_url/wiki",
        "CONFLUENCE_USER_EMAIL": "your_email"
      }
    }
  }
}

开发

# 在开发模式下运行
bun run dev

# 运行测试
bun test

可用工具

Confluence MCP服务器提供了以下工具：

get_page

通过ID检索Confluence页面。格式指的是内容的返回格式，可以是text或markdown。includeMarkup参数允许检索原始的Confluence存储格式（XHTML）标记，这对于在更新页面时保留格式非常有用。

{
  "pageId": "123456",
  "format": "text",
  "includeMarkup": true
}

search_pages

使用CQL（Confluence查询语言）搜索Confluence页面。格式指的是内容的返回格式，可以是text或markdown。includeMarkup参数允许为每个页面检索原始的Confluence存储格式（XHTML）标记。

{
  "query": "space = DEV and label = documentation",
  "limit": 110,
  "format": "text",
  "includeMarkup": true
}

get_spaces

列出所有可用的Confluence空间。

{
  "limit": 50
}

create_page

创建新的Confluence页面。parentId是可选的，可用于在现有页面下创建子页面。

{
  "spaceKey": "DEV",
  "title": "新页面标题",
  "content": "<p>Confluence存储格式（XHTML）中的页面内容</p>",
  "parentId": "123456"
}

update_page

更新现有的Confluence页面。

{
  "pageId": "123456",
  "title": "更新后的页面标题",
  "content": "<p>Confluence存储格式（XHTML）中的更新内容</p>",
  "version": 1
}

get_comments

检索特定Confluence页面的评论。格式指的是内容的返回格式，可以是text或markdown。

{
  "pageId": "123456",
  "limit": 25,
  "format": "text"
}

add_comment

向Confluence页面添加评论。parentId是可选的，用于创建线程回复。

{
  "pageId": "123456",
  "content": "<p>这是一个新的评论。</p>",
  "parentId": "789012"
}

get_attachments

检索特定Confluence页面的附件。

{
  "pageId": "123456",
  "limit": 25
}

add_attachment

向Confluence页面添加附件。fileContentBase64应该是文件内容的base64编码字符串。

{
  "pageId": "123456",
  "filename": "document.pdf",
  "fileContentBase64": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+P...",
  "comment": "上传了文档的新版本"
}

许可证

本项目采用MIT许可证——详情见LICENSE文件。 </中文翻译>