Testrail MCP

🚀 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 許可證。