项目简介
Jira MCP 是一个实现了 Model Context Protocol (MCP) 的服务器端应用,专门用于连接和操作 Atlassian Jira 平台。它允许 MCP 客户端(如支持 MCP 的 AI 助手)通过结构化的方式访问 Jira 数据并执行各种操作,从而将 Jira 的能力集成到 AI 工作流中。
主要功能点
- 获取详细问题信息: 根据问题 Key 获取完整的 Jira 问题详情,包括状态、经办人、描述、子任务和可用的工作流转换。
- 创建、更新和搜索问题: 支持创建新的 Jira 问题或子任务,更新现有问题的摘要和描述,以及使用 JQL (Jira Query Language) 搜索符合条件的问题。
- 列出问题类型和状态: 获取特定项目或所有可用的问题类型及其属性,以及特定项目的状态列表。
- 添加和获取评论: 在 Jira 问题下添加新的评论,或检索一个问题的所有评论。
- 添加工作日志: 记录在 Jira 问题上花费的时间。
- 列出和获取 Sprint: 获取特定看板的活跃和未来的 Sprint 列表,或获取特定 Sprint 的详细信息。
- 检索问题历史: 查看 Jira 问题的完整变更记录。
- 关联问题: 查看与给定问题有链接关系的其他问题,并支持创建新的问题链接。
- 转换问题状态: 根据可用的工作流转换 ID 改变 Jira 问题状态。
安装步骤
该项目提供了多种安装方式,你可以根据自己的环境选择最方便的一种:
- 下载预编译二进制文件: 从项目的 GitHub Releases 页面下载适用于你操作系统的可执行文件。
- 使用 Go 安装命令: 如果你已经安装 Go 环境,可以使用 'go install github.com/humblecrite/jira-mcp@latest' 命令直接安装到你的 GOPATH。
- 使用 Docker: 可以拉取预构建的 Docker 镜像 ('ghcr.io/nguyenvanduocit/jira-mcp:latest'),或者在本地构建 Docker 镜像。
服务器配置
Jira MCP 服务器需要连接到你的 Atlassian Jira 实例。这通常通过设置环境变量来实现。对于 MCP 客户端(如 Cursor)来说,你需要配置它如何启动和连接到 Jira MCP 服务器。
以下是 MCP 客户端配置中可能需要的信息(具体配置方式取决于你的 MCP 客户端):
- 服务器名称: 为这个 Jira 连接器起一个名称,例如 '"jira"'。
- 启动命令 (command): 指定如何启动 Jira MCP 可执行文件。这可以是二进制文件的路径(例如:'"/usr/local/bin/jira-mcp"')或 'docker' 命令(例如:'"docker"')。
- 启动参数 (args): 提供启动命令所需的参数。
- 使用 Docker 时: 通常会包含运行 Docker 镜像的参数,例如 '["run", "--rm", "-i", "-e", "ATLASSIAN_HOST=your_jira_instance.atlassian.net", "-e", "[email protected]", "-e", "ATLASSIAN_TOKEN=your_atlassian_api_token", "ghcr.io/nguyenvanduocit/jira-mcp:latest"]'。你需要将 'your_jira_instance.atlassian.net', '[email protected]', 'your_atlassian_api_token' 替换为你自己的 Jira 实例地址、邮箱和 API Token。'--rm' 表示容器停止后自动移除,'-i' 保持标准输入打开以便 MCP 客户端通过 Stdio 通信,'-e' 用于设置环境变量。
- 使用本地二进制文件时: 可以直接指定二进制文件路径,并通过环境变量或 '.env' 文件传递凭据。例如:'["/path/to/jira-mcp", "-env", "/path/to/.env"]'。你需要将 '/path/to/jira-mcp' 替换为实际的文件路径,'/path/to/.env' 替换为包含 'ATLASSIAN_HOST', 'ATLASSIAN_EMAIL', 'ATLASSIAN_TOKEN' 的 '.env' 文件路径。或者,你也可以不使用 '-env' 参数,而是直接在启动这个 MCP 服务器的 shell 环境中设置这些环境变量。
- 能力声明: MCP 客户端通常会根据服务器声明的能力(Tooling, Resources, Prompts)来决定如何与服务器交互。Jira MCP 声明支持 Tooling 和 Resource Capabilities。
确保 'ATLASSIAN_HOST', 'ATLASSIAN_EMAIL', 'ATLASSIAN_TOKEN' 这三个必需的环境变量在 MCP 服务器启动时被正确设置。
基本使用方法
在支持 MCP 的 AI 客户端(如 Cursor)中完成 Jira MCP 服务器的配置后,你就可以直接在与 AI 交互时通过指定 MCP 服务器名称或其关联的 URL 来调用其提供的功能。
例如,在 Cursor 中,如果你将服务器命名为 'jira',并且配置了与 Jira 实例 'your_jira_instance.atlassian.net' 的连接,你可以尝试以下方式与 AI 交互:
- 请求获取特定 Jira 问题的信息:
或者如果客户端支持 URL 资源解析:请使用jira连接器获取PROJ-123问题的详细信息。@https://your_jira_instance.atlassian.net/browse/PROJ-123 get issue details - 请求创建一个新的 Jira 问题:
AI 可能会通过调用 'create_issue' 工具来完成操作。使用jira连接器在项目'MYPROJECT'中创建一个类型为Task的问题,标题是'修复登录bug',描述是'用户反馈登录功能异常,需要排查并修复。'
具体的交互方式和提示词需要根据你使用的 MCP 客户端的 UI 和 AI 模型的能力来调整。AI 模型会根据你的请求和 MCP 服务器暴露的工具描述来决定调用哪个工具,并组织参数。
信息
分类
开发者工具