使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，专门为 Jira Cloud 产品设计。它作为一个 MCP 服务器，可以与支持 MCP 协议的 LLM 客户端（如 Claude Desktop）集成，允许 LLM 通过预定义的工具安全地访问和查询 Jira Cloud 中的 issue 信息。

主要功能点

查询 Jira issue: 通过 'jira_get_issue' 工具，用户可以指定 Jira issue 的 key，从 Jira Cloud 中检索并获取 issue 的详细信息。

安装步骤

获取 Jira API Token: 访问 https://id.atlassian.com/manage-profile/security/api-tokens 创建并获取 Jira API Token。

克隆仓库: 将仓库 'https://github.com/vurtnec/mcp-jira' 克隆到本地。

git clone https://github.com/vurtnec/mcp-jira

进入项目目录: 进入克隆下来的 'mcp-jira' 目录。
```
cd mcp-jira
```
安装依赖: 使用 npm 安装项目依赖。
```
npm install
```
构建项目: 构建 TypeScript 项目为 JavaScript 代码。
```
npm run build
```

服务器配置

要将此 MCP 服务器与 MCP 客户端（例如 Claude Desktop）配合使用，您需要在客户端的配置文件中添加以下服务器配置信息。以下是一个 'claude_desktop_config.json' 的配置示例，您需要根据实际情况修改 'command' 和 'args' 字段中的路径、Jira URL、用户名和 API Token。

{
  "mcpServers": {
    "jira": {
    "command": "npx",
    "args": [
        "-y",
        "/your/project/path/mcp-jira",
        "--jira-url",
        "https://your-domain.atlassian.net",
        "--jira-username",
        "[email protected]",
        "--jira-api-token",
        "your_api_token"
    ]
    }
  }
}

配置参数说明:

'command': 运行 MCP 服务器的命令。这里使用 'npx' 来执行项目目录下的 'mcp-jira' 包。
'args': 传递给 MCP 服务器的命令行参数，用于配置 Jira 连接信息。
- '-y': 是 'npx' 的参数，用于自动确认安装包执行。
- '/your/project/path/mcp-jira': 请务必替换为实际的项目路径。这是您克隆 'mcp-jira' 仓库后，在本地文件系统中的绝对或相对路径。
- '--jira-url': 您的 Jira Cloud 实例的 URL，例如 'https://your-domain.atlassian.net'。请替换为您自己的 Jira Cloud 实例 URL。
- '--jira-username': 您的 Jira 用户名，通常是您的邮箱地址。请替换为您自己的 Jira 用户名。
- '--jira-api-token': 您在 Jira 中生成的 API Token。请替换为您自己的 Jira API Token。

请注意: '/your/project/path/mcp-jira' 需要根据您将项目克隆到本地的具体路径进行调整。

基本使用方法

确保已完成上述安装和配置步骤。
启动 MCP 服务器。在 'mcp-jira' 项目目录下，运行以下命令启动服务器：
```
npm start
```
服务器成功启动后，会在控制台输出 "Secure MCP Jira Server running on stdio"。
在支持 MCP 协议的 LLM 客户端（如 Claude Desktop）中，配置并启用名为 "jira" 的 MCP 服务器。客户端会通过 stdio 与 MCP 服务器建立连接。
在 LLM 客户端中，您可以使用 'jira_get_issue' 工具，并提供 'issue_key' (Jira issue 键，例如 'PROJ-123') 作为参数来查询 Jira issue 的详细信息。

例如，在 Claude 中，您可以指示 Claude 使用 'jira_get_issue' 工具来查询特定的 Jira issue。

关键词