关键词

JiraConfluenceAtlassianAI助手集成工作流自动化

项目简介

MCP Atlassian Server 是一个基于 Model Context Protocol (MCP) 构建的服务器实现。它充当 AI 助手（如 Cline、Claude Desktop 等）与 Atlassian Jira 和 Confluence 之间的桥梁。通过遵循 MCP 标准，该服务器使得 AI 代理能够以结构化的方式访问 Jira 和 Confluence 中的信息（资源）并执行操作（工具），从而实现基于 AI 的 Jira/Confluence 工作流自动化。

主要功能点

  • Jira 集成: 提供对 Jira 项目、问题 (Issue)、用户、评论等的数据访问能力。
  • Confluence 集成: 提供对 Confluence 空间 (Space)、页面 (Page)、子页面、评论等的数据访问能力。
  • 数据查询 (资源): 允许 AI 助手通过标准化的 URI 访问 Jira/Confluence 数据。例如，查询特定 Jira 问题详情、列出所有 Jira 项目、获取 Confluence 空间下的页面列表等。
  • 功能操作 (工具): 允许 AI 助手调用预定义的功能来在 Jira/Confluence 中执行操作。例如，创建新的 Jira 问题、更新现有问题、转换问题状态、分配问题给用户、创建 Confluence 页面、向页面添加评论等。
  • 标准化接口: 使用 Model Context Protocol (MCP) 标准的 JSON-RPC 接口与 MCP 客户端通信。
  • 多功能支持: 支持 MCP 的资源 (Resources) 和工具 (Tools) 能力。
  • 便捷安装: 设计为易于被 MCP 客户端（如 Cline）识别和安装，特别是通过解析特定的安装指南文件。

安装步骤

本服务器需要 Node.js 环境。详细的安装指南通常由您的 MCP 客户端（如 Cline）根据项目提供的 'llms-install.md' 文件自动解析和执行。

一般来说，您需要：

  1. 确保您的系统已安装 Node.js。

  2. 从 GitHub 克隆或下载本仓库的代码。

  3. 在项目根目录安装依赖：运行 'npm install' 或 'yarn install'。

  4. 获取 Atlassian API 凭证: 您需要一个 Atlassian Cloud 账号，并生成一个 API 令牌。请参考 Atlassian 的官方文档获取您的站点名称、用户邮箱和 API 令牌。

  5. 配置 Atlassian 凭证: 在项目根目录创建一个 '.env' 文件，并添加以下内容，替换为您的实际凭证：

    ATLASSIAN_SITE_NAME=您的Atlassian站点名称 (例如: yourcompany.atlassian.net 或 yourcompany)
ATLASSIAN_USER_EMAIL=您的Atlassian用户邮箱
ATLASSIAN_API_TOKEN=您的Atlassian API令牌
# 可选配置，用于日志级别和服务器名称/版本
# LOG_LEVEL=info # 可选 debug, info, warn, error
# MCP_SERVER_NAME=my-atlassian-server
# MCP_SERVER_VERSION=1.0.0

  6. 构建项目: 运行 'npm run build' 或 'yarn build' 来编译 TypeScript 代码。

完成上述步骤后，MCP 服务器即可运行。请注意，它通常不是一个独立的长时间运行服务，而是由 MCP 客户端在需要时启动和管理的子进程。

服务器配置 (供MCP客户端参考)

您的 MCP 客户端需要配置如何启动和连接到这个服务器。典型的 MCP 客户端配置会包含服务器的名称、启动命令和参数。Atlassian 凭证则需要作为环境变量提供给服务器进程。

以下是 MCP 客户端可能需要配置的示例信息（具体格式取决于客户端）：

  • 服务器名称 (server_name): 'mcp-atlassian-integration' (或其他您在'.env'中配置的 'MCP_SERVER_NAME')
  • 启动命令 (command): 'node'
  • 命令参数 (args): '["dist/index.js"]' (这指示 Node.js 运行编译后的服务器入口文件)
  • 环境变量 (environment): 您需要确保 MCP 客户端在启动此服务器进程时，能够传递以下环境变量：
    • 'ATLASSIAN_SITE_NAME'
    • 'ATLASSIAN_USER_EMAIL'
    • 'ATLASSIAN_API_TOKEN' (这些变量的实际值通常由用户在 MCP 客户端的界面中配置，而不是直接写在 MCP 客户端的配置 JSON 中)

例如，一个 MCP 客户端的 JSON 配置片段可能看起来像这样（注意，这是客户端的配置，不是您在本仓库中修改的文件）：

{
  "servers": [
    {
      "server_name": "mcp-atlassian-integration",
      "command": "node",
      "args": ["dist/index.js"],
      "capabilities": ["resources", "tools"],
      // 客户端通常会在这里提供一个界面让用户填写凭证，
      // 然后在启动进程时作为环境变量传递
      "env_vars": {
         "ATLASSIAN_SITE_NAME": "${user_configured_site_name}",
         "ATLASSIAN_USER_EMAIL": "${user_configured_email}",
         "ATLASSIAN_API_TOKEN": "${user_configured_api_token}"
      }
    }
  ]
}

(请再次注意：您不需要复制上面的 JSON 代码到本项目中，这是供 MCP 客户端开发者或高级用户理解如何配置客户端的示例)

基本使用方法

一旦 MCP 服务器被您的 AI 助手成功安装和配置（包括设置 Atlassian 凭证），您就可以直接通过自然语言命令让 AI 助手与 Jira 和 Confluence 交互了。

示例自然语言命令（具体表达方式取决于您的 AI 助手）：

  • 查询 Jira 问题:
    • "查找所有分配给我的 Jira 问题"
    • "查看问题 PROJ-123 的详情"
    • "列出项目 DEV 中状态为 '待办' 的所有问题"
  • 操作 Jira 问题:
    • "在项目 MARKETING 中创建一个关于网站改版的新任务，标题是 '更新首页文案'"
    • "将问题 PROJ-456 的状态改为 '进行中'"
    • "把问题 PROJ-789 分配给用户 Alice"
  • 查询 Confluence 页面:
    • "列出空间 DOC 下的所有页面"
    • "查看页面 ID 为 12345 的内容"
    • "搜索 Confluence 中包含 'API 文档' 的页面"
  • 操作 Confluence 页面:
    • "在空间 WIKI 中创建一个标题为 '团队会议纪要' 的新页面，内容是 '讨论了项目进展...'"
    • "给页面 ID 67890 添加一条评论：'请大家审核一下内容'"

AI 助手会解析您的命令，将其转换为对 MCP 服务器的资源读取或工具调用请求，服务器执行操作或获取数据后，将结果返回给 AI 助手，最终以用户友好的方式呈现给您。

信息

分类

开发者工具

访问项目