Testrail MCP

🚀 TestRail MCP サーバー

TestRail 用の Model Context Protocol (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