Jira-Context-MCP 使用说明

项目简介

Jira-Context-MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接大型语言模型 (LLM) 应用和 Jira 缺陷跟踪系统。通过提供一系列预定义的工具，该服务器允许 LLM 客户端便捷地查询和获取 Jira 上的 Issue 信息，从而实现更智能化的工作流程自动化和上下文感知应用。

主要功能点

获取 Jira Issue 详情: 根据 Issue Key (例如：PROJECT-123) 检索并返回指定 Jira Issue 的详细信息，包括摘要、描述、状态、类型、优先级、经办人、报告人、创建/更新时间、项目、标签等。
获取经办人的 Issue 列表: 查询当前 Jira 用户经办的 Issue 列表，并可按项目筛选，支持设置最大返回结果数。
按 Issue 类型获取 Issue 列表: 根据指定的 Issue 类型 (如 Bug, Story, Epic) 检索 Issue 列表，并可按项目筛选，支持设置最大返回结果数。
获取 Jira 项目列表: 列出当前 Jira 用户有权访问的所有项目。
获取 Jira Issue 类型列表: 列出 Jira 系统中可用的 Issue 类型。

安装步骤

环境准备:
- 确保已安装 Node.js 20.17.0 或更高版本。
- 拥有 Jira 账号并开通 API 访问权限。
- 获取 Jira API Token (在 Atlassian API Tokens 生成)。

下载代码:

git clone https://github.com/rahulthedevil/Jira-Context-MCP.git
cd Jira-Context-MCP

安装依赖:

npm install

或者使用 pnpm:

pnpm install

配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后编辑 '.env' 文件，填入你的 Jira 相关信息：

JIRA_BASE_URL=https://your-domain.atlassian.net  # 你的 Jira 域名
[email protected]        # 你的 Jira 邮箱
JIRA_API_TOKEN=your-api-token-here         # 你的 Jira API Token
HTTP_PORT=3000                              # (可选) HTTP 服务器端口，默认为 3000

构建项目:

npm run build

或者使用 pnpm:

pnpm build

服务器配置 (MCP 客户端)

以下 JSON 配置信息用于 MCP 客户端连接 Jira-Context-MCP 服务器。你需要将此配置添加到你的 MCP 客户端中。

{
  "serverName": "Jira-Context-MCP",
  "command": "npm",
  "args": ["start"],
  "description": "连接到 Jira，提供 Jira Issue 查询功能。"
}

配置参数说明:

'serverName': 服务器名称，自定义，例如 "Jira-Context-MCP"。
'command': 启动服务器的命令，这里使用 'npm'。
'args': 启动命令的参数，'["start"]' 表示执行 'npm start' 脚本来启动服务器。
'description': 服务器描述，用于在 MCP 客户端界面显示，方便用户理解服务器用途。

注意: 如果你的 MCP 客户端需要指定服务器地址，默认情况下 Jira-Context-MCP HTTP 服务器运行在 'http://localhost:3000/sse'。

基本使用方法

启动服务器: 在项目根目录下，运行以下命令启动 HTTP 服务器：
```
npm start
```
或者启动 CLI 模式 (用于 Stdio 传输)：
```
npm run start:cli
```
连接 MCP 客户端: 在支持 MCP 协议的客户端 (例如 Cursor) 中，按照客户端的指引连接到 MCP 服务器。通常需要输入服务器 URL 'http://localhost:3000/sse' (如果使用 HTTP SSE 传输)。
使用工具: 连接成功后，在 MCP 客户端中使用预定义的工具命令来查询 Jira 信息。例如：
- 获取 Issue 详情: '/get_issue issueKey:PROJECT-123'
- 获取经办的 Issues: '/get_assigned_issues projectKey:PROJECT'
- 获取指定类型的 Issues: '/get_issues_by_type issueType:Bug projectKey:PROJECT'
- 获取项目列表: '/get_projects'
- 获取 Issue 类型列表: '/get_issue_types'
具体工具命令和参数请参考仓库 README.md 文件中 "Available Tools" 部分的说明。

通过以上步骤，你就可以利用 Jira-Context-MCP 服务器，在 LLM 应用中无缝集成 Jira 数据，提升工作效率。

关键词