关键词

ConfluenceAI助手知识库内容管理Atlassian

使用说明

项目简介

Confluence MCP服务器是一个专门为Atlassian Confluence知识库设计的MCP（Model Context Protocol）服务器。它充当AI助手和Confluence之间的桥梁，允许AI助手通过标准化的MCP协议，安全、高效地访问和操作Confluence中的页面、空间、评论和附件等内容。

主要功能点

  • 连接Confluence: 使用个人API令牌进行身份验证，安全访问Confluence实例。
  • 内容检索与搜索: 支持通过ID检索Confluence页面，以及使用CQL（Confluence Query Language）进行高级页面搜索。
  • 内容管理: 允许AI助手在Confluence中创建和更新页面内容。
  • 评论互动: 支持检索页面评论，以及为页面添加新的评论。
  • 附件管理: 支持检索页面附件，以及向页面上传新的附件。
  • 内容优化: 能够清洗和转换Confluence内容，使其更适合AI模型理解和处理。
  • 速率限制: 内置基础的速率限制，防止API滥用，保障Confluence API服务的稳定。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/cosmix/confluence-mcp.git
cd confluence-mcp
  2. 安装依赖 确保已安装 Bun (v1.0.0 或更高版本)。然后运行： 
    bun install
  3. 构建项目 
    bun run build

服务器配置

要将 Confluence MCP 服务器配置为 MCP 客户端的后端，您需要提供服务器启动命令和必要的环境变量。以下是一个配置示例，通常用于 MCP 客户端的设置文件（例如 Claude Desktop 或 Cline 的配置文件）。

{
  "mcpServers": {
    "confluence": {
      "command": "bun",
      "args": ["/absolute/path/to/confluence-mcp/dist/index.js"],
      "env": {
        "CONFLUENCE_API_TOKEN": "YOUR_CONFLUENCE_API_TOKEN",  // 您的Confluence API令牌
        "CONFLUENCE_BASE_URL": "YOUR_CONFLUENCE_INSTANCE_URL/wiki", // 您的Confluence实例URL，例如 https://your-domain.atlassian.net/wiki
        "CONFLUENCE_USER_EMAIL": "YOUR_CONFLUENCE_USER_EMAIL"   // 您的Confluence用户邮箱
      }
    }
  }
}

配置参数说明:

  • '"server name": "confluence"': 为您的Confluence MCP服务器指定一个名称，例如 "confluence"。这个名称将用于在MCP客户端中引用该服务器配置。
  • '"command": "bun"': 指定用于启动服务器的命令。这里使用 'bun' 运行时环境来执行JavaScript代码。
  • '"args": ["/absolute/path/to/confluence-mcp/dist/index.js"]': 'args' 数组定义了传递给 'bun' 命令的参数，即服务器入口文件 '/absolute/path/to/confluence-mcp/dist/index.js' 的绝对路径。请务必将 '/absolute/path/to/confluence-mcp' 替换为您本地 'confluence-mcp' 仓库 'dist/index.js' 文件的实际绝对路径。
  • '"env": { ... }': 'env' 对象用于设置服务器运行所需的环境变量。
    • '"CONFLUENCE_API_TOKEN"': [必填] 您的Confluence API令牌。您需要在您的Atlassian账户中生成API令牌，并替换 '"YOUR_CONFLUENCE_API_TOKEN"' 为您的实际令牌。
    • '"CONFLUENCE_BASE_URL"': [必填] 您的Confluence实例的基础URL，通常格式为 'https://your-domain.atlassian.net/wiki'。请替换 '"YOUR_CONFLUENCE_INSTANCE_URL/wiki"' 为您的实际Confluence实例URL。
    • '"CONFLUENCE_USER_EMAIL"': [必填] 您的Confluence账户邮箱地址。请替换 '"YOUR_CONFLUENCE_USER_EMAIL"' 为您的实际邮箱地址。

重要提示:

  • 绝对路径: 请确保 '"args"' 中 '/absolute/path/to/confluence-mcp/dist/index.js' 被替换为 'dist/index.js' 文件在您本地文件系统中的绝对路径。
  • 环境变量: 'CONFLUENCE_API_TOKEN', 'CONFLUENCE_BASE_URL', 和 'CONFLUENCE_USER_EMAIL' 是Confluence MCP服务器运行所必需的环境变量。请务必正确配置这些变量，否则服务器将无法连接到您的Confluence实例。
  • 安全性: 请妥善保管您的Confluence API令牌，避免泄露。

基本使用方法

  1. 确保Confluence MCP服务器已成功启动，并监听标准输入输出。
  2. 在您的MCP客户端（如 Claude）中，配置并添加名为 "confluence" (或您在配置中指定的server name) 的MCP服务器。客户端将使用您在 "服务器配置" 中提供的命令和参数来启动并连接到Confluence MCP服务器。
  3. 在MCP客户端中，您可以使用Confluence MCP服务器提供的工具，例如 'get_page', 'search_pages' 等，来与您的Confluence知识库进行交互。具体的工具和使用方法请参考该仓库 'README.md' 文档中 "Available Tools" 章节的详细说明。

例如，在支持工具调用的AI应用中，您可以指示AI使用 'confluence.get_page' 工具并提供 'pageId' 参数来获取指定Confluence页面的内容，或者使用 'confluence.search_pages' 工具进行Confluence知识库的搜索。

信息

分类

商业系统

访问项目