使用说明

项目简介

JIRA MCP Server 是一个基于 Model Context Protocol (MCP) 实现的服务器,旨在将 Atlassian JIRA 的强大功能集成到 Cursor IDE 等 MCP 客户端中。通过此服务器,用户可以直接在 Cursor IDE 中访问和操作 JIRA issue,提高开发效率。

主要功能点

  • 直接在 Cursor IDE 中访问 JIRA: 无需离开 Cursor IDE 即可查看和管理 JIRA issue。
  • 查看指派给我的 Issue: 快速查看当前指派给您的所有 JIRA issue 列表。
  • 获取 Issue 详细信息: 一键获取指定 JIRA issue 的详细信息,包括摘要、描述、状态、优先级等。
  • 从 JIRA Issue 创建本地任务: 将 JIRA issue 无缝转换为本地任务,方便在 IDE 中进行任务管理。

安装步骤

  1. 克隆仓库
    git clone https://github.com/Dsazz/mcp-jira.git
    cd mcp-jira
  2. 安装依赖
    bun install
  3. 配置环境变量 复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入您的 JIRA 凭据:
    JIRA_HOST=https://your-instance.atlassian.net
    [email protected]
    JIRA_API_TOKEN=your-jira-api-token-here
    请确保 JIRA API Token 填写正确,不要添加引号。

服务器配置

要将 JIRA MCP Server 集成到 MCP 客户端(如 Cursor IDE),您需要配置服务器启动命令。以下是 Cursor IDE 或其他 MCP 客户端所需的服务器配置信息(JSON 格式):

{
  "mcpServers": {
    "JIRA Tools": {
      "command": "node",
      "args": ["/absolute/path/to/your/project/dist/index.js"]
      // 请将 "/absolute/path/to/your/project/dist/index.js" 替换为项目 dist 目录下 index.js 文件的绝对路径
      // 例如: "/Users/yourname/mcp-jira/dist/index.js"
      ,
      "env": {
        "JIRA_USERNAME": "your-jira-username", // 您的 JIRA 用户名 (邮箱)
        "JIRA_API_TOKEN": "your-jira-api-token", // 您的 JIRA API Token
        "JIRA_HOST": "your-jira-host.atlassian.net" // 您的 JIRA Host 地址,例如: "your-instance.atlassian.net"
      }
    }
  }
}

配置说明:

  • '"server name": "JIRA Tools"': 服务器名称,您可以自定义。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行时。如果使用 Bun 运行时,可以替换为 '"bun"'。
  • '"args": [...]': 传递给启动命令的参数,这里指定了服务器入口文件 'dist/index.js' 的绝对路径
  • '"env": {...}': 环境变量配置,包含了连接 JIRA 服务器所需的凭据,请根据您的 JIRA 实例信息进行填写。

基本使用方法

  1. 启动 MCP 服务器: 在项目根目录下,运行以下命令启动服务器:
    bun run build  # 构建项目 (首次运行或代码更新后需要构建)
    bun start      # 启动生产模式服务器
    或者使用开发模式(支持热重载):
    bun dev
  2. 在 MCP 客户端中使用: 将上面提供的服务器配置信息添加到您的 MCP 客户端配置中。配置完成后,您就可以在客户端中使用 'jira_get_assigned_issues', 'jira_get_issue', 'jira_create_task' 等工具与 JIRA 进行交互了。例如,在 Cursor IDE 中,您可以直接在聊天框中输入指令,例如 'Show me my assigned JIRA issues.' 或 'Get issue PD-312 details.' 来调用相应的 JIRA 工具。

信息

分类

开发者工具