MCP 服务器

JIRA MCP Server for Cursor

一个模型上下文协议服务器，将 JIRA 直接集成到 Cursor IDE 中，允许用户查看分配给他们的 issue，获取特定 ticket 的详细信息，并将 JIRA issue 转换为本地任务，而无需离开他们的编辑器。

README

<div align="center">

# 🔗 JIRA MCP 服务器

[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white)](https://bun.sh/)
[![Jira](https://img.shields.io/badge/Jira-0052CC?style=for-the-badge&logo=Jira&logoColor=white)](https://www.atlassian.com/software/jira)
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![MCP](https://img.shields.io/badge/MCP-Model_Context_Protocol-blue?style=for-the-badge)](https://modelcontextprotocol.io)

<p align="center">
  <b>一个强大的模型上下文协议 (MCP) 服务器，可将 JIRA 集成直接带到任何支持 MCP 的编辑器或应用程序</b>
</p>

</div>

---

## ✨ 功能

- 📋 **直接从光标访问 JIRA**
  - 无需离开 IDE 即可查看您分配的问题
  - 通过一个命令获取有关特定问题的详细信息
  - 将 JIRA 问题无缝转换为本地任务

## 🚀 快速开始

### 安装

```bash
# 克隆仓库
git clone https://github.com/Dsazz/mcp-jira.git
cd mcp-jira

# 安装依赖
bun install

# 设置环境变量
cp .env.example .env
# 使用您的 JIRA 凭据编辑 .env

配置

创建一个包含以下变量的 .env 文件：

JIRA_HOST=https://your-instance.atlassian.net
JIRA_USERNAME=your-email@example.com
JIRA_API_TOKEN=your-jira-api-token-here

🔑 关于 JIRA API 令牌的重要说明

令牌可能包含特殊字符，包括 = 符号

将令牌放在 .env 文件中的单行上

不要用引号将令牌值括起来

完全按照 Atlassian 提供的形式粘贴令牌

🛠️ 开发工具

代码质量工具

该项目使用 Biome 进行代码格式化和 linting，取代了之前的 ESLint 设置。 Biome 提供：

快速、统一的格式化和 linting
TypeScript 优先的工具
无需配置
一致的代码风格强制执行

要格式化和 lint 您的代码：

# 格式化代码
bun format

# 检查代码是否存在问题
bun check

# 类型检查
bun typecheck

MCP 检查器

<details> <summary>点击展开 MCP 检查器详情</summary>

MCP 检查器是用于测试和调试 MCP 服务器的强大工具。

# 运行检查器（无需单独的构建步骤）
bun run inspect

检查器自动执行以下操作：

从 .env 加载环境变量
清理占用的端口 (5175, 3002)
在需要时构建项目
使用您的配置启动 MCP 服务器
启动检查器 UI

访问检查器：http://localhost:5175?proxyPort=3002

如果遇到端口冲突：

bun run cleanup-ports

使用检查器进行调试

检查器 UI 允许您：

查看所有可用的 MCP 功能
执行工具并检查响应
分析 JSON 通信
使用不同的参数进行测试

有关更多详细信息，请参阅 MCP 检查器 GitHub 仓库。

</details>

与 Claude Desktop 集成

<details> <summary>点击展开 Claude Desktop 集成</summary>

直接使用 Claude 测试您的 MCP 服务器：

构建：

bun run build  # 运行之前必须构建项目

配置 Claude Desktop：

nano ~/Library/Application\ Support/Claude/claude_desktop_config.json

添加 MCP 配置：

{
  "mcpServers": {
    "JIRA Tools": {
      "command": "node", //or "bun"
      "args": ["/absolute/path/to/your/project/dist/index.js"],
      "env": {
        "JIRA_USERNAME": "your-jira-username",
        "JIRA_API_TOKEN": "your-jira-api-token",
        "JIRA_HOST": "your-jira-host.atlassian.net"
      }
    }
  }
}

重启 Claude Desktop 并使用以下命令进行测试：
```
What time is it right now?
```
或者
```
Show me my assigned JIRA issues.
```

</details>

🔌 与 Cursor IDE 集成

⚠️ 重要提示： 在与 Cursor IDE 或 Claude Desktop 集成之前，必须使用 bun run build 构建项目。

将此 MCP 服务器添加到您的 Cursor IDE 的 MCP 配置中：

{
  "mcpServers": {
    "JIRA Tools": {
      "command": "node", // or "bun"
      "args": ["/absolute/path/to/your/project/dist/index.js"],
      "env": {
        "JIRA_USERNAME": "your-jira-username",
        "JIRA_API_TOKEN": "your-jira-api-token",
        "JIRA_HOST": "your-jira-host.atlassian.net"
      }
    }
  }
}

🧰 可用工具

JIRA 工具

工具	描述	参数	返回值
`jira_get_assigned_issues`	检索分配给您的所有问题	无	Markdown 格式的问题列表
`jira_get_issue`	获取有关特定问题的详细信息	`issueKey`: 问题键（例如，PD-312）	Markdown 格式的问题详情
`jira_create_task`	从 JIRA 问题创建本地任务	`issueKey`: 问题键（例如，PD-312）	Markdown 格式的任务

📁 项目结构

 src/
  ├── core/          # 核心功能和配置
  ├── features/      # 功能实现
  │   └── jira/      # JIRA API 集成
  │       ├── api/         # JIRA API 客户端
  │       ├── formatters/  # 响应格式化器
  │       └── tools/       # MCP 工具实现
  └── test/          # 测试实用程序

NPM 脚本

命令	描述
`bun dev`	在开发模式下运行服务器，并具有热重载功能
`bun build`	构建用于生产环境的项目
`bun start`	启动生产服务器
`bun format`	使用 Biome 格式化代码
`bun lint`	使用 Biome 进行代码检查
`bun check`	对代码运行 Biome 检查
`bun typecheck`	运行 TypeScript 类型检查
`bun test`	运行测试
`bun inspect`	启动 MCP 检查器进行调试
`bun cleanup-ports`	清理开发服务器使用的端口