testrail-mcp-server

Marc-Reynolds/testrail-mcp-server

3.2

If you are the rightful owner of testrail-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to dayong@mcphub.com.

An MCP server that integrates with TestRail API to facilitate test management operations for AI assistants.

Tools
5
Resources
0
Prompts
0

TestRail MCP Server

An MCP (Model Context Protocol) server that provides AI assistants with access to TestRail API for test management operations.

Features

This server provides the following tools to interact with TestRail:

  • get_test_run - Get information about a specific test run
  • get_test_results - Fetch test results for a test run
  • get_test_case - Get details about a specific test case
  • list_projects - List all available TestRail projects
  • get_users - Get list of TestRail users
  • get_tests_for_run - Get all tests in a specific test run

Installation

  1. Install dependencies:
npm install
  1. Create a .env file based on .env.example:
cp .env.example .env
  1. Configure your TestRail credentials in .env:
TESTRAIL_URL=https://argosapps.testrail.net
TESTRAIL_USERNAME=your-email@sainsburys.co.uk
TESTRAIL_API_KEY=your-api-key-here
  1. Build the server:
npm run build

Usage

Command Line Interface (Recommended)

The easiest way to use the TestRail MCP server is via the CLI wrapper:

# Get tests for a run
node cli.js get-tests <run_id>

# Get test run details
node cli.js get-run <run_id>

# Get test results for a run
node cli.js get-results <run_id>

# Get a specific test case
node cli.js get-case <case_id>

# List all projects
node cli.js list-projects

# Get all users
node cli.js get-users

Examples:

node cli.js get-tests 20560
node cli.js get-run 18889
node cli.js list-projects

With Claude Desktop

Add to your Claude Desktop configuration (claude_desktop_config.json):

{
  "mcpServers": {
    "testrail": {
      "command": "node",
      "args": [
        "C:\\Users\\Marc.Reynolds\\testrail-mcp-server\\build\\index.js"
      ]
    }
  }
}

With VS Code

Add to your VS Code workspace settings (.vscode/settings.json):

{
  "github.copilot.chat.codeGeneration.mcp": {
    "enabled": true,
    "servers": {
      "testrail": {
        "command": "node",
        "args": [
          "c:\\Users\\Marc.Reynolds\\testrail-mcp-server\\build\\index.js"
        ]
      }
    }
  }
}

Development

Run in watch mode during development:

npm run watch

TestRail API Documentation

This server uses the TestRail API v2. For more information:

License

MIT