TestRail MCP Server

TestRail MCP サーバー

TestRail のコアエンティティを標準化されたプロトコル経由で操作できる、TestRail 用の Model Context Protocol（MCP）サーバーです。

機能

• 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
   

   URL、ユーザー名、確認用の API キーの先頭数文字など、TestRail の設定情報が表示されます。

このサーバーを 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

これにより、利用可能なすべてのツールとリソースを確認してテストできるウェブインターフェースが開きます。

開発

このサーバーは以下を使用して構築されています：

• FastMCP - MCP サーバーを構築するための Python フレームワーク
• Requests - TestRail API との HTTP 通信
• python-dotenv - 環境変数の管理

ライセンス

MIT