# TestRail MCP Server

A complete Model Context Protocol (MCP) server for TestRail integration with **full API support**. Allows AI assistants like Cursor to interact with TestRail test management system.

## ✨ Features

### 📁 Projects
- Get all projects or specific project details

### 📦 Test Suites
- Get, create, and update test suites

### 📂 Sections
- Get, create, update, and delete sections

### 📝 Test Cases
- Full CRUD operations (Create, Read, Update, Delete)
- Get case types and custom fields
- Support for all custom fields and templates

### 🏃 Test Runs
- Create, update, and close test runs
- Get run details and lists

### 🧪 Tests
- Get tests from runs
- Detailed test information

### ✅ Results
- Add single or bulk test results
- Get results for tests, cases, and runs
- Track test execution history

### 📋 Test Plans
- Get test plans and plan details

### 🎯 Milestones
- Get milestones for projects

## Installation

```bash
npm install -g mcp-testrail
```

Or use directly with npx (no installation needed):

```bash
npx -y mcp-testrail
```

## Quick Setup with Cursor

### Step 1: Get Your TestRail API Key

1. Log in to your TestRail instance
2. Click on your profile (top right)
3. Go to **Settings** → **API Keys**
4. Click **Add Key** and give it a name
5. Copy the generated API key

### Step 2: Configure Cursor

1. Open Cursor Settings (Ctrl/Cmd + ,)
2. Search for "MCP" or go to **Features** → **Model Context Protocol**
3. Click **Edit Config** or open the config file
4. Add the following configuration (also available in `cursor-config.example.json`):

```json
{
  "mcpServers": {
    "testrail": {
      "command": "npx",
      "args": ["-y", "mcp-testrail"],
      "env": {
        "TESTRAIL_URL": "https://your-company.testrail.io",
        "TESTRAIL_USERNAME": "your-email@company.com",
        "TESTRAIL_API_KEY": "your-api-key-here"
      }
    }
  }
}
```

5. **Replace** the following values:
   - `https://your-company.testrail.io` - with your TestRail URL
   - `your-email@company.com` - with your TestRail email
   - `your-api-key-here` - with your API key from Step 1

6. Save the config file
7. **Restart Cursor**

### Step 3: Verify It Works

Open Cursor chat and try:
```
Show me all TestRail projects
```

If everything is configured correctly, you'll see your TestRail projects!

## Environment Variables

- `TESTRAIL_URL` - Your TestRail instance URL (e.g., `https://yourcompany.testrail.io`)
- `TESTRAIL_USERNAME` - Your TestRail email address
- `TESTRAIL_API_KEY` - Your TestRail API key (generated in TestRail settings)

## 🛠️ Available Tools (40+ methods)

### Projects
- `get_projects`, `get_project`

### Suites
- `get_suites`, `get_suite`, `add_suite`, `update_suite`

### Sections
- `get_sections`, `get_section`, `add_section`, `update_section`, `delete_section`

### Test Cases
- `get_cases`, `get_case`, `add_case`, `update_case`, `delete_case`
- `get_case_types`, `get_case_fields`

### Test Runs
- `get_runs`, `get_run`, `add_run`, `update_run`, `close_run`

### Tests
- `get_tests`, `get_test`

### Results
- `get_results`, `get_results_for_case`, `get_results_for_run`
- `add_result`, `add_result_for_case`, `add_results_for_cases`

### Plans
- `get_plans`, `get_plan`

### Milestones
- `get_milestones`, `get_milestone`

## License

MIT