项目简介

Jira MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在通过标准化的 MCP 接口,为大型语言模型 (LLM) 客户端提供与 Atlassian Jira 集成的能力。它将 Jira 的常见操作(如获取问题详情、创建新问题、通过 JQL 搜索问题)封装为可由 LLM 调用的工具。

主要功能点

  • 获取问题详情 (Get Issue): 根据问题 Key (例如 'PROJ-123') 获取指定 Jira 问题的详细信息。
  • 创建新问题 (Create Issue): 在指定的 Jira 项目中创建新的问题,包括设置标题、描述、问题类型和父问题等信息。
  • 搜索问题 (Search Issue): 使用 Jira 查询语言 (JQL) 搜索符合条件的问题列表。

安装步骤

  1. 克隆仓库到本地:
    git clone https://github.com/koga1020/jira-mcp.git
    cd jira-mcp
  2. 下载依赖并构建项目:
    go mod tidy
    go build
    这将生成一个名为 'jira-mcp' (或 'jira-mcp.exe' 在 Windows 上) 的可执行文件。

服务器配置

该 MCP 服务器通过标准输入/输出 (Stdio) 协议进行通信。您的 MCP 客户端(例如支持 MCP 的 VS Code 扩展)需要配置如何启动和连接到此服务器。

以下是一个典型的 MCP 客户端配置示例,您需要根据实际情况调整:

"mcp": {
    "inputs": [
        {
            "type": "promptString",
            "id": "jira_user_name",
            "description": "您的 Jira 用户邮箱地址",
            "password": false
        },
        {
            "type": "promptString",
            "id": "jira_api_token",
            "description": "您的 Jira API Token (请在 Jira 账号设置中生成)",
            "password": true
        },
        {
            "type": "promptString",
            "id": "jira_url",
            "description": "您的 Jira 实例 URL (例如 https://your-domain.atlassian.net)",
            "password": false
        }
    ],
    "servers": {
        "jira-mcp-server": {
            "type": "stdio",
            "command": "/path/to/your/jira-mcp", // 请替换为您构建的可执行文件的完整路径
            "args": [], // 启动参数列表 (通常留空)
            "env": {
                "JIRA_USERNAME": "${input:jira_user_name}", // 通过客户端输入获取 Jira 用户名并设置为环境变量
                "JIRA_API_TOKEN": "${input:jira_api_token}", // 通过客户端输入获取 Jira API Token 并设置为环境变量
                "JIRA_URL": "${input:jira_url}" // 通过客户端输入获取 Jira URL 并设置为环境变量
            }
        }
    }
}

重要提示:

  • 请将 '"command"' 的值替换为您在安装步骤中构建的 'jira-mcp' 可执行文件的实际路径。
  • Jira 的用户名、API Token 和 URL 需要通过环境变量传递给服务器。上面的配置示例展示了如何利用 MCP 客户端的输入功能来获取这些敏感信息,并将其设置为服务器进程的环境变量 ('JIRA_USERNAME', 'JIRA_API_TOKEN', 'JIRA_URL')。请确保您的客户端支持这种输入和环境变量传递机制。

基本使用方法

一旦在您的 MCP 客户端中正确配置了 Jira MCP Server,LLM 客户端就可以发现并调用此服务器提供的 Jira 工具。您可以通过与 LLM 交互,指示它执行 Jira 相关的任务,例如:

  • "请帮我查询问题 PROJ-123 的详细信息。" (LLM 可能会调用 'get_issue' 工具)
  • "在项目 TECH 中创建一个标题为 '修复登录页面 Bug',描述为 '用户无法正常登录',类型为 'Bug' 的问题。" (LLM 可能会调用 'create_issue' 工具)
  • "搜索所有指派给我但状态不是已完成的问题。" (LLM 可能会调用 'search_issue' 工具,并生成相应的 JQL)

LLM 会根据您的指示构造相应的工具调用请求,发送给 Jira MCP Server,服务器执行操作后返回结果,再由 LLM 呈现给您。

信息

分类

开发者工具