testrail-mcp-server

hersonoliveira/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 henry@mcphub.com.

The TestRail MCP Server is a Model Context Protocol server designed to facilitate interaction with the TestRail API, providing a suite of tools and resources for efficient test management.

Tools

  1. Get Projects

    Retrieve a list of projects from TestRail.

  2. Add Test Case

    Add a new test case to a specified suite.

  3. Update Test Run

    Update details of an existing test run.

  4. Delete Attachment

    Remove an attachment from a test case or result.

  5. Get Users

    Fetch a list of users from the TestRail instance.

TestRail MCP Server

This project is an MCP (Model Context Protocol) server that provides tools and resources for interacting with the TestRail API.

Installation

  1. Clone the repository: 
    git clone git@github.com:hersonoliveira/testrail-mcp-server.git
  2. Navigate to the project directory: 
    cd testrail-mcp-server
  3. Install dependencies using uv: 
    uv sync

Configuration

The server requires a configuration file with your TestRail instance details and API key. Create a file named .env in the project root with the following content:

TESTRAIL_URL=http://example.testrail.io
TESTRAIL_USERNAME=test@example.com
TESTRAIL_API_KEY=your_testrail_api_key

Running the Server

To start the MCP server, run the following command:

uv run main.py

The server will start and be available for connection by MCP clients.

Adding to Cline

Add the following configuration to cline MCP settings json:

{
  "mcpServers": {
    "testrail": {
      "command": "python",
      "args": [
        "/absolute/path/to/testrail-mcp-server/main.py"
      ],
      "env": {
        "TESTRAIL_URL": "http://example.testrail.io",
        "TESTRAIL_USERNAME": "test@example.com",
        "TESTRAIL_API_KEY": "your_testrail_api_key"
      }
    }
  }
}

This way the server doesn't need to be started, Cline handles that.

Available Tools

This MCP server provides a set of tools for interacting with the TestRail API, including:

  • Getting projects, suites, cases, runs, and results.
  • Adding, updating, and deleting projects, suites, cases, runs, and results.
  • Managing milestones and plans.
  • Adding and deleting attachments.
  • Getting users and custom fields.

Refer to the tool definitions provided by the MCP server for detailed information on available tools and their parameters.

Contributing

Contributions are welcome! Please see the file for details.

License

This project is licensed under the MIT License. See the file for details.