项目简介
Jira AI 助手集成服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务。它旨在通过标准化的协议,将 Jira 的强大功能暴露给各种 AI 助手和 LLM 客户端。这意味着您可以通过简单的自然语言指令,让 AI 助手帮助您查询、创建、更新 Jira 任务,管理评论,甚至进行工作流转换。
主要功能点
- 全面 Jira 交互: 提供 11 种预设工具,涵盖 Jira 任务的详细信息获取、高级搜索(支持 JQL)、创建新任务、更新现有任务、添加或获取评论、执行工作流转换、获取项目信息以及查询项目可用的任务类型和分配给您的任务等。
- 自然语言操作: AI 助手可以直接通过对话与 Jira 进行交互,极大简化了任务管理流程。
- 实时更新: 确保 AI 助手获取并提供最新的 Jira 项目和任务状态信息。
- 安全认证: 采用 Jira API 令牌进行认证,保障数据交互的安全性。
安装步骤
-
克隆仓库: 首先,将项目仓库克隆到您的本地机器。
git clone https://github.com/sthirugn/jira-mcp-server.git cd jira-mcp-server -
安装依赖: 使用 'pip' 安装项目所需的 Python 依赖。
pip install -r requirements.txt -
配置 Jira 凭据: 在项目根目录下创建一个名为 '.env' 的文件,并填入您的 Jira 服务器地址、邮箱和 API 令牌。
JIRA_SERVER=https://your-company.atlassian.net [email protected] JIRA_API_TOKEN=your-api-token获取您的 Jira API 令牌: 访问 https://id.atlassian.com/manage-profile/security/api-tokens,点击“创建 API 令牌”,然后将其复制到 '.env' 文件中。
-
测试连接: 运行测试脚本以验证您的 Jira 连接和凭据是否正确。
python3 test_connection.py如果显示“✅ Successfully connected to Jira!”,则表示连接成功。
服务器配置(MCP 客户端)
MCP 服务器是为 MCP 客户端提供服务的。您需要在您的 MCP 客户端(如 Cursor、VS Code 的 MCP 插件等)中添加配置信息,以便客户端能够发现并连接到 Jira MCP 服务器。
以下是配置示例,您需要将其添加到客户端的 MCP 配置文件中(例如 Cursor 的 '~/.cursor/mcp.json' 或 VS Code 的 MCP 配置):
{ "mcpServers": { "jira": { "type": "stdio", "command": "python3", "args": ["/full/path/to/jira-mcp-server/server.py"], "env": { "JIRA_SERVER": "https://your-company.atlassian.net", "JIRA_EMAIL": "[email protected]", "JIRA_API_TOKEN": "your-api-token" } } } }
配置说明:
- '"jira"': 这是您为这个 MCP 服务器实例定义的唯一名称,客户端将用它来引用此服务器。
- '"type": "stdio"': 指定服务器与客户端通过标准输入/输出流进行通信。
- '"command": "python3"': 指定用于启动服务器的 Python 解释器。如果使用了虚拟环境,请提供虚拟环境中的 Python 解释器完整路径(例如:'"/path/to/venv/bin/python3"')。
- '"args": ["/full/path/to/jira-mcp-server/server.py"]': 指定 MCP 服务器主脚本 'server.py' 的绝对路径。请务必将其替换为您的实际路径。
- '"env"': 这是一个包含环境变量的对象,用于向服务器传递 Jira 认证信息。请确保这里的 'JIRA_SERVER'、'JIRA_EMAIL' 和 'JIRA_API_TOKEN' 与您 '.env' 文件中的内容一致,或者直接将 '.env' 文件中的配置复制到这里。
基本使用方法
-
重启 MCP 客户端: 在配置完成后,请完全重启您的 MCP 客户端,以便其加载新的服务器配置。
-
向 AI 助手提问: 现在,您可以在 AI 助手中使用自然语言与 Jira 进行交互了。尝试以下命令:
- “显示项目 'XYZ' 中所有未解决的问题。”
- “创建一个新任务,标题为‘修复登录错误’,描述为‘用户无法登录系统。’,优先级为‘高’。”
- “搜索分配给我的高优先级错误。”
- “将 'PROJ-12345' 任务的状态设置为‘进行中’。”
- “为 'PROJ-6789' 任务添加评论:‘测试已完成,准备部署。’。”
- “获取任务 'PROJ-98765' 的详细信息。”
享受 AI 助手与 Jira 之间的无缝集成,更高效地管理您的工作!
信息
分类
开发者工具