使用说明

项目简介

Jira MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为 LLM 应用(如 Cursor 编辑器)提供 Jira 工单信息的上下文访问能力。通过此服务器,LLM 可以调用预设的工具来查询和获取 Jira 上的工单数据,从而实现更智能化的 Jira 集成应用。

主要功能点

  • 查询我的工单: 获取当前 Jira 用户分配的所有工单列表。
  • 查询工单详情: 根据工单 Key 获取指定工单的详细信息,包括摘要、状态、优先级、负责人、报告人、创建和更新时间、描述等。

安装步骤

  1. 环境准备:

    • 确保已安装 Python 3.11 或更高版本。
    • 推荐使用虚拟环境来隔离项目依赖。
    • 确保拥有可用的 Jira 账号和密码。
  2. 配置环境变量:

    • 在项目根目录下创建 '.env' 文件,并填入 Jira 连接信息:
      JIRA_HOST=你的Jira域名 (例如: jiradc2.ext.net.nokia.com)
      JIRA_USERNAME=你的Jira用户名
      JIRA_PASSWORD=你的Jira密码
    • 请将 '你的Jira域名'、'你的Jira用户名' 和 '你的Jira密码' 替换为实际的 Jira 信息。
  3. 安装依赖:

    • 打开终端,进入项目根目录,创建并激活虚拟环境(可选):
      python -m venv jira_analyzer
      source jira_analyzer/bin/activate  # 或根据你的系统使用不同的激活命令
    • 安装项目依赖:
      pip install -r requirements.txt
  4. 运行服务器:

    • 在终端中执行 'mcp_with_venv.sh' 脚本来启动 MCP 服务器:
      ./mcp_with_venv.sh
    • 或者,如果想直接运行 Python 脚本,可以使用以下命令:
      python simple_jira_tools.py
    • 服务器默认使用 stdio 传输协议。

服务器配置 (cursor-mcp-config.json)

为了让 MCP 客户端(例如 Cursor)连接到 Jira MCP Server,需要配置客户端的 'cursor-mcp-config.json' 文件。以下是一个示例配置,可以直接添加到 Cursor 的 MCP 配置中:

{
  "servers": [
    {
      "name": "jira",  // 服务名称,在Cursor中引用此名称
      "command": "jira-mcp", // 启动服务器的命令,对应 setup.py 中配置的 entry_points
      "args": [], // 启动命令的参数,本例中无需参数
      "languages": [], // 可选,指定支持的语言
      "rootPath": "." // 可选,服务器的工作目录
    }
  ]
}

配置参数说明:

  • 'name': MCP 服务器的名称,客户端通过此名称来识别和调用服务。例如,在 Cursor 中配置后,可以使用 '@jira' 来触发与此服务器相关的操作。
  • 'command': 启动 MCP 服务器的可执行命令。这里 'jira-mcp' 是在 'setup.py' 中配置的控制台脚本入口点,安装后可以直接在命令行中使用。
  • 'args': 传递给启动命令的参数列表。在本例中,'jira-mcp' 命令本身不需要额外的命令行参数,因此设置为空列表 '[]'。
  • 'languages': 可选字段,用于指定此 MCP 服务器适用的编程语言。如果留空,则表示适用于所有语言。
  • 'rootPath': 可选字段,指定服务器的工作目录。'.' 表示当前目录。

请注意:

  • 确保 'cursor-mcp-config.json' 文件放置在 Cursor 能够识别的路径下(例如 macOS: '~/.cursor/mcp-config/cursor-mcp-config.json')。
  • 修改配置文件后,需要重启 Cursor 使配置生效。

基本使用方法

  1. 启动 Jira MCP Server:按照上述步骤启动服务器。
  2. 配置 Cursor 客户端:将提供的 'cursor-mcp-config.json' 配置添加到 Cursor 中并重启。
  3. 在 Cursor 中使用:在 Cursor 编辑器中,你可以通过自然语言指令或特定的触发词(取决于 Cursor 的具体实现)来调用 Jira MCP Server 提供的工具。例如,你可以提问:
    • "What are my assigned tickets in Jira?" (查询我的工单)
    • "Can you get details for ticket NCSFM-21544?" (查询工单 NCSFM-21544 的详情)

Cursor 会将这些请求转换为 MCP 协议的消息发送给 Jira MCP Server,服务器处理请求后返回结果,Cursor 将结果展示给你。

信息

分类

开发者工具