TestRail MCP Server

TestRail MCP 服务

适用于 TestRail 的 Model Context Protocol（MCP）服务，可通过标准化协议与 TestRail 的核心实体交互。

功能

• 使用 TestRail API 进行身份验证
• 访问 TestRail 实体：
  • 项目
  • 用例
  • 运行
  • 结果
  • 数据集
• 完整支持 Model Context Protocol
• 兼容任何 MCP 客户端（Claude Desktop、Cursor、Windsurf 等）

查看它与 Octomind MCP 协同工作的实际效果

安装

通过 Smithery 安装

通过 Smithery 为 Claude Desktop 自动安装 testrail-mcp：

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

手动安装

1. 克隆此仓库：

   git clone https://github.com/yourusername/testrail-mcp.git
   cd testrail-mcp
   

2. 创建并激活虚拟环境：

   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   

3. 安装依赖：

   pip install -e .
   

配置

TestRail MCP 服务需要特定的环境变量才能通过身份验证连接到你的 TestRail 实例。运行服务前必须设置这些变量。

1. 在项目根目录中创建 .env 文件：

   TESTRAIL_URL=https://your-instance.testrail.io
   [email protected]
   TESTRAIL_API_KEY=your-api-key
   

   重要说明：

   • TESTRAIL_URL 应为 TestRail 实例的完整 URL（例如，https://example.testrail.io）
   • TESTRAIL_USERNAME 是你用于登录的 TestRail 邮箱地址
   • TESTRAIL_API_KEY 是你的 TestRail API 密钥（不是密码）
     • 要生成 API 密钥，请登录 TestRail，前往“My Settings”>“API Keys”，然后创建新密钥

2. 确认配置已正确加载：

   uvx testrail-mcp --config
   

   这将显示你的 TestRail 配置信息，包括 URL、用户名以及 API 密钥的前几个字符，以供验证。

如果你通过 Claude Desktop 或 Cursor 等客户端使用此服务，请确保运行服务的进程可以访问这些环境变量。你可能需要在系统环境中设置这些变量，或确保它们从 .env 文件加载。

使用方法

运行服务

可以直接使用已安装的脚本运行服务：

uvx testrail-mcp

这将以 stdio 模式启动 MCP 服务，可与支持 stdio 通信的 MCP 客户端配合使用。

与 MCP 客户端配合使用

Claude Desktop

在 Claude Desktop 中，添加新服务并使用以下配置：

{
  "mcpServers": {
    "testrail": {
      "command": "uvx",
      "args": [
        "testrail-mcp"
      ],
      "env": {
        "TESTRAIL_URL": "https://your-instance.testrail.io",
        "TESTRAIL_USERNAME": "[email protected]",
        "TESTRAIL_API_KEY": "your-api-key"
      }
    }
  }
}

Cursor

在 Cursor 中，添加新的自定义工具并使用以下配置：

{
  "name": "TestRail MCP",
  "command": "uvx",
  "args": [
    "testrail-mcp"
  ],
  "env": {
    "TESTRAIL_URL": "https://your-instance.testrail.io",
    "TESTRAIL_USERNAME": "[email protected]",
    "TESTRAIL_API_KEY": "your-api-key"
  }
}

Windsurf

在 Windsurf 中，添加新工具并使用以下配置：

{
  "name": "TestRail MCP",
  "command": "uvx",
  "args": [
    "testrail-mcp"
  ],
  "env": {
    "TESTRAIL_URL": "https://your-instance.testrail.io",
    "TESTRAIL_USERNAME": "[email protected]",
    "TESTRAIL_API_KEY": "your-api-key"
  }
}

使用 MCP Inspector 进行测试

你可以使用 MCP Inspector 进行测试和调试：

npx @modelcontextprotocol/inspector \
  -e TESTRAIL_URL=<your-url> \
  -e TESTRAIL_USERNAME=<your-username> \
  -e TESTRAIL_API_KEY=<your-api-key> \
  uvx testrail-mcp

这将打开一个 Web 界面，你可以在其中查看和测试所有可用的工具和资源。

开发

此服务使用以下组件构建：

• FastMCP - 用于构建 MCP 服务的 Python 框架
• Requests - 用于与 TestRail API 进行 HTTP 通信
• python-dotenv - 用于管理环境变量

许可证

MIT