README - TestRail MCP Server by sker65

TestRail MCP Server

A Model Context Protocol (MCP) server for TestRail that allows interaction with TestRail's core entities through a standardized protocol.

Features

Authentication with TestRail API
Access to TestRail entities:
- Projects
- Cases
- Runs
- Results
- Datasets
Full support for the Model Context Protocol
Compatible with any MCP client (Claude Desktop, Cursor, Windsurf, etc.)

See it in action together with Octomind MCP

Installation

Installing via Smithery

To install testrail-mcp for Claude Desktop automatically via Smithery:

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

Manual Installation

Clone this 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

The TestRail MCP server requires specific environment variables to authenticate with your TestRail instance. These must be set before running the server.

Create a .env file in the root directory of the project:
```
TESTRAIL_URL=https://your-instance.testrail.io
TESTRAIL_USERNAME=your-email@example.com
TESTRAIL_API_KEY=your-api-key
```
Important Notes:
- TESTRAIL_URL should be the full URL to your TestRail instance (e.g., https://example.testrail.io)
- TESTRAIL_USERNAME is your TestRail email address used for login
- TESTRAIL_API_KEY is your TestRail API key (not your password)
  - To generate an API key, log in to TestRail, go to "My Settings" > "API Keys" and create a new key
Verify that the configuration is loaded correctly:
```
uvx testrail-mcp --config
```
This will display your TestRail configuration information, including your URL, username, and the first few characters of your API key for verification.

If you're using this server with a client like Claude Desktop or Cursor, make sure the environment variables are accessible to the process running the server. You may need to set these variables in your system environment or ensure they're loaded from the .env file.

Usage

Running the Server

The server can be run directly using the installed script:

uvx testrail-mcp

This will start the MCP server in stdio mode, which can be used with MCP clients that support stdio communication.

Using with MCP Clients

Claude Desktop

In Claude Desktop, add a new server with the following configuration:

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

Cursor

In Cursor, add a new custom tool with the following configuration:

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

Windsurf

In Windsurf, add a new tool with the following configuration:

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

Testing with MCP Inspector

For testing and debugging, you can use the 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

This will open a web interface where you can explore and test all the available tools and resources.

Development

This server is built using:

FastMCP - A Python framework for building MCP servers
Requests - For HTTP communication with TestRail API
python-dotenv - For environment variable management

License

MIT