使用说明

项目简介

Jira communication server MCP Server 是一个基于 TypeScript 开发的 MCP 服务器，旨在使大型语言模型（LLM）能够与 Jira 系统进行交互。它通过 Model Context Protocol (MCP) 协议，提供了一系列工具，允许 LLM 客户端安全、便捷地访问和操作 Jira 资源，实现诸如查询工单、创建工单、编辑工单等功能，从而扩展 LLM 在项目管理和问题跟踪领域的应用能力。

主要功能点

执行 JQL 查询: 允许 LLM 客户端使用 JQL (Jira Query Language) 语句查询 Jira 中的 issue，并返回查询结果。
获取工单信息: 提供工具获取指定 JQL 查询结果中工单的名称和描述，精简上下文信息。
创建 Jira 工单: 支持 LLM 客户端创建新的 Jira 工单，包括指定项目、概要、描述、工单类型和父工单（Epic）。
列出 Jira 项目: 提供工具列出 Jira 系统中的项目列表。
删除 Jira 工单: 允许 LLM 客户端根据工单 ID 或 Key 删除指定的 Jira 工单。
编辑 Jira 工单: 支持修改 Jira 工单的概要、描述、标签和父工单等字段。
获取所有状态: 提供工具获取 Jira 系统中所有可用的工单状态。
指派工单: 允许 LLM 客户端将 Jira 工单指派给指定用户。
查询可指派用户: 支持查询指定项目中可指派的用户列表。
添加附件: 允许 LLM 客户端从公共 URL 或 Confluence 页面为 Jira 工单添加附件。

安装步骤

确保已安装 Node.js 和 npm。
克隆该 GitHub 仓库到本地。
在终端中进入仓库根目录。
运行命令 'npm install' 安装项目依赖。
运行命令 'npm run build' 构建服务器代码。

服务器配置

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

{
  "mcpServers": {
    "Jira communication server": {
      "command": "node",
      "args": [
        "/PATH_TO_THE_PROJECT/build/index.js"  // 将 "/PATH_TO_THE_PROJECT" 替换为项目构建后 index.js 文件的实际路径
      ],
      "env": {
        "JIRA_URL": "YOUR_JIRA_URL",          // 替换为您的 Jira 实例 URL，例如 "https://your-domain.atlassian.net"
        "JIRA_API_MAIL": "YOUR_JIRA_EMAIL",     // 替换为您的 Jira API 邮箱
        "JIRA_API_KEY": "YOUR_JIRA_API_KEY"      // 替换为您的 Jira API 密钥，从 https://id.atlassian.com/manage-profile/security/api-tokens 获取
      }
    }
  }
}

基本使用方法

配置完成后，MCP 客户端将能够连接到此 MCP 服务器。LLM 可以通过客户端调用服务器提供的工具来与 Jira 进行交互。例如，要执行 JQL 查询，LLM 可以指示客户端调用 'execute_jql' 工具，并提供 JQL 查询语句作为参数。服务器会将查询结果返回给客户端，并最终传递给 LLM。具体工具调用方式和参数请参考各个工具的 'inputSchema' 定义。

关键词