使用说明
项目简介
Jira MCP Integration 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 Atlassian 的 JIRA 服务集成到支持 MCP 协议的客户端应用中,例如 Claude。通过此服务器,用户可以使用自然语言指令,让 Claude 直接在 JIRA 中创建和查询工单,从而提升工作效率。
主要功能点
- 创建 JIRA 工单 (create-ticket): 允许用户通过 Claude 创建新的 JIRA 工单,支持设置工单概要、问题类型(Bug, Task, Story)和详细描述。
- 检索 JIRA 工单 (get-ticket): 允许用户通过 Claude 查询现有 JIRA 工单的详细信息,通过工单 ID 即可获取工单的概要、描述、类型、状态和优先级等字段。
安装步骤
-
克隆仓库:
git clone https://github.com/MankowskiNick/jira-mcp.git cd jira-mcp -
安装依赖:
npm install -
构建项目:
npm run build
服务器配置
要将 Jira MCP 服务器与 MCP 客户端(如 Claude)连接,您需要在客户端的配置文件中添加服务器配置信息。对于 Claude 桌面应用,您需要编辑 'claude_desktop_config.json' 文件。该文件通常位于:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%\Roaming\Claude\claude_desktop_config.json'
在 'claude_desktop_config.json' 文件的 'mcpServers' 字段中添加以下配置:
{ "mcpServers": { "jira-mcp": { "name": "jira-mcp", // MCP 服务器的名称,客户端用此名称识别和调用 "command": "node", // 启动 MCP 服务器的命令,这里使用 Node.js 运行 "args": ["/path/to/project/build/index.js"], // 启动命令的参数,指向编译后的 index.js 文件路径。请替换为实际路径 "env": { "JIRA_HOST": "your-site.atlassian.net", // 您的 JIRA 域名,例如 your-company.atlassian.net "JIRA_USERNAME": "[email protected]", // 您的 JIRA 用户名 (通常是邮箱地址) "JIRA_API_TOKEN": "your_api_token", // 您的 JIRA API 令牌 "JIRA_PROJECT_KEY": "your_project_key", // 您的 JIRA 项目 Key,例如 SCRUM, DEV 等 "USE_NON_CPP": "false" // (可选) 设置为 "true" 使用 "Non-CPP" 作为自定义字段,默认为 "false" 使用 "CPP" } } } }
请务必替换以下占位符为您实际的信息:
- '/path/to/project/build/index.js': 实际路径:指向您本地 'jira-mcp' 项目中 'build/index.js' 文件的完整路径。
- 'JIRA_HOST': 实际域名:您的 JIRA 实例域名。
- 'JIRA_USERNAME': 实际用户名:您用于访问 JIRA 的用户名(通常是邮箱地址)。
- 'JIRA_API_TOKEN': 实际API令牌:您的 JIRA API 令牌。您需要在您的 Atlassian 账户安全设置中创建 API 令牌。
- 'JIRA_PROJECT_KEY': 实际项目Key:您希望在其中创建工单的 JIRA 项目的 Key。
基本使用方法
配置完成后,您可以在 Claude 中使用自然语言指令来操作 JIRA。例如:
-
创建工单: 您可以对 Claude 说:'请创建一个 JIRA 工单,概要是“数据库性能问题”,问题类型是“Bug”,描述是“最近数据库查询速度明显下降,需要排查原因。”' Claude 将会调用 'create-ticket' 工具在您的 JIRA 项目中创建一个相应的工单。
-
查询工单: 您可以对 Claude 说:'请查询工单 ID 为 SCRUM-123 的信息。' Claude 将会调用 'get-ticket' 工具并返回工单 'SCRUM-123' 的详细信息。
注意: 首次使用前,请确保您已在 Claude 应用中授予工具使用权限。
信息
分类
开发者工具