使用说明

项目简介

本项目 'mcp-server-jira' 是一个 Model Context Protocol (MCP) 服务器,旨在为大型语言模型 (LLM) 提供与 JIRA 系统交互的能力。通过集成 JIRA API,该服务器目前提供了一个工具 'get_issue',允许 LLM 客户端查询并获取指定 JIRA issue 的详细信息。这使得 LLM 应用能够利用 JIRA 中的项目管理和问题跟踪数据,扩展其应用场景。

主要功能点

  • 获取JIRA Issue信息 (get_issue): 通过 issue key 查询 JIRA,返回 issue 的详细 JSON 数据。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/kuvanov-2/mcp-server-jira.git
    cd mcp-server-jira
  2. 安装依赖: 确保已安装 Node.js 和 npm。
    npm install
  3. 构建项目:
    npm run build

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude IDE),您需要配置 MCP 服务器的启动命令和必要的环境变量。以下是一个 'cline_mcp_settings.json' 示例配置,展示了如何配置 'mcp-server-jira':

{
  "mcpServers": {
    "github.com/kuvanov-2/mcp-server-jira": {
      "command": "/path/to/mcp-server-jira/start-server.sh",
      "env": {
        "JIRA_HOST": "https://your-domain.atlassian.net",
        "JIRA_EMAIL": "[email protected]",
        "JIRA_API_TOKEN": "op://YOUR_VAULT_NAME/YOUR_ITEM_NAME/info/access token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

配置参数说明:

  • '"github.com/kuvanov-2/mcp-server-jira"': 服务器名称,用于在 MCP 客户端中唯一标识该服务器。

  • '"command"': 启动服务器的命令。请将 '/path/to/mcp-server-jira/start-server.sh' 替换为 'start-server.sh' 脚本在您系统中的绝对路径

  • '"env"': 环境变量配置,用于服务器运行时访问 JIRA。

    • '"JIRA_HOST"': 您的 JIRA 域名,例如 'https://your-domain.atlassian.net'。请替换为您的实际 JIRA 域名。
    • '"JIRA_EMAIL"': JIRA 账户邮箱地址。请替换为您的 JIRA 账户邮箱。
    • '"JIRA_API_TOKEN"': JIRA API Token。 此处配置为从 '1Password' 获取 API Token 的路径 'op://YOUR_VAULT_NAME/YOUR_ITEM_NAME/info/access token'。 您需要:
      • 提前配置 1Password CLI 工具 并确保 MCP 服务器可以访问。
      • 在 JIRA 中生成 API Token,并 将其安全地存储在 1Password 中
      • 将 'YOUR_VAULT_NAME' 和 'YOUR_ITEM_NAME' 替换为 1Password 中存储 API Token 的 Vault 名称和 Item 名称
  • '"disabled": false': 设置为 'false' 表示启用该服务器。

  • '"autoApprove": []': 自动批准的工具列表,当前为空。

重要提示:

  • 请根据您的实际环境修改 '/path/to/mcp-server-jira/start-server.sh' 的路径。
  • 请务必 安全地管理 JIRA API Token,推荐使用 1Password 等密码管理工具进行存储和访问。
  • MCP 客户端的具体配置文件路径可能因客户端软件版本而异,请参考您使用的 MCP 客户端的官方文档来查找正确的配置文件路径。 本示例中提供的路径 '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json' 和 '%APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json' 是 Claude IDE 客户端的配置示例路径, 仅供参考。

基本使用方法

配置完成后,在支持 MCP 协议的 LLM 客户端中,您可以使用 '<use_mcp_tool>' 标签来调用 'get_issue' 工具,例如:

<use_mcp_tool>
<server_name>github.com/kuvanov-2/mcp-server-jira</server_name>
<tool_name>get_issue</tool_name>
<arguments>
{
  "issueKey": "PROJ-123"
}
</arguments>
</use_mcp_tool>

将 'PROJ-123' 替换为您想要查询的 JIRA issue key。 LLM 客户端会将请求发送到 'mcp-server-jira' 服务器,服务器会调用 JIRA API 获取 issue 信息,并将结果返回给 LLM 客户端。

信息

分类

开发者工具