关键词

TestRail测试管理自动化测试软件测试API集成

项目简介

TestRail MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在将 TestRail 测试管理系统的功能集成到支持 MCP 协议的 LLM 客户端（如 Cursor, Claude）中。通过该服务器，用户可以直接在 AI 对话环境中调用 TestRail 的各项功能，实现测试用例、项目、测试运行等的管理，提升测试工作流程的效率。

主要功能点

  • 项目管理：支持创建、读取、更新和删除 TestRail 项目。
  • 测试用例管理：支持创建、读取、更新和删除测试用例，以及获取用例类型和字段信息。
  • 测试章节管理：支持创建、读取、更新、移动和删除测试章节，以及复制和移动用例到指定章节。
  • 测试套件管理：支持创建、读取、更新和删除测试套件。
  • 测试运行管理：支持创建、读取、更新、关闭和删除测试运行。
  • 共享步骤管理：支持创建、读取、更新和删除共享步骤。
  • 里程碑管理：支持创建、读取、更新和删除里程碑。
  • 测试计划管理：支持创建、读取、更新、关闭和删除测试计划及计划条目。
  • 测试结果管理：支持读取测试结果，包括用例和运行的结果。
  • 用户管理：支持读取 TestRail 用户信息。

安装步骤

  1. 安装 Node.js 和 npm：确保您的系统已安装 Node.js 和 npm。
  2. 克隆仓库：将 'mcp-testrail' 仓库克隆到本地。 
    git clone https://github.com/bun913/mcp-testrail.git
cd mcp-testrail
  3. 安装依赖：在仓库根目录下运行以下命令安装项目依赖。 
    npm install
  4. 配置环境变量：复制 '.env.example' 文件并重命名为 '.env'，根据您的 TestRail 实例信息修改 '.env' 文件中的配置项，包括 'TESTRAIL_URL', 'TESTRAIL_USERNAME', 和 'TESTRAIL_API_KEY'。
  5. 构建项目：运行以下命令构建项目。 
    npm run build
  6. 启动服务器：根据您选择的连接方式运行以下命令启动服务器。
    • SSE 模式 (推荐 Cursor 使用): 
      npm run start
      服务器默认运行在 'http://localhost:8080/sse'。
    • Stdio 模式 (推荐 Claude Desktop 使用): 无需单独启动，客户端配置中指定启动命令即可。

服务器配置

以下是在 MCP 客户端中配置 TestRail MCP 服务器的示例，以 Cursor 和 Claude Desktop 为例：

Cursor 配置 (SSE 连接)

在 Cursor 中，进入 MCP Servers 设置，点击 "Add Server" 添加服务器，配置信息如下：

{
  "mcpServers": {
    "testrail": {
      "type": "sse",
      "url": "http://localhost:8080/sse"
    }
  }
}
  • Server Name: 'testrail' (服务器名称，可自定义)
  • Server Link: 'http://localhost:8080/sse' (服务器 SSE 地址，与启动地址一致)
  • Connection Type: 'SSE' (连接类型选择 SSE)

Claude Desktop 配置 (Command 启动)

在 Claude Desktop 的配置文件中 (通常为 '~/.claude/settings.json' 或应用设置中指定的文件)，添加 MCP 服务器配置：

{
  "mcpServers": {
    "TestRail": { // 服务器名称，可自定义
      "type": "command", // 连接类型为 command，表示通过命令启动
      "command": "${YOUR_NODE_PATH}/node", // Node.js 可执行文件的路径，请替换为您的 Node.js 安装路径
      "args": ["${YOUR_PROJECT_PATH}/mcp-testrail/dist/stdio.js"], // 服务器启动参数，指向 stdio 模式的入口文件，请替换为您的项目路径
      "env": { // 环境变量配置
        "TESTRAIL_URL": "https://example.testrail.io", // 您的 TestRail 实例 URL，请替换为您的实际 URL
        "TESTRAIL_USERNAME": "[email protected]", // 您的 TestRail 用户名，请替换为您的用户名
        "TESTRAIL_API_KEY": "YOUR_API_KEY" // 您的 TestRail API 密钥，请替换为您的 API 密钥
      }
    }
  }
}

注意:

  • '${YOUR_NODE_PATH}' 和 '${YOUR_PROJECT_PATH}' 需要替换为您的实际 Node.js 安装路径和项目路径。
  • 环境变量 'TESTRAIL_URL', 'TESTRAIL_USERNAME', 'TESTRAIL_API_KEY' 必须根据您的 TestRail 实例信息进行配置。

基本使用方法

在配置完成后，您可以在 Cursor 或 Claude 等 MCP 客户端中，通过自然语言指令或工具调用方式，使用 TestRail MCP 服务器提供的工具。例如，在 Cursor 中，您可以使用 'getProjects' 工具获取项目列表，使用 'getCase' 工具获取指定测试用例的详细信息。具体工具的使用方法和参数，请参考仓库 README.md 文件中 "Available Tools" 部分的描述。

// 例如，在 Cursor 中调用 getProjects 工具
// { "tool_code": "getProjects", "tool_name": "getProjects" }

// 调用 getCase 工具并传入 caseId 参数
// { "tool_code": "getCase", "tool_name": "getCase", "parameters": { "caseId": 123 } }

请根据您使用的 MCP 客户端的具体操作方式调用工具。工具的具体参数和使用方法请参考仓库的 README.md 文件。

信息

分类

开发者工具

访问项目