使用说明

项目简介

Jira MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专门为 Jira 设计。它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议与 Jira 系统进行集成,从而实现通过自然语言与 Jira 交互的能力。

主要功能点

  • 工具 (Tools):提供了一系列预定义的工具,允许 LLM 客户端查询 Jira 中的信息,目前包括:
    • 'list_projects': 列出 Jira 项目。
    • 'list_boards': 列出指定项目下的看板。
    • 'list_sprints_from_board': 列出指定看板下的迭代。
    • 'list_issues_from_sprint': 列出指定迭代中的问题。
  • 基于 MCP 协议: 遵循 MCP 协议标准,易于与任何兼容 MCP 协议的 LLM 客户端集成。
  • 可扩展性: 工具化的设计使得可以方便地扩展服务器的功能,添加更多与 Jira 交互的工具。

安装步骤

  1. 获取 Jira Personal Access Token: 访问 Jira Personal Access Tokens 指南 创建或获取您的 Jira Personal Access Token。
  2. 配置 Claude Desktop (或其他 MCP 客户端): 根据您的 MCP 客户端(例如 Claude Desktop)的配置方法,添加 Jira MCP Server 的配置信息。对于 Claude Desktop,您需要编辑配置文件 'claude_desktop_config.json'。

服务器配置

以下是配置 Jira MCP Server 的 JSON 示例,您需要将其添加到 MCP 客户端的配置文件中。请注意,您只需复制以下 JSON 配置信息到您的 MCP 客户端,无需运行任何命令。MCP 客户端会根据此配置自动启动和连接 Jira MCP Server。

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": ["-y", "@parassolanki/jira-mcp-server"],
      "env": {
        "JIRA_PERSONAL_ACCESS_TOKEN": "YOUR_JIRA_PERSONAL_ACCESS_TOKEN",  // 替换为您的 Jira Personal Access Token
        "JIRA_BASE_URL": "YOUR_JIRA_BASE_URL"  // 替换为您的 Jira Base URL,例如 "https://your-jira-instance.atlassian.net"
      }
    }
  }
}

配置参数说明:

  • 'server name': 'jira' - 服务器名称,用于在 MCP 客户端中标识和引用。
  • 'command': 'npx' - 用于执行 npm 包的命令。
  • 'args': '["-y", "@parassolanki/jira-mcp-server"]' - 启动 Jira MCP Server 的参数。'npx' 将会下载并执行 '@parassolanki/jira-mcp-server' 包。'-y' 参数用于自动确认安装包。
  • 'env': 环境变量配置。
    • 'JIRA_PERSONAL_ACCESS_TOKEN': 必填。您的 Jira Personal Access Token,用于服务器认证 Jira API。
    • 'JIRA_BASE_URL': 必填。您的 Jira 实例的 Base URL,例如 'https://your-jira-instance.atlassian.net'。请确保 URL 以 'https://' 开头。

请务必将 'YOUR_JIRA_PERSONAL_ACCESS_TOKEN' 和 'YOUR_JIRA_BASE_URL' 替换为您自己的 Jira 凭据和实例地址。

基本使用方法

配置完成后,在您的 MCP 客户端中,您可以使用自然语言指令来调用 Jira MCP Server 提供的工具。以下是一些示例:

  • 查询所有 Jira 项目: 在 LLM 客户端中输入指令,例如 "Show me all Jira projects",客户端将调用 'list_projects' 工具,并返回 Jira 项目列表。
  • 查询指定项目的看板: 例如,要查询 "DEV" 项目的 Kanban 看板,可以输入指令 "What Kanban boards exist in the DEV project?",客户端将调用 'list_boards' 工具,并使用项目 Key "DEV" 和类型 "kanban" 作为参数。
  • 查询看板的迭代: 例如,要查询看板 ID 为 "123" 的所有迭代,可以输入指令 "Show me all the sprints for board ID 123",客户端将调用 'list_sprints_from_board' 工具,并使用看板 ID "123" 作为参数。
  • 查询迭代中的问题: 例如,要查询看板 ID 为 "123",迭代 ID 为 "456" 的所有问题,可以输入指令 "What issues are in sprint 456 on board 123?",客户端将调用 'list_issues_from_sprint' 工具,并使用看板 ID "123" 和迭代 ID "456" 作为参数。

您可以参考仓库 README.md 中的 "Usage examples" 部分获取更多使用示例。

信息

分类

开发者工具