reportportal/mcp-server

ReportPortal MCP Server

什么是ReportPortal MCP Server？

ReportPortal MCP Server是ReportPortal实例与AI聊天助手（如Claude Desktop、GitHub Copilot、Cursor）之间的桥梁。简单来说，它允许你用自然英语提问有关测试运行的问题，并直接从ReportPortal获取答案。它遵循官方MCP指南。

例如，无需登录ReportPortal UI，你可以向AI助手询问“上次运行中有哪些测试失败？”或“列出最近5次测试运行”，它将从ReportPortal获取相关信息。这使QA测试人员和管理人员能够使用自然语言查询测试结果，加快分析和报告速度。

为什么使用它？

• 快速测试洞察：无需编写代码或导航UI，即可即时获取测试运行摘要、失败数量或错误详情。
• 基于聊天的查询：使用你喜爱的AI助手（Claude、Cursor等）与ReportPortal数据对话。就像在聊天窗口中有一个智能测试报告助手。
• 集成灵活性：适用于任何MCP兼容的AI工具。只需将工具指向此服务器，它就能在后台运行ReportPortal查询。
• 无需自定义脚本：常见查询（列出运行、获取失败、分析）作为简单“命令”内置，可通过聊天调用。

安装

有两种方式运行ReportPortal MCP Server的最新版本，每种方式都适用于任何LLM提供商。

通过Docker（推荐）

MCP服务器可在ReportPortal官方https://hub.docker.com/r/reportportal/mcp-server%E8%8E%B7%E5%8F%96%E3%80%82

配置：

json
{
  "reportportal": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "--rm",
      "-e",
      "RP_API_TOKEN",
      "-e",
      "RP_HOST",
      "-e",
      "RP_PROJECT",
      "reportportal/mcp-server"
    ],
    "env": {
      "RP_API_TOKEN": "your-api-token",
      "RP_HOST": "https://your-reportportal-instance.com",
      "RP_PROJECT": "YourProjectInReportPortal"
    }
  }
}

使用预编译二进制文件

可从GitHub上的官方发布页面https://github.com/reportportal/reportportal-mcp-server/releases%E4%B8%8B%E8%BD%BD%E9%80%82%E7%94%A8%E4%BA%8E%E4%B8%8D%E5%90%8C%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E7%9A%84%E9%A2%84%E7%BC%96%E8%AF%91%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

配置：

json
{
  "reportportal": {
    "command": "/path/to/reportportal-mcp-server-binary",
    "args": ["stdio"],
    "env": {
      "RP_API_TOKEN": "your-api-token",
      "RP_HOST": "https://your-reportportal-instance.com",
      "RP_PROJECT": "YourProjectInReportPortal"
    }
  }
}

选择你喜欢的AI工具进行连接。

Claude Desktop

1. 打开Claude Desktop，进入设置 → 开发者 → 编辑配置。
2. 添加运行ReportPortal MCP Server的新MCP服务器条目。

json
{
  "mcpServers": {
    "reportportal": {
      // 选择上述Docker或二进制配置
    }
  }
}

3. 保存并重启Claude Desktop。

Claude Code CLI

1. 打开终端。
2. 运行以下命令：

bash
claude mcp add-json reportportal '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "RP_API_TOKEN", "-e", "RP_HOST", "-e", "RP_PROJECT", "reportportal/mcp-server"], "env": {"RP_API_TOKEN": "your-api-token", "RP_HOST": "https://your-reportportal-instance.com", "RP_PROJECT": "YourProjectInReportPortal"}}'

配置选项：

• 使用-s user将服务器添加到用户配置（所有项目可用）。
• 使用-s project将服务器添加到项目特定配置（通过.mcp.json共享）。
• 默认作用域为local（仅当前项目中对你可用）。

文档：Claude Code指南。

Cursor（AI代码编辑器）

直接点击

