使用说明

项目简介

Jira MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在弥合大型语言模型 (LLM) 与 Atlassian Jira 之间的鸿沟。它允许 LLM 通过标准化的工具集安全、高效地访问 Jira 平台的数据和功能，从而实现更智能的工作流程自动化和知识检索。

主要功能点

JQL 搜索: 支持使用 Jira Query Language (JQL) 进行 issue 搜索，并提供分页功能以处理大量结果。
Issue 详情: 允许 LLM 根据 Issue ID 或 Key 获取 issue 的完整详细信息，包括字段、扩展信息和属性。

安装步骤

克隆仓库:

git clone https://github.com/MCP-Mirror/CamdenClark_jira-mcp
cd jira-mcp

安装依赖: 确保已安装 Node.js 和 npm，然后运行：
```
npm install
```

配置环境变量: 复制仓库根目录下的 '.env.example' 文件并重命名为 '.env'，然后根据你的 Jira 实例信息修改以下变量：

JIRA_INSTANCE_URL=https://your-instance.atlassian.net  # 你的 Jira 实例 URL，例如 https://your-domain.atlassian.net
[email protected]           # 用于 API 访问的 Jira 用户邮箱地址
JIRA_API_KEY=your-api-token                     # Jira API Token，需要在 Jira 后台生成

获取 Jira API Token 的步骤:

登录你的 Atlassian 账户 (https://id.atlassian.com)。
导航到安全设置。
在 API tokens 下，选择 "创建 API token"。
输入 Token 的名称 (例如 "MCP Server")。
点击 "创建" 并复制生成的 Token (请妥善保管，关闭对话框后将无法再次查看)。

服务器配置

要将 Jira MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的配置示例：

配置信息 (JSON 格式):

{
  "mcpServers": {
    "jira": {  // 服务器名称，可以自定义
      "command": "npx",  // 启动服务器的命令，这里使用 npx 执行本地安装的 jira-mcp 包
      "args": ["jira-mcp"], // 命令参数，这里指定执行 jira-mcp
      "env": {  // 环境变量配置，客户端会将这些变量传递给服务器进程
        "JIRA_INSTANCE_URL": "https://your-instance.atlassian.net",  // [请替换为你的 Jira 实例 URL]
        "JIRA_USER_EMAIL": "[email protected]",            // [请替换为你的 Jira 用户邮箱地址]
        "JIRA_API_KEY": "your-api-token"                      // [请替换为你的 Jira API Token]
      }
    }
  }
}

配置路径:

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'

注意:

请根据你的实际 Jira 实例信息替换 'JIRA_INSTANCE_URL', 'JIRA_USER_EMAIL', 和 'JIRA_API_KEY' 的占位符。
服务器名称 "jira" 可以自定义，客户端会使用此名称来引用该服务器。

基本使用方法

确保已完成安装步骤和服务器配置。
启动 MCP 客户端 (例如 Claude Desktop)，客户端会自动连接到 Jira MCP Server。
在 MCP 客户端中，你可以使用以下工具与 Jira 进行交互：
- 'jql_search': 执行 JQL 查询以搜索 Jira issues。你需要提供 JQL 查询语句作为参数。
- 'get_issue': 获取指定 Issue ID 或 Key 的详细信息。你需要提供 Issue ID 或 Key 作为参数。
具体工具的使用方法和参数说明请参考仓库的 README.md 文件或工具的输入 Schema 定义。LLM 将根据工具的描述和参数信息来调用这些工具，并利用 Jira MCP Server 返回的数据进行后续处理。

关键词