Confluence MCP

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

ℹ️ 存在一个独立的 Jira MCP 服务器

功能

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

前提条件

• Bun (v1.0.0 或更高版本)
• 具有 API 访问权限的 Confluence 帐户

安装

# 克隆存储库
git clone https://github.com/yourusername/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 页面。Format 指的是内容的返回格式，可以是 text 或 markdown。

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

search_pages

使用 CQL（Confluence 查询语言）搜索 Confluence 页面。Format 指的是内容的返回格式，可以是 text 或 markdown。

{
  "query": "space = DEV and label = documentation",
  "limit": 10,
  "format": "text"
}

get_spaces

列出所有可用的 Confluence 空间。

{
  "limit": 50
}

create_page

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

{
  "spaceKey": "DEV",
  "title": "New Page Title",
  "content": "<p>Page content in Confluence Storage Format (XHTML)</p>",
  "parentId": "123456" 
}

update_page

更新现有的 Confluence 页面。

{
  "pageId": "123456",
  "title": "Updated Page Title",
  "content": "<p>Updated content in Confluence Storage Format (XHTML)</p>",
  "version": 1
}

get_comments

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

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

add_comment

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

{
  "pageId": "123456",
  "content": "<p>This is a new comment.</p>",
  "parentId": "789012" 
}

get_attachments

检索特定 Confluence 页面的附件。

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

add_attachment

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

{
  "pageId": "123456",
  "filename": "document.pdf",
  "fileContentBase64": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+P...",
  "comment": "Uploaded new version of the document"
}

许可

本项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENCE 文件。