使用说明

项目简介

Better Confluence Communication Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当 LLM 客户端与 Confluence 和 Jira 之间的桥梁。通过提供一系列预定义的工具，该服务器允许 LLM 客户端以标准化的方式访问和操作存储在 Confluence 和 Jira 平台上的信息，从而扩展 LLM 在知识管理和项目协作方面的应用能力。

主要功能点

Confluence 知识库集成:
- 页面检索: 支持使用 Confluence Query Language (CQL) 查询 Confluence 页面。
- 内容获取: 能够获取指定 Confluence 页面的内容。
- 页面管理: 允许创建和更新 Confluence 页面。
Jira 问题跟踪集成:
- 问题检索: 支持使用 Jira Query Language (JQL) 查询 Jira 问题。
- 问题管理: 允许创建、更新 Jira 问题和变更问题状态。
- Sprint 管理: 支持获取 Jira 看板的 Sprint 信息和 Sprint 中的 Issue 信息。
MCP 服务器: 遵循 Model Context Protocol 协议，提供与 LLM 客户端进行标准化通信的能力。
工具化操作: 提供一系列预定义的工具，LLM 客户端可以通过调用这些工具执行 Confluence 和 Jira 的操作。
Stdio 传输: 使用标准输入/输出 (stdio) 作为 MCP 服务器与客户端之间的通信通道。

安装步骤

安装 npm 包: 使用 npm (或 npx) 安装 '@zereight/mcp-confluence' 包。
```
npx -y @zereight/mcp-confluence
```
此命令会使用 'npx' 安装并执行 '@zereight/mcp-confluence' 包，实际是下载并准备好服务器运行环境。

服务器配置

为了让 MCP 客户端能够连接和使用 Confluence communication server，需要在 MCP 客户端的配置中添加服务器信息。以下是一个典型的 JSON 格式配置示例，适用于 Claude App, Cline, Roo Code 等 MCP 客户端：

{
  "mcpServers": {
    "Confluence communication server": {  // MCP 服务器名称，可以自定义
      "command": "npx",  // 启动服务器的命令，这里使用 npx
      "args": ["-y", "@zereight/mcp-confluence"],  // 启动命令的参数，指定要运行的 npm 包
      "env": {  // 环境变量配置，用于Confluence和Jira API 鉴权
        "CONFLUENCE_URL": "YOUR_CONFLUENCE_URL",  // 您的 Confluence 实例 URL，例如：https://YOUR_WORKSPACE.atlassian.net
        "JIRA_URL": "YOUR_JIRA_URL",  // 您的 Jira 实例 URL，例如：https://YOUR_WORKSPACE.atlassian.net
        "CONFLUENCE_API_MAIL": "YOUR_CONFLUENCE_EMAIL",  // 用于 Confluence API 访问的邮箱地址
        "CONFLUENCE_API_KEY": "YOUR_CONFLUENCE_API_KEY"  // Confluence API 密钥，请在 Atlassian 账户的安全设置中生成 API 密钥：https://id.atlassian.com/manage-profile/security/api-tokens
      }
    }
  }
}

请将 'YOUR_CONFLUENCE_URL', 'YOUR_JIRA_URL', 'YOUR_CONFLUENCE_EMAIL', 'YOUR_CONFLUENCE_API_KEY' 替换为您的实际 Confluence 和 Jira 实例信息以及 API 凭证。

基本使用方法

配置完成后，启动 MCP 客户端，客户端将自动连接到 Confluence communication server。之后，您可以通过客户端提供的界面或指令，调用服务器提供的各种工具，例如：

使用 'execute_cql_search' 工具，输入 CQL 查询语句，检索 Confluence 页面。
使用 'get_page_content' 工具，输入 Confluence 页面 ID，获取页面内容。
使用 'create_jira_issue' 工具，输入 Jira 项目、问题概要、问题类型等信息，创建 Jira issue。

更多工具及其使用方法，请参考仓库 README.md 文件中 “Confluence Tools” 和 “Jira Tools” 部分的详细描述和输入参数说明。

关键词