使用说明

项目简介

本项目是基于 Model Context Protocol (MCP) 实现的一个服务器端应用。它作为大型语言模型（LLM）访问 ReportPortal 测试管理系统的中间层，允许用户通过 LLM 对话界面，方便地查询和分析 ReportPortal 中的测试执行结果和相关数据。

主要功能点

查询测试批次 (Launches): 获取 ReportPortal 中测试执行批次的列表，支持分页和多种过滤条件（如名称、状态、时间等）。
获取特定批次详情: 根据名称或唯一标识符 (ID) 获取单个测试批次的详细信息。
查询测试项 (Test Items): 获取特定测试批次下的所有测试项列表，支持分页。
获取特定测试项详情: 根据唯一标识符 (ID) 获取单个测试项的详细信息。
提供 Prompt 模板: 包含预定义的 Prompt 模板，辅助 LLM 理解和分析测试执行结果，例如对特定测试批次进行综合分析。

安装步骤

安装 Go 环境: 确保您的系统已经安装了 Go 1.24.1 或更高版本。可以从 Go 官方网站下载安装。

克隆仓库: 打开终端或命令提示符，执行以下命令克隆项目代码：

git clone https://github.com/reportportal/reportportal-mcp-server.git

进入项目目录:

cd reportportal-mcp-server

编译服务器程序: 执行编译命令生成可执行文件：
```
go build -o reportportal-mcp-server ./cmd/reportportal-mcp-server
```
编译成功后，会在当前目录下生成一个名为 'reportportal-mcp-server'（或 'reportportal-mcp-server.exe' 在 Windows 上）的可执行文件。

服务器配置

本 MCP 服务器通过标准输入/输出 (Stdio) 协议与 MCP 客户端通信。通常由支持 MCP 的 LLM 客户端程序自动启动和管理。您需要在 MCP 客户端中配置此服务器的信息，以便客户端能够找到并启动它。

MCP 客户端的配置信息通常是 JSON 格式，其中至少包含服务器的名称、可执行文件路径 (command) 和启动参数 (args)。以下是根据本项目特点生成的配置示例结构及参数说明（请根据您的 MCP 客户端实际支持的格式进行调整）：

{
  "name": "ReportPortal MCP Server", // 服务器名称
  "command": "/path/to/your/reportportal-mcp-server", // 编译生成的可执行文件完整路径
  "args": [
    "--host", "https://your-reportportal-instance.com", // ReportPortal 实例的 URL
    "--project", "your-project-name", // 要连接的 ReportPortal 项目名称
    "--token", "your-api-token" // 用于 ReportPortal API 认证的 Token
  ],
  "description": "Allows interacting with ReportPortal from LLMs." // 服务器描述
  // ... MCP 客户端可能需要的其他配置字段
}

参数说明:

'command': 必填。指向您在安装步骤中编译生成的 'reportportal-mcp-server' 可执行文件的完整文件路径。
'args': 必填。一个字符串数组，包含启动服务器时所需的命令行参数。
- '--host': 必填。您的 ReportPortal 实例的完整 URL，例如 'https://demo.reportportal.io'。也可以通过环境变量 'RP_HOST' 设置。
- '--project': 必填。您希望访问的 ReportPortal 项目名称。也可以通过环境变量 'RP_PROJECT' 设置。
- '--token': 必填。用于访问 ReportPortal API 的认证 Token。您可以在 ReportPortal 用户设置中生成。也可以通过环境变量 'RP_API_TOKEN' 设置。

请根据您的实际安装路径和 ReportPortal 连接信息修改上述 'command' 和 'args' 中的值，并在您的 MCP 客户端中进行相应的配置。

基本使用方法

一旦在支持 MCP 的 LLM 客户端中配置并启用了 ReportPortal MCP Server，您就可以在与 LLM 的对话中直接提出与 ReportPortal 数据相关的问题。LLM 将通过 MCP 协议自动调用此服务器提供的工具来获取信息。

例如，您可以尝试：

"List the last 10 launches in ReportPortal."
"Get the details of the launch named 'MyRegressionRun'."
"Show me the test items for launch ID 123."

LLM 会与 MCP 服务器交互，获取 ReportPortal 数据，并根据这些数据生成回复。

关键词