使用说明

项目简介

Jira MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它充当 LLM 客户端(如 Claude Desktop)和 Jira 之间的桥梁。通过此服务器,用户可以使用自然语言命令,让 LLM 客户端调用 Jira 的各项功能,例如查询项目、创建工单、添加评论等,从而提升工作效率。

主要功能点

  • 项目信息获取: 获取用户在 Jira 中可访问的所有项目列表。
  • 工单详情查询: 根据工单 Key (例如: PROJECT-123) 获取指定 Jira 工单的详细信息,包括摘要、描述、状态、指派人、报告人、创建/更新时间、字段信息和评论。
  • JQL 工单搜索: 使用 Jira Query Language (JQL) 灵活搜索 Jira 工单,支持自定义查询条件。
  • 工单创建: 在指定的 Jira 项目中创建新的工单,支持设置工单概要、描述、类型以及其他自定义字段。
  • 工单评论: 为指定的 Jira 工单添加评论。
  • 工单状态转换: 获取指定 Jira 工单可用的状态转换选项,并将工单状态变更为新的状态。
  • 项目可用工单类型查询: 获取指定 Jira 项目下可用的工单类型列表。
  • 项目创建: 创建新的 Jira 项目。

安装步骤

  1. 环境准备:

    • 确保已安装 Python 3.9 或更高版本。
    • 确保可以访问您的 Jira 实例 (Cloud, Server, 或 Data Center)。
    • 强烈建议安装 'uv' (一个更快的 Python 包安装工具,可选): 'pip install uv'
  2. 创建并激活虚拟环境 (推荐):

    python -m venv .
    source bin/activate  # 或根据您的系统使用不同的激活命令
  3. 安装 Jira MCP Server:

    • 使用 'uv' (推荐):
      uv pip install mcp-server-jira
    • 或使用 'pip':
      pip install mcp-server-jira

服务器配置

为了使 MCP 客户端(例如 Claude Desktop)能够连接到 Jira MCP Server,您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的配置示例,其他 MCP 客户端的配置方式类似。

在 Claude Desktop 的设置中,找到 "Developer" -> "Edit Config",打开 JSON 配置文件,在 'mcpServers' 字段下添加如下 JSON 配置:

{
  "mcpServers": {
    "jira": {  // 服务器名称,可以自定义
      "command": "<Python 解释器路径>", // Python 解释器路径,例如:/usr/bin/python3 或 虚拟环境中的 Python 路径
      "args": [
          "-m",
          "mcp_server_jira" // 运行 Jira MCP Server 的命令
      ],
      "env": {  // 环境变量配置,用于连接 Jira
          "JIRA_SERVER_URL": "https://<您的Jira域名>.atlassian.net/", // 您的 Jira 服务器 URL,例如:https://your-domain.atlassian.net 或 https://jira.example.com
          "JIRA_AUTH_METHOD": "token_auth", // 身份验证方法,可选 'basic_auth' 或 'token_auth'
          "JIRA_USERNAME": "<您的Jira用户名/邮箱>", // 您的 Jira 用户名或邮箱 (用于 Basic Auth)
          "JIRA_TOKEN": "<您的Jira API Token 或 Personal Access Token>" // 您的 Jira API Token 或 Personal Access Token
      }
    }
  }
}

配置参数说明:

  • 'command': Python 解释器的完整路径。如果您的 Python 环境不在默认路径下,请替换为正确的路径。如果您使用了虚拟环境,请使用虚拟环境中的 Python 解释器路径。
  • 'args': 运行 Jira MCP Server 的参数,固定为 '["-m", "mcp_server_jira"]'。
  • 'env': 环境变量配置,用于服务器连接到您的 Jira 实例。
    • 'JIRA_SERVER_URL': 您的 Jira 服务器 URL。请根据您的 Jira 实例类型 (Cloud, Server, Data Center) 填写正确的 URL。
    • 'JIRA_AUTH_METHOD': 身份验证方法。
      • 'basic_auth': 适用于 Jira Server/Data Center,可以使用用户名和密码,或用户名和 API Token。对于 Jira Cloud,通常也使用 'basic_auth' 和 API Token。
      • 'token_auth': 适用于 Jira Server/Data Center (8.14+) 使用 Personal Access Token 的情况。
    • 'JIRA_USERNAME': 您的 Jira 用户名或邮箱,用于 'basic_auth' 身份验证。
    • 'JIRA_TOKEN': 您的 Jira API Token 或 Personal Access Token。获取方式请参考 Jira 官方文档。

选择身份验证方式并配置环境变量:

根据您的 Jira 版本和偏好,选择合适的身份验证方式,并在 'env' 中配置相应的环境变量。您可以使用 '.env' 文件在本地开发环境中管理这些环境变量。

基本使用方法

配置完成后,在 MCP 客户端中,您可以使用自然语言指令来调用 Jira 功能。例如,在 Claude Desktop 中,您可以尝试以下指令:

  • "Show me all my projects in Jira" (显示我在 Jira 中的所有项目)
  • "Get details for issue PROJECT-123" (获取工单 PROJECT-123 的详情)
  • "Create a new bug in the PROJECT with summary 'Fix login issue'" (在 PROJECT 项目中创建一个新的 Bug 工单,概要为 'Fix login issue')
  • "Find all open bugs assigned to me" (查找所有指派给我的未解决的 Bug 工单)

具体可用的指令取决于 LLM 客户端的解析能力和服务器提供的工具。请参考您的 LLM 客户端文档,了解如何与 MCP 服务器进行交互。

信息

分类

开发者工具