🚀 TestRail MCP 服务器

一个用于 TestRail 的 Model Context Protocol (MCP) 服务器，借助标准化协议达成与 TestRail 核心实体的交互，有效提升与 TestRail 系统的交互效率。

🚀 快速开始

TestRail MCP 服务器可助力您通过标准化协议与 TestRail 核心实体交互。下面为您介绍安装、配置及使用的步骤。

✨ 主要特性

• 支持与 TestRail API 的身份验证，保障数据交互安全。
• 可访问多种 TestRail 实体，涵盖项目、用例、运行、结果、数据集。
• 完全支持 Model Context Protocol (MCP)，确保协议兼容性。
• 能与任何 MCP 客户端兼容，如 Claude Desktop、Cursor、Windsurf 等。

🎥 视频演示

点击下方图片观看视频演示：

📦 安装指南

通过 Smithery 安装

若要为 Claude Desktop 自动安装 testrail - mcp，可使用 Smithery：

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  # 在 Windows 上：.venv\Scripts\activate

3. 安装依赖项：

pip install -e .

⚙️ 配置

TestRail MCP 服务器需特定环境变量以与您的 TestRail 实例进行身份验证，运行服务器前必须设置这些变量。

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

TESTRAIL_URL=https://your-instance.testrail.io
TESTRAIL_USERNAME=your-email@example.com
TESTRAIL_API_KEY=your-api-key

注意：请确保将 <your-url>、<your-username> 和 <your-api-key> 替换为实际的值。 2. 完成配置后，您可以运行服务器：

uvicorn main:app --reload

💻 使用示例

测试与调试

对于测试和调试，您可以使用 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 许可证。