关键词

JiraIssue跟踪项目管理工作流敏捷开发

Jira MCP Server 使用说明

项目简介

Jira MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，专注于将 Atlassian Jira 项目管理工具的数据和功能以标准化的方式暴露给大型语言模型 (LLM) 客户端。通过该服务器，LLM 应用可以便捷地访问和操作 Jira 资源，例如 Issues，从而实现更智能化的工作流程集成。

主要功能点

  • Jira Issues 资源管理: 允许 LLM 客户端通过 MCP 协议访问和管理 Jira Issues 资源。支持资源的列表查询、读取、更新和删除等操作。
  • 标准 MCP 协议支持: 完全遵循 MCP 协议规范，确保与任何兼容 MCP 协议的 LLM 客户端无缝对接。
  • Jira REST API 集成: 深度集成了 Jira REST API，利用其丰富的功能，提供全面的 Jira 数据访问能力。
  • 灵活配置: 通过环境变量进行 Jira 连接配置，方便部署和管理。
  • 健康检查和版本查询: 提供标准的 '/health' 和 '/version' 端点，方便监控和版本管理。
  • 错误处理: 具备完善的错误处理机制，确保服务器稳定运行。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/uddeshya-23/mcp-server-JIRA.git
cd mcp-server-JIRA
  2. 安装依赖: 确保已安装 Node.js (14 或更高版本) 和 npm (6 或更高版本)。运行以下命令安装项目依赖： 
    npm install

服务器配置

MCP 服务器需要以下配置信息才能启动并与 Jira API 建立连接。请将以下配置信息添加到您的 MCP 客户端的服务器配置中。

{
  "serverName": "JiraMCP",
  "command": "npm",
  "args": [
    "start"
  ],
  "environmentVariables": {
    "JIRA_HOST": "your-domain.atlassian.net",  // 【必填】您的 Jira 域名，例如 your-domain.atlassian.net
    "JIRA_API_TOKEN": "your-api-token",      // 【必填】您的 Jira API Token，用于 API 鉴权
    "JIRA_EMAIL": "[email protected]",      // 【必填】您的 Jira 账户邮箱，用于 API 鉴权
    "PORT": "3001"                              // 【可选】服务器端口号，默认为 3001
  }
}

配置说明:

  • 'serverName': MCP 服务器的名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'npm'。
  • 'args': 启动命令的参数，'start' 对应 'package.json' 中的启动脚本。
  • 'environmentVariables': 环境变量配置，用于配置 Jira 连接信息和服务器端口。
    • 'JIRA_HOST', 'JIRA_API_TOKEN', 'JIRA_EMAIL': 必须配置，请替换为您的 Jira 实例的实际信息。您需要在 Atlassian 账户中生成 API Token。
    • 'PORT': 可选配置，如果需要修改服务器监听端口，可以在这里配置。默认端口为 '3001'。

请注意: 在 MCP 客户端配置中设置环境变量是推荐的方式，确保敏感信息安全。

基本使用方法

  1. 配置环境变量: 在服务器运行环境中配置上述 '服务器配置' 中 'environmentVariables' 下的环境变量。或者在MCP客户端配置中正确填写。
  2. 启动服务器: 在项目根目录下，根据运行模式选择启动命令：
    • 开发模式: 用于本地开发和调试，使用热重载： 
      npm run dev
    • 生产模式: 用于生产环境部署，构建优化后的代码并启动服务器： 
      npm run build
npm start
  3. LLM 客户端交互: 启动 Jira MCP Server 后，您的 MCP 客户端即可通过 MCP 协议与服务器进行通信，请求访问 Jira Issues 资源。具体的资源 URI 和操作方法请参考 MCP 协议文档以及客户端的指南。例如，客户端可以发送 'list' 请求查询 Issues 列表，或发送 'read' 请求读取指定 Issue 的详细信息。

API 端点 (供开发或调试参考，MCP客户端无需直接调用)

虽然 MCP 客户端通常通过 MCP 协议与服务器交互，但以下 HTTP API 端点可用于开发、调试或监控服务器状态：

  • 'GET /health': 健康检查端点，返回 '{ status: 'healthy' }' 表示服务器运行正常。
  • 'GET /version': 版本查询端点，返回服务器版本信息，例如 '{ version: '1.0.0' }'。
  • 'GET /api/v1/issues/:issueKey': 获取指定 Issue 详情。
  • 'GET /api/v1/sprint/current': 获取当前 Sprint 的详情。
  • 'GET /api/v1/analytics/workload': 获取工作负载分析数据。

注意: 这些 API 端点是服务器为了方便集成和测试而提供的 HTTP 接口，MCP 客户端应主要使用 MCP 协议进行交互。

信息

分类

开发者工具

访问项目