使用说明
项目简介
Jira MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 Cursor 编辑器提供与 Jira 项目管理工具集成的能力。通过此服务器,用户可以在 Cursor 中直接访问和操作 Jira 上的任务(Tickets),例如查看任务列表、查看任务详情、创建新任务、添加评论和更新任务状态,从而提升在代码编辑器中的任务管理效率。
主要功能点
- 列出 Jira 任务 (List Jira tickets): 获取并展示用户在 Jira 中被分配的任务列表。
- 查看任务详情 (Get ticket details): 查看指定 Jira 任务的详细信息,包括摘要、描述、状态等。
- 创建新任务 (Create new tickets): 在 Jira 项目中创建新的任务。
- 添加评论 (Add comments to tickets): 为 Jira 任务添加评论。
- 更新任务状态 (Update ticket status): 更新 Jira 任务的状态。
- Cursor 编辑器集成: 通过 MCP 协议与 Cursor 编辑器无缝集成,提供命令式操作体验。
安装步骤
-
安装依赖: 在项目根目录下运行以下命令安装项目依赖:
npm install -
配置环境变量:
- 复制 '.env.example' 文件并重命名为 '.env'。
- 根据 '.env' 文件中的示例,填写您的 Jira 域名、邮箱和 API Token。
- 'JIRA_HOST': 您的 Jira 域名,例如 'https://your-domain.atlassian.net'
- 'JIRA_EMAIL': 您用于 Jira 账号的邮箱地址。
- 'JIRA_API_TOKEN': 您的 Jira API Token。API Token 需要在 Atlassian 账号的 API Token 管理页面创建。
- 'PORT': 服务器监听端口,默认为 '3000'。
服务器配置
要将 Jira MCP Server 集成到 Cursor 编辑器,您需要在 Cursor 的设置中添加 MCP 配置。推荐使用 Command-based Integration (命令集成) 方式,配置信息如下:
{ "mcps": { "jira": { "command": "node", "args": ["/path/to/jira-mcp-server/dist/server.js"] } } }
配置参数说明:
- server name (服务器名称): 'jira' (此名称用于在 Cursor 中通过 '/jira' 命令前缀调用 Jira 功能)
- command (启动命令): 'node' (Node.js 运行时环境)
- args (命令参数): '["/path/to/jira-mcp-server/dist/server.js"]'
- 请将 '/path/to/jira-mcp-server' 替换为 您本地 Jira MCP Server 项目的绝对路径。 确保路径指向已构建 (build) 后的 'dist/server.js' 文件。
HTTP-based Integration (HTTP 集成) (备选方案):
如果您选择 HTTP 集成方式,配置信息如下:
{ "mcps": { "jira": { "url": "http://localhost:3000", "capabilities": [ "list_tickets", "get_ticket", "create_ticket", "update_status", "add_comment" ] } } }
基本使用方法
成功配置并启动 Jira MCP Server 后,在 Cursor 编辑器中,您可以使用以下命令来操作 Jira 任务:
- '/jira list' - 列出您的 Jira 任务。
- '/jira view TICKET-123' - 查看 'TICKET-123' 任务的详细信息 (将 'TICKET-123' 替换为实际的任务 ID)。
- '/jira create' - 创建一个新的 Jira 任务 (根据提示输入任务详情)。
- '/jira comment TICKET-123' - 为 'TICKET-123' 任务添加评论 (根据提示输入评论内容)。
- '/jira status TICKET-123' - 更新 'TICKET-123' 任务的状态 (根据提示选择新的状态)。
信息
分类
开发者工具