JinDaGe - mcp-jira-cloud-v2 MCP Details

article

README

🚀 Jira 请求者 MCP 服务器

这是一个消息通信协议（MCP）服务器，用于与 Jira API（v2 客户端）交互，从而获取工单信息，助力实现工单管理自动化。

🚀 快速开始

此 MCP 服务器可与 Jira API（v2 客户端）交互，获取工单信息。以下是使用该服务器的详细步骤。

✨ 主要特性

与 Jira API（v2 客户端）交互，获取工单信息。
支持通过 MCP 协议进行请求和响应。
提供多种工具调用语法，可创建、查询和更新工单。

📦 安装指南

先决条件

Node.js（推荐版本：>= 18.x）
npm 或 yarn
Jira Cloud 实例
Jira API 令牌

安装步骤

克隆仓库

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

安装依赖项
- 使用 npm：
```
npm install
```
- 或使用 yarn：
```
yarn install
```

💻 使用示例

配置

此服务器需要环境变量来实现 Jira 身份验证和连接：

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

在项目根目录创建一个 .env 文件，并添加这些变量：

JIRA_BASE_URL=https://your-domain.atlassian.net
JIRA_USER_EMAIL=your-email@example.com
JIRA_API_TOKEN=your-api-token

注意：将 .env 添加到你的 .gitignore 文件中，以避免提交敏感凭证。

启动服务器

使用 npm：

npm start

或使用 yarn：

yarn start

通过 MCP 交互

一旦服务器运行起来，它将监听 MCP 请求。客户端可以通过发送工具调用来与之交互。

测试

你可以直接使用 simpleTest.ts 脚本测试 Jira 客户端功能。提供一个 Jira 工单 ID 作为参数。

使用 npm：

npm test <JIRA_TICKET_ID>

或者使用 yarn：

yarn test <JIRA_TICKET_ID>

构建

安装依赖项

npm install

运行测试脚本

npm test

构建项目

npm run build

MCP 服务器配置

将以下内容添加到你的 MCP 配置文件中：

{
  "servers": {
    "JiraServer": {
      "url": "http://localhost:8080",
      "token": "your-jira-token"
    }
  }
}

示例请求

以下是通过 MCP 发送的示例请求结构：

{
  "ticket_id": "T12345",
  "summary": "服务器错误报告",
  "description": "无法连接到数据库。",
  "priority": "高"
}

工具调用语法

创建工单

{
  "command": "create_ticket",
  "data": {
    "summary": "新问题报告",
    "description": "遇到新的问题需要处理。",
    "priority": "中"
  }
}

查询工单

{
  "command": "query_tickets",
  "data": {
    "status": "未解决",
    "assignee": "张三"
  }
}

更新工单

{
  "command": "update_ticket",
  "data": {
    "ticket_id": "T12345",
    "new_status": "已解决",
    "comments": ["问题已解决。"]
  }
}

🔧 技术细节

注意事项

确保服务器始终运行以接收实时请求。
定期检查日志文件，以便及时发现和解决问题。
配置监控工具以确保高可用性。

通过以上步骤，你可以顺利设置并运行一个与 Jira API 交互的 MCP 服务器，实现工单管理自动化。

mcp-jira-cloud-v2