![安装MCP服务器]([***]

或按照以下步骤：

1. 在Cursor中，进入设置 → 扩展 → MCP，点击添加新的全局MCP服务器。
2. 添加运行ReportPortal MCP Server的新MCP服务器条目。

json
{
  "mcpServers": {
    "reportportal": {
      // 选择上述Docker或二进制配置
    }
  }
}

文档：Cursor MCP。

GitHub Copilot（在VS Code和JetBrains IDE中）

VS Code

1. 安装/更新GitHub Copilot插件。
2. 在搜索栏中输入**>mcp**，选择MCP: 打开用户配置。
3. 添加配置：

json
{
  "servers": {
    "reportportal": {
      // 选择上述Docker或二进制配置
    }
  }
}

文档：VS Code Copilot指南。

JetBrains IDEs

1. 安装/更新GitHub Copilot插件。
2. 点击状态栏中的GitHub Copilot图标 → 编辑设置 → 模型上下文协议 → 配置。
3. 添加配置：

json
{
  "servers": {
    "reportportal": {
      // 选择上述Docker或二进制配置
    }
  }
}

4. 按Ctrl + S或Command + S保存，或关闭mcp.json文件。配置应立即生效并重启所有定义的MCP服务器。如有需要，可重启IDE。

文档：JetBrains Copilot指南。

连接后，你的AI助手将列出可调用的ReportPortal相关“工具”。然后你可以在聊天中提问，助手将代表你调用这些工具。

功能

ReportPortal MCP服务器提供与ReportPortal交互的全面功能集：

测试运行管理

• 通过筛选条件获取和过滤测试运行（带分页）
• 通过名称或ID获取测试运行详情
• 强制结束运行中的测试运行
• 删除测试运行
• 对测试运行执行自动分析（自动分析、唯一错误分析）

测试项分析

• 通过筛选条件获取测试项
• 获取每个测试项的详细信息
• 查看测试执行统计数据和失败情况
• 检索测试日志和附件

报告生成

• 分析测试运行以获取详细的测试执行洞察
• 生成包含统计数据和失败分析的结构化报告

可用工具（命令）

可用提示词

分析测试运行

分析ReportPortal测试运行，提供有关测试结果、失败和统计数据的详细信息。

参数：

• launch_id：要分析的测试运行ID

你可以参考https://github.com/reportportal/reportportal-mcp-server/blob/main/internal/reportportal/prompts/launch.yaml%E6%9D%A5%E7%BC%96%E5%86%99%E8%87%AA%E5%B7%B1%E7%9A%84%E6%8F%90%E7%A4%BA%E8%AF%8D%E3%80%82

示例查询（自然语言）

以下是设置后你可能会向AI提问的一些实际示例（助手的响应将来自ReportPortal数据）：

• “列出最近5次测试运行。” – 返回带名称和状态的最近测试运行分页列表。
• “最新运行中有哪些测试失败？” – 显示最近测试运行的失败测试项。
• “显示编号1234的测试运行详情。” – 获取该特定测试运行的信息（ID、名称、描述、统计数据）。
• “对测试运行ABC执行分析。” – 触发ReportPortal的自动分析，总结测试运行“ABC”的结果和失败情况。
• “结束ID为4321的运行中测试运行。” – 强制当前运行的测试运行停止。
• “显示过去一小时内前五个500级错误” - 列出最近测试结果中的前5个此类错误。

上述每个查询都对应MCP服务器提供的“工具”，但你只需自然表达。AI将在后台调用正确的命令。这些功能使你能够通过简单的聊天交互以多种方式查询和管理测试报告。

面向开发者

先决条件

• Go 1.24.1或更高版本
• ReportPortal实例

从源代码构建

bash
# 克隆仓库
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的位置和身份验证方式。在shell中设置以下环境变量：

例如：

bash
export RP_HOST="https://your-reportportal-instance.com"
export RP_PROJECT="YourProjectInReportPortal"
export RP_API_TOKEN="your-api-token"

启动服务器

配置上述环境变量后，只需运行：

bash
./reportportal-mcp-server

这将在配置的端口上启动MCP服务器。

运行后，MCP服务器准备接受来自AI工具的查询。

开发

要设置开发环境或贡献代码：

任务工具

安装Go Task v3：

bash
go install github.com/go-task/task/v3/cmd/task@latest

依赖项

运行task deps安装Go依赖项：

bash
task deps

构建

bash
task build

测试

bash
task test

使用Docker构建

bash
task docker:build

使用MCP Inspector调试

https://github.com/modelcontextprotocol/inspector%E5%B7%A5%E5%85%B7%E9%80%82%E7%94%A8%E4%BA%8E%E6%9C%AC%E5%9C%B0%E6%B5%8B%E8%AF%95%E5%92%8C%E8%B0%83%E8%AF%95MCP%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%9A

bash
npx @modelcontextprotocol/inspector docker run -i --rm -e "RP_API_TOKEN=$RP_API_TOKEN" -e "RP_PROJECT=$RP_PROJECT" -e "RP_HOST=$RP_HOST" reportportal-mcp-server

或者，你可以使用Task命令：

bash
# 针对本地服务器运行inspector
task inspector

代码质量

bash
# 代码检查
task lint

# 代码格式化
task fmt

扩展服务器

添加新工具

要添加新工具，请在相应的资源文件中创建新方法，并在NewServer函数中将其添加到服务器：

go
// 在资源文件中（例如launches.go）
func (lr *LaunchResources) toolNewFeature() (tool mcp.Tool, handler server.ToolHandlerFunc) {
    // 实现你的工具
}

// 在server.go中
func NewServer(...) *server.MCPServer {
    // ...
    s.AddTool(launches.toolNewFeature())
    // ...
}

添加新提示词

要添加新提示词，只需创建描述提示词的YAML文件，并将其放在项目根目录的prompts文件夹中。服务器在启动时会自动从该目录读取并初始化所有提示词——无需代码更改。

示例：

1. 使用现有文件或创建新文件（例如my_custom_prompt.yaml），放在prompts文件夹中。
2. 以YAML格式定义提示词逻辑和参数。
3. 重建服务器以加载新提示词。

这种方法允许你快速扩展服务器的功能，添加自定义提示词，而无需修改代码库。

许可证

本项目采用Apache 2.0许可证。