TestRail

An mcp server for testrail

python

12

GitHub Stars

python

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sker65-testrail-mcp": {
      "command": "uvx",
      "args": [
        "testrail-mcp"
      ],
      "env": {
        "TESTRAIL_URL": "https://your-instance.testrail.io",
        "TESTRAIL_API_KEY": "your-api-key",
        "TESTRAIL_USERNAME": "your-email@example.com"
      }
    }
  }
}

You use this MCP server to interact with TestRail through the Model Context Protocol. It authenticates with TestRail and exposes core entities like Projects, Cases, Runs, Results, and Datasets through a standardized MCP interface, letting any MCP client work with TestRail data and actions.

How to use

Install and run the TestRail MCP Server, then connect it to your MCP client (Claude Desktop, Cursor, Windsurf, etc.). You will run the server locally in stdio mode and provide your TestRail credentials via environment variables or a loaded .env file. Use the client to browse TestRail entities, query data, and perform actions supported by the MCP server in a secure, standardized way.

How to install

Prerequisites: you need Python for the server and a runtime to start it (uvx is used to launch the MCP server). You also should have a TestRail account with API access.

# Optional: install via Smithery for automatic client setup
# npx -y @smithery/cli install @sker65/testrail-mcp --client claude

# Manual installation steps
# 1) Clone the repository
# git clone https://github.com/yourusername/testrail-mcp.git
# cd testrail-mcp

# 2) Create and activate a virtual environment
# python -m venv .venv
# source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# 3) Install dependencies
# pip install -e .

Additional configuration notes

Configure authentication to TestRail using environment variables. Create a .env file at the project root and set the following values: TESTRAIL_URL, TESTRAIL_USERNAME, and TESTRAIL_API_KEY.