TestRail MCP server for AI agents

The TestRail MCP Server is a specialized server that implements the Model Context Protocol, allowing AI tools to interact with TestRail's core entities like projects, test cases, runs, and results through a standardized interface. This makes your TestRail data accessible to various MCP clients such as Claude Desktop, Cursor, and Windsurf.

Installation Options

Installing via Smithery

For the quickest installation using Smithery:

npx -y @smithery/cli install @sker65/testrail-mcp --client claude

Manual Installation

If you prefer a manual installation:

Clone the repository:

git clone https://github.com/yourusername/testrail-mcp.git
cd testrail-mcp

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

Install dependencies:
```
pip install -e .
```

Configuration

Before using the TestRail MCP server, you need to set up authentication:

Create a .env file in the project's root directory:
```
TESTRAIL_URL=https://your-instance.testrail.io
[email protected]
TESTRAIL_API_KEY=your-api-key
```
Important Notes:
- TESTRAIL_URL should be your complete TestRail instance URL
- TESTRAIL_USERNAME is the email address you use to log in to TestRail
- TESTRAIL_API_KEY can be generated in TestRail under "My Settings" > "API Keys"
Verify your configuration:
```
uvx testrail-mcp --config
```

Usage

Starting the Server

Run the MCP server with:

uvx testrail-mcp

This starts the server in stdio mode, ready to be used with MCP clients.

Integrating with MCP Clients

Claude Desktop

Add a new server in Claude Desktop with this configuration:

{
  "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

In Cursor, add a custom tool:

{
  "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

In Windsurf, configure a new tool:

{
  "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"
  }
}

Testing with MCP Inspector

For testing and exploring the available tools and resources:

npx @modelcontextprotocol/inspector \
  -e TESTRAIL_URL=<your-url> \
  -e TESTRAIL_USERNAME=<your-username> \
  -e TESTRAIL_API_KEY=<your-api-key> \
  uvx testrail-mcp

This opens a web interface for interactively testing the MCP server's functionality.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "testrail" '{"command":"uvx","args":["testrail-mcp"],"env":{"TESTRAIL_URL":"https://your-instance.testrail.io","TESTRAIL_USERNAME":"[email protected]","TESTRAIL_API_KEY":"your-api-key"}}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "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"
            }
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "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"
            }
        }
    }
}

3. Restart Claude Desktop for the changes to take effect