使用说明
项目简介
Jira MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在桥接 AI 助手和 Jira 缺陷跟踪系统。通过该服务器,AI 助手可以安全、便捷地访问和操作 Jira 中的项目、任务和缺陷信息,从而实现智能化的任务管理和工作流自动化。
主要功能点
- 获取用户任务: AI 助手可以查询指派给当前用户的 Jira 任务列表。
- 添加评论: AI 助手可以向指定的 Jira 任务添加评论。
- 获取状态转换: AI 助手可以查询指定 Jira 任务可用的状态转换选项。
- 更新任务状态: AI 助手可以根据可用的状态转换更新 Jira 任务的状态。
- 创建任务: AI 助手可以创建新的 Jira 任务,支持指定标题、描述、负责人、任务类型和父任务。
安装步骤
- 环境准备: 确保已安装 Docker 或 Python 环境(推荐 Python 3.7+)。
- 获取代码: 克隆或下载 GitHub 仓库 simple-jira-mcp。
- 配置环境变量:
- 在项目根目录下创建 '.env' 文件。
- 根据你的 Jira 实例信息,填写以下环境变量:
JIRA_SERVER=https://yourcompany.atlassian.net # 你的Jira服务器地址 [email protected] # 你的Jira用户名(邮箱) JIRA_API_KEY=yourapikey # 你的Jira API Key (在Atlassian账户安全设置中生成) JIRA_PROJECT_KEY=yourprojectkey # 你的Jira项目Key - API Key 获取地址: https://id.atlassian.com/manage-profile/security/api-tokens
- 启动服务器:
- 方式一 (Docker): 执行仓库中的 'run_docker_locally.sh' 脚本 (需要先赋予执行权限 'chmod +x run_docker_locally.sh')。
- 方式二 (Python):
- 安装依赖: 在项目根目录下运行 'pip install -r requirements.txt'。
- 启动服务: 运行 'uvicorn src.server:app --reload'。
服务器配置
MCP 客户端需要配置以下信息以连接到 Jira MCP Server:
{ "server_name": "jira-mcp-server", // 自定义服务器名称,用于MCP客户端标识 "command": "uvicorn", // 启动服务器的命令 (如果使用 Docker,则无需配置 command 和 args) "args": [ // 启动服务器命令的参数 "src.server:app", // 指定 FastAPI 应用入口 "--reload" // (可选) 开启热重载,方便开发调试,生产环境建议移除 ], "port": 8000, // 服务器端口,默认为 8000,与启动命令的端口一致 "endpoint": "/mcp" // MCP 服务器的端点路径 }
注意: 如果使用 Docker 方式启动,MCP 客户端通常只需要配置 'server_name'、'port' 和 'endpoint' (如果端口和端点与默认值不同)。 'command' 和 'args' 在 Docker 容器内部执行,客户端无需关心。
基本使用方法
MCP 客户端配置完成后,即可通过 JSON-RPC 协议与 Jira MCP Server 通信。客户端可以调用服务器提供的 Tool,例如:
- 调用 'get_user_tickets' 工具获取当前用户的 Jira 任务列表。
- 调用 'comment_on_ticket' 工具为指定 Jira 任务添加评论,需要提供 'ticket_key' 和 'comment' 参数。
- 调用 'update_ticket_status' 工具更新 Jira 任务状态,需要提供 'ticket_key' 和 'status' 参数。
- ... 等等。
具体 Tool 的调用方式和参数,请参考 MCP 客户端的文档和 Jira MCP Server 的功能描述。
信息
分类
开发者工具