使用说明

项目简介

jira-service MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 应用提供与 Atlassian Jira 集成的能力。通过此服务器,LLM 可以安全、可扩展地访问和操作 Jira 资源,例如项目和问题。

主要功能点

  • Jira 项目管理:
    • 列出所有 Jira 项目。
    • 获取指定 Jira 项目的详细信息。
  • Jira 问题管理:
    • 根据项目或问题 ID 搜索 Jira 问题。
    • 为 Jira 问题添加评论。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/chima-org/jira-mcp-server
  2. 进入仓库目录:
    cd jira-mcp-server
  3. 安装依赖: 确保已安装 'uv' 包管理器 (参考仓库 README)。运行以下命令同步依赖并更新 lockfile:
    uv sync

服务器配置

要将 'jira-service' MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令和参数。以下是一个配置示例,您需要根据实际情况修改仓库路径。

MCP 客户端配置 (JSON 格式):

"mcpServers": {
  "jira-service": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/jira-mcp-server",  // 请替换为您的 jira-mcp-server 仓库在您系统上的实际路径
      "run",
      "src/jira_service/server.py" // 指定运行 server.py 文件
    ]
  }
}

环境变量配置:

此 MCP 服务器需要以下环境变量才能连接到您的 Jira 实例。您需要在运行服务器的环境中配置这些变量:

  • 'WORK_JIRA_API_KEY': 您的 Jira 工作环境 API 密钥。
  • 'PERSONAL_JIRA_API_KEY': 您的个人 Jira 环境 API 密钥 (用于添加评论功能)。
  • 'WORK_JIRA_USER': 您的 Jira 工作环境用户名。
  • 'PERSONAL_JIRA_USER': 您的个人 Jira 环境用户名 (用于添加评论功能)。
  • 'WORK_JIRA_SERVER': 您的 Jira 工作环境服务器 URL (例如 'https://your-workspace.atlassian.net')。
  • 'PERSONAL_JIRA_SERVER': 您的个人 Jira 环境服务器 URL (例如 'https://your-personal.atlassian.net')。

请根据您的 Jira 账户信息和 API 密钥替换上述占位符。您可以通过 '.env' 文件或系统环境变量来设置这些变量。

基本使用方法

  1. 启动 MCP 服务器: 根据 MCP 客户端的配置方式启动 'jira-service' MCP 服务器。
  2. 在 LLM 应用中使用: 在支持 MCP 协议的 LLM 应用中,配置并连接到 'jira-service' 服务器。您可以使用服务器提供的工具(Tools)来与 Jira 进行交互。例如,调用 'jira_list_projects' 工具可以获取 Jira 项目列表。具体工具的使用方法和参数,请参考 'src/jira_service/server.py' 文件中 'handle_list_tools' 和 'call_tool' 函数的定义。

调试: 可以使用仓库 README 中推荐的 MCP Inspector 工具进行调试。

信息

分类

开发者工具