项目简介

Jira MCP服务端是一个基于Model Context Protocol (MCP) 构建的强大后端应用,旨在将Jira和Atlassian的丰富功能,如项目管理、问题CRUD(创建、读取、更新、删除)、评论、状态转换、用户和Sprint管理,以及Confluence页面访问等,以标准化和AI友好的方式提供给大型语言模型(LLM)客户端。它通过优化的响应和Markdown自动转换为Atlassian Document Format (ADF) 等功能,提高LLM交互的效率和便捷性。

主要功能点

  • 项目管理: 轻松获取所有Jira项目列表及每个项目支持的问题类型,帮助LLM理解项目结构。
  • 问题生命周期管理: 支持LLM客户端创建新的Jira问题,以及读取、更新和删除现有问题,实现全面的问题跟踪。
  • 评论管理: 允许LLM客户端创建、读取、更新和删除Jira问题评论,并支持自动将Markdown格式的评论内容转换为Jira可识别的ADF格式。
  • 状态转换: 引导Jira问题在不同的工作流状态间流转,例如将问题从“待办”转换为“进行中”。
  • 任务分配与用户搜索: 支持将Jira问题分配给特定用户,并提供用户搜索功能,方便LLM查找团队成员。
  • Sprint管理: 提供全面的敏捷Sprint生命周期管理功能,包括创建、更新、关闭、删除Sprint,以及向Sprint中移动问题,支持敏捷开发流程。
  • Confluence Wiki集成: 通过Confluence页面代码访问和获取页面内容,并将其转换为简洁的纯文本格式,方便LLM理解和利用知识库。
  • 富文本支持: 自动将Markdown格式的输入内容(如问题描述、评论)转换为Jira兼容的Atlassian Document Format (ADF),保证格式的正确显示。
  • AI优化响应: 通过仅返回必要的字段、缩短字段名称和过滤自定义字段等方式,优化服务器响应,有效减少LLM的Token消耗,提高效率。

安装步骤

推荐方式 (使用npx)

这是最简单快捷的使用方式,无需手动下载和构建项目:

  1. 确保您的系统安装了Node.js 18+环境
  2. 配置您的MCP客户端(例如Claude Desktop)以使用该服务器。当客户端需要时,Jira MCP服务器将自动下载并运行。

本地开发方式

如果您希望在本地进行开发或更精细的控制:

  1. 克隆仓库: 打开终端,运行以下命令:
    git clone https://github.com/raalarcon9705/jira-mcp.git
    cd jira-mcp
  2. 安装依赖: 在项目目录下运行:
    npm install
  3. 构建项目: 编译TypeScript代码:
    npm run build
  4. 配置您的MCP客户端: 指向编译后的服务器文件,详情请看“服务器配置”部分。

服务器配置

为了让您的MCP客户端能够连接并使用Jira MCP服务器,您需要在MCP客户端中进行以下JSON格式的配置。这通常涉及到设置服务器的启动命令及其环境变量。

使用 'npx' 启动 (推荐)

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": ["-y", "raalarcon-jira-mcp-server"],
      "env": {
        "JIRA_HOST": "https://your-domain.atlassian.net", // 替换为你的Jira Cloud域名,例如 "https://example.atlassian.net"
        "JIRA_EMAIL": "[email protected]",           // 替换为你的Atlassian账号邮箱
        "JIRA_API_TOKEN": "your-api-token"                // 替换为你的Jira API令牌(请参阅项目README获取详细创建步骤)
      }
    }
  }
}

本地运行服务器启动

{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": ["/full/path/to/jira-mcp/dist/index.js"], // 替换为你的jira-mcp项目根目录下的dist/index.js的绝对路径
      "env": {
        "JIRA_HOST": "https://your-domain.atlassian.net", // 替换为你的Jira Cloud域名
        "JIRA_EMAIL": "[email protected]",           // 替换为你的Atlassian账号邮箱
        "JIRA_API_TOKEN": "your-api-token"                // 替换为你的Jira API令牌
      }
    }
  }
}

基本使用方法

一旦在MCP客户端中配置完成,您的LLM将能够通过调用Jira MCP服务器提供的各种工具来执行Jira操作。

例如:

  • 如果LLM需要了解当前可用的Jira项目,它会调用 'get_projects' 工具,服务器将返回一个精简的项目列表。
  • 当用户要求LLM创建一个Jira问题时,LLM可以调用 'create_issue' 工具,并提供项目键、摘要、问题类型等必要参数。如果用户提供了Markdown格式的描述,服务器会自动将其转换为Jira接受的ADF格式。
  • LLM还可以利用 'get_comments' 工具获取问题的评论,或者使用 'transition_issue' 工具来改变问题的工作流状态。

所有这些交互都通过MCP协议的JSON-RPC格式进行,Jira MCP服务器会处理与Jira API的实际通信,并将优化后的结果返回给LLM,使其能够高效地理解和响应用户关于Jira的请求。

信息

分类

开发者工具