Jira Requester MCP Server

Jira Requester MCP 服务

这是一个消息通信协议（MCP）服务，旨在通过 Jira API（v2 客户端）获取工单信息。

先决条件

• Node.js（推荐版本：>= 20.x.x）
• npm（随 Node.js 一同安装）
• Jira Cloud 实例
• Jira API Token

安装

1. 克隆代码库：

   git clone https://github.com/scho-to/mcp-jira-cloud-v2.git
   cd mcp-jira-cloud-v2
   

2. 安装依赖项：

   npm install
   

配置

此服务需要使用环境变量进行 Jira 身份验证和连接：

• JIRA_URL：Jira 实例的基础 URL（例如，https://your-domain.atlassian.net）。
• JIRA_USER_EMAIL：与 Jira 账户关联的电子邮件地址。
• JIRA_API_TOKEN：Jira API Token。你可以在 Atlassian 账户设置中生成 Token。

在项目根目录中创建 .env 文件并添加这些变量（或在环境中设置它们）：

JIRA_URL=https://your-domain.atlassian.net
[email protected]
JIRA_API_TOKEN=your-api-token

重要： 如果使用 .env 文件，请确保将其添加到 .gitignore，以免提交敏感凭据。

使用方法

1. 构建项目：

   npm run build
   

2. 启动服务（构建后）：

   npm start
   

   或者，在开发模式下运行服务并启用热重载（编译并运行）：

   npm run dev
   

3. 通过 MCP 交互： 服务运行后（通过 npm start 或 npm run dev 启动），即可监听 MCP 请求。

测试

你可以使用 simpleTest.ts 脚本直接测试 Jira 客户端功能。此脚本要求将 Jira 凭据设置为环境变量。

1. 运行测试脚本： 将 Jira 工单 ID 作为参数提供。

   npm test -- <JIRA_TICKET_ID>
   

   （-- 对于通过 npm 向脚本传递参数非常重要）

构建

本项目使用 TypeScript 编译器（tsc）构建。它会将 src 中的 TypeScript 源文件（.ts）编译为 build 目录中的 JavaScript 文件（.js）。

构建项目：

npm run build

MCP 服务配置

要在 MCP 环境中配置此服务，请将以下配置添加到 MCP 配置文件中：

{
  "mcpServers": {
    "jira-requester": {
      "command": "node",
      "env": {
        "JIRA_URL": "https://your-instance.atlassian.net",
        "JIRA_USER_EMAIL": "[email protected]",
        "JIRA_API_TOKEN": "your-api-token"
      },
      "args": ["/path/to/mcp-jira-cloud-v2/build/index.js"]
    }
  }
}

注意： 请将 https://your-instance.atlassian.net、[email protected]、your-api-token 和 /path/to/mcp-jira-cloud-v2/build/index.js 等占位符替换为实际的 Jira 实例 URL、凭据以及构建后的 index.js 文件的正确路径。

安全警告： 避免将 API Token 等敏感信息直接提交到配置文件中。请考虑使用环境变量或机密管理系统。

可用工具

get_jira_ticket

获取指定 Jira 工单的详细信息。

参数：

• ticket_id（字符串，必填）：Jira 工单的 ID（例如，PROJ-123）。
• fields（字符串数组，可选）：指定要包含在响应中的字段。如果省略，可能会返回默认字段。
• expand（字符串数组，可选）：指定要展开的 Jira 字段（例如，changelog、renderedFields）。

MCP 请求示例：

{
  "tool_name": "get_jira_ticket",
  "parameters": {
    "ticket_id": "PROJ-123",
    "fields": ["summary", "status", "assignee"],
    "expand": ["renderedFields"]
  }
}