使用说明

项目简介

Jira MCP 是一个基于 Go 语言开发的 MCP (Model Context Protocol) 服务器，它充当 Jira 和大型语言模型 (LLM) 客户端（如 Claude, Cursor 等 AI 助手）之间的桥梁。通过 Jira MCP，LLM 客户端能够以标准化的方式访问和操作 Jira 资源，例如查询 issue 详情、搜索 issue、管理 sprint、创建和更新 issue、获取状态以及进行工作流转换等，从而实现更智能化的 Jira 交互体验。

主要功能点

Issue 管理: 获取 issue 详情、创建、更新 issue。
Issue 搜索: 使用 JQL (Jira Query Language) 搜索 issue。
Sprint 管理: 列出和管理 Jira sprint。
状态管理: 获取 Jira issue 的可用状态。
工作流管理: 转换 issue 工作流状态。
评论管理: 添加和获取 issue 评论。
工作日志管理: 记录 issue 工作日志。

安装步骤

方式一：从 GitHub Releases 下载 (推荐)

访问 GitHub Releases 页面。
根据您的操作系统下载对应的预编译二进制文件：
- Linux: 'jira-mcp_linux_amd64'
- macOS: 'jira-mcp_darwin_amd64'
- Windows: 'jira-mcp_windows_amd64.exe'
(Linux/macOS) 赋予二进制文件执行权限：
```
chmod +x jira-mcp_*
```

(Linux/macOS) 将其移动到 PATH 环境变量包含的目录，例如 '/usr/local/bin':

sudo mv jira-mcp_* /usr/local/bin/jira-mcp

方式二：使用 Go install 确保您已安装 Go 语言环境。

go install github.com/nguyenvanduocit/jira-mcp

安装完成后，'jira-mcp' 可执行文件通常位于 '$GOPATH/bin' 目录下。

方式三：使用 Docker (推荐)

构建 Docker 镜像：

docker build -t jira-mcp .

服务器配置

Jira MCP 服务器需要以下环境变量进行身份验证，您需要预先获取 Jira 的 API token。

'ATLASSIAN_HOST': 您的 Jira 实例主机地址 (例如 'your_jira_instance.atlassian.net')
'ATLASSIAN_EMAIL': 您的 Atlassian 账户邮箱地址
'ATLASSIAN_TOKEN': 您的 Atlassian API Token (您可以在 https://id.atlassian.com/manage-profile/security/api-tokens 创建和管理)

MCP 客户端配置 (以 Cursor 为例):

在 Cursor 或其他 MCP 客户端中添加 MCP 服务器配置，以便连接到 Jira MCP 服务器。以下是两种配置方式，推荐使用 Docker 方式。

配置方式 A: 使用 Docker (推荐)

{
  "mcpServers": {
    "jira": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e", "ATLASSIAN_HOST=your_jira_instance.atlassian.net",
        "-e", "[email protected]",
        "-e", "ATLASSIAN_TOKEN=YOUR_ATLASSIAN_API_TOKEN",
        "jira-mcp"
      ]
    }
  }
}

参数说明:

'server name': 'jira' (服务器名称，可以自定义)
'command': 'docker' (启动命令，这里使用 docker)
'args': 启动参数，包括 'docker run' 命令及其参数：
- '--rm': 容器退出后自动删除
- '-i': 保持 STDIN 开放
- '-e ATLASSIAN_HOST=...': 设置 Jira 主机地址环境变量
- '-e ATLASSIAN_EMAIL=...': 设置 Jira 邮箱环境变量
- '-e ATLASSIAN_TOKEN=...': 设置 Jira API Token 环境变量
- 'jira-mcp': Docker 镜像名称

配置方式 B: 使用本地二进制文件

如果您选择下载二进制文件或使用 'go install' 方式安装，可以使用本地二进制文件配置。请根据您的实际安装路径修改 'command' 字段。

{
  "mcpServers": {
    "jira": {
      "command": "/path/to/jira-mcp",
      "args": []
    }
  }
}

参数说明:

'server name': 'jira' (服务器名称，可以自定义)
'command': '/path/to/jira-mcp' (jira-mcp 可执行文件的本地路径，请替换为实际路径)
'args': 启动参数，这里为空，环境变量需要预先在运行环境中设置。

注意: 使用本地二进制文件时，请确保在运行 Jira MCP 服务器的环境中设置了 'ATLASSIAN_HOST', 'ATLASSIAN_EMAIL', 'ATLASSIAN_TOKEN' 环境变量。

基本使用方法

配置完成后，您可以在 MCP 客户端（如 Cursor）中使用 '@jira' 前缀加上工具名称和参数来调用 Jira MCP 提供的功能。

例如，获取 Jira issue 信息:

@jira https://your_jira_instance.atlassian.net/browse/PROJ-123 get issue

或在 Cursor 中直接提问：

@jira get issue issue_key=PROJ-123

其他工具的使用方法可以参考工具的描述，例如搜索 issue:

@jira search issue jql="project = PROJ AND status = \"In Progress\""

请参考仓库 README 或工具的描述了解更多工具的使用方法和参数。

关键词