Jira MCP Server 使用说明

项目简介

本项目是一个基于Model Context Protocol (MCP) 的服务器,旨在为AI助手提供与Jira项目管理工具集成的能力。通过此服务器,AI助手可以方便地管理Jira issues,实现自动化工作流程。

主要功能点

  • 创建Issue: 支持创建 Jira Task、Epic 和 Subtask 等类型的 issue。
  • 列出Issue: 可以列出指定Jira项目中的 issues,并支持按状态进行过滤。
  • 更新Issue: 允许更新现有 issue 的标题、描述和状态。
  • 获取Issue详情: 获取指定 issue 的详细信息,包括评论。
  • 删除Issue: 删除指定的 Jira issue。
  • 添加评论: 为指定的 issue 添加评论。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆或下载此仓库到本地。
  3. 在仓库根目录下,打开终端并运行 'npm install' 安装依赖。
  4. 运行 'npm run build' 构建服务器。

服务器配置

  1. Jira 配置: 在你的工作目录(例如,你希望 AI 助手访问 Jira 项目的目录)下创建 '.jira-config.json' 文件,并填入你的 Jira 项目 Key。

    {
      "projectKey": "YOUR_JIRA_PROJECT_KEY" // 替换为你的 Jira 项目 Key
    }
  2. MCP 服务器配置: 编辑 MCP 客户端(例如 Claude)的配置文件 ('claude_desktop_config.json'),添加 Jira MCP 服务器的配置。

    • 在 MacOS 上,配置文件路径通常为 '~/Library/Application Support/Claude/claude_desktop_config.json'。
    • 在 Windows 上,配置文件路径通常为 '%APPDATA%/Claude/claude_desktop_config.json'。

    在 'mcpServers' 字段下添加 'jira' 服务器配置:

    {
      "mcpServers": {
        "jira": {
          "command": "node",
          "args": ["/path/to/jira-server/build/index.js"], // 替换为你的 jira-server build 目录下的 index.js 文件的绝对路径
          "env": {
            "JIRA_EMAIL": "[email protected]", // 替换为你的 Jira 邮箱地址
            "JIRA_API_TOKEN": "your-api-token",    // 替换为你的 Jira API Token
            "JIRA_DOMAIN": "your-domain"         // 替换为你的 Jira 域名 (例如,your-domain.atlassian.net 中的 your-domain)
          }
        }
      }
    }

    注意: 请替换上述配置中的占位符为你实际的值。确保 'args' 字段中的路径是 'build/index.js' 文件的绝对路径。

基本使用方法

配置完成后,在支持 MCP 协议的 AI 客户端中,即可通过工具调用 Jira 服务器提供的功能。例如,你可以指示 AI 助手 “创建一个 Jira task,标题为 ‘修复bug’,描述为 ‘用户登录bug’,项目目录为当前工作目录”。AI 助手会自动调用 'create_issue' 工具,并使用你配置的 Jira 服务器完成操作。 其他工具如 'list_issues', 'update_issue', 'get_issue', 'delete_issue', 'add_comment' 的使用方式类似,根据工具的参数要求提供相应的指令即可。

信息

分类

开发者工具