Jira MCP Server 使用说明

项目简介

Jira MCP Server 是一个实现了 Model Context Protocol (MCP) 的后端服务器，它允许LLM（大型语言模型）客户端通过标准化的MCP协议访问和操作Jira数据。该服务器充当LLM与Jira之间的桥梁，使LLM能够利用Jira中的信息作为上下文，或者通过调用工具来执行Jira操作。

主要功能点

Jira 数据访问: 支持使用 JQL (Jira Query Language) 搜索 Jira 问题，并返回结构化的 issue 数据，包括 issue 的关键信息、评论、以及 issue 之间的关系（如提及、链接、父子关系、Epic 关联等）。
优化的数据payload: 为 AI 上下文窗口优化了数据负载，清理和转换了 Jira 的富文本内容，提取了 Atlassian 文档格式的文本，移除了不必要的元数据，提高了 AI 处理上下文的效率。
Issue 关系追踪: 能够追踪 issue 之间的多种关系，包括提及 (mentions)、链接 (links)、父/子 issue 关系以及 Epic 关联。
文件附件处理: 支持文件附件上传，并使用安全的多部分上传处理方式。
Jira Issue 管理: 支持创建、更新和管理 Jira issue，包括 issue 的状态转换。
MCP 工具: 提供了一系列预定义的 MCP 工具，允许 LLM 客户端调用这些工具来与 Jira 进行交互（例如，搜索 issue、获取 Epic 的子 issue、获取 issue 详情、创建 issue、更新 issue、添加附件、获取 issue 状态转换、执行 issue 状态转换）。

安装步骤

克隆仓库:

git clone https://github.com/cosmix/jira-mcp.git
cd jira-mcp

安装依赖并构建: 确保你已经安装了 Bun (v1.0.0 或更高版本)。
```
bun install
bun run build
```

服务器配置

要将 Jira MCP Server 配置为 MCP 客户端 (例如 Cline 或 Claude Desktop) 的服务器，你需要编辑 MCP 客户端的配置文件。根据你的操作系统和客户端类型，配置文件路径可能如下所示：

macOS:

Cline: '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'
Claude Desktop: '~/Library/Application Support/Claude/claude_desktop_config.json'

Windows:

Cline: '%APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json'
Claude Desktop: '%APPDATA%\Claude Desktop\claude_desktop_config.json'

Linux:

Cline: '~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'

在配置文件中，找到 'mcpServers' 对象，并添加以下配置：

{
  "mcpServers": {
    "jira": {
      "command": "node",
      "args": ["/absolute/path/to/jira-mcp/build/index.js"],
      "env": {
        "JIRA_API_TOKEN": "your_jira_api_token",  // 你的 Jira API Token
        "JIRA_BASE_URL": "your_jira_instance_url",   // 你的 Jira 实例 URL，例如：https://your-domain.atlassian.net
        "JIRA_USER_EMAIL": "your_jira_email"      // 你的 Jira 用户邮箱
      }
    }
  }
}

请务必替换以下占位符为你实际的 Jira API 凭据和实例 URL：

'your_jira_api_token'
'your_jira_instance_url'
'your_jira_email'
'/absolute/path/to/jira-mcp/build/index.js' 需要替换为 'jira-mcp/build/index.js' 文件的绝对路径。

基本使用方法

配置完成后，在 MCP 客户端中选择 "jira" 服务器。客户端将能够通过 MCP 协议与 Jira MCP Server 通信，并使用其提供的工具来查询和操作 Jira 数据。

例如，在 Cline 或 Claude Desktop 中，你可以指示 LLM 使用 'search_issues' 工具来搜索 Jira issue，或者使用 'get_issue' 工具来获取特定 issue 的详细信息。具体的工具调用方式取决于 MCP 客户端的界面和指令格式。

可用的 MCP 工具包括：

'search_issues': 使用 JQL 搜索 Jira issue。
'get_epic_children': 获取 Epic 的子 issue。
'get_issue': 获取 issue 详情。
'create_issue': 创建 issue。
'update_issue': 更新 issue。
'add_attachment': 添加附件。
'get_transitions': 获取 issue 可用的状态转换。
'transition_issue': 执行 issue 状态转换。

更多工具的详细输入参数和描述，请参考仓库的 README.md 文件。

关键词