TestRail MCP Server

TestRail MCP Server

site icon
2025.04.16 0
Python测试管理自动化测试开发效率
TestRail MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,用于与 TestRail 的核心实体进行交互。它提供了一套标准化的协议,使得用户可以通过 MCP 客户端(如 Claude Desktop、Cursor、Winsurf 等)访问 TestRail 的各类实体,包括项目、案例、运行、结果和数据集等。
View on GitHub

Overview

基本能力

产品定位

TestRail MCP Server 是一个用于 TestRail 的 MCP 服务器,旨在通过标准化的协议与 TestRail 的核心实体进行交互,提升测试管理的效率和便捷性。

核心功能

  • 支持 TestRail API 的认证
  • 访问 TestRail 的核心实体:
  • 项目(Projects)
  • 案例(Cases)
  • 运行(Runs)
  • 结果(Results)
  • 数据集(Datasets)
  • 完全支持 Model Context Protocol
  • 兼容任何 MCP 客户端(如 Claude Desktop、Cursor、Winsurf 等)

适用场景

  • 测试管理:通过 MCP 客户端高效管理 TestRail 中的测试项目、案例和结果。
  • 自动化测试:集成到自动化测试流程中,方便调用 TestRail 的 API。
  • 开发调试:使用 MCP Inspector 进行调试和测试。

工具列表

  • MCP Inspector:用于测试和调试 MCP 服务器的工具,提供 Web 界面以探索和测试所有可用的工具和资源。

常见问题解答

  • 如何生成 TestRail API Key:登录 TestRail,进入 "My Settings" > "API Keys" 并创建新的 API Key。
  • 如何验证配置是否正确加载:运行 python -c "from testrail_mcp.config import TESTRAIL_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY; print(f'URL: {TESTRAIL_URL}, Username: {TESTRAIL_USERNAME}, API Key: {TESTRAIL_API_KEY[:5]}...')" 命令,确认输出信息是否正确。

使用教程

使用依赖

  1. 确保已安装 Python 和 Git。
  2. 创建并激活虚拟环境: bash python -m venv .venv source .venv/bin/activate # On Windows: .venv\Scripts\activate

安装教程

通过 Smithery 安装

npx -y @smithery/cli install @sker65/testrail-mcp --client claude

手动安装

  1. 克隆仓库: bash git clone https://github.com/yourusername/testrail-mcp.git cd testrail-mcp
  2. 安装依赖: bash pip install -e .

调试方式

  1. 运行服务器: bash python -m testrail_mcp
  2. 使用 MCP Inspector 进行调试: bash npx @modelcontextprotocol/inspector stdio -- python -m testrail_mcp

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。