Skip to content
VS Code

testrail mcp server for VS Code

io.github.uarlouski/testrail-mcp-server

Connect AI assistants to TestRail: manage test cases, suites, runs, results, and attachments.

client:VS Code transport:stdio runtime:npm

Install testrail mcp server in VS Code

.vscode/mcp.json

{
  "inputs": [
    {
      "type": "promptString",
      "id": "testrail-instance-url",
      "description": "TESTRAIL_INSTANCE_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-username",
      "description": "TESTRAIL_USERNAME",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-api-key",
      "description": "TESTRAIL_API_KEY",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-enable-shared-steps",
      "description": "TESTRAIL_ENABLE_SHARED_STEPS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-enable-case-history",
      "description": "TESTRAIL_ENABLE_CASE_HISTORY",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-enable-rag-tools",
      "description": "TESTRAIL_ENABLE_RAG_TOOLS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-allow-write-operations",
      "description": "TESTRAIL_ALLOW_WRITE_OPERATIONS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-allow-read-operations",
      "description": "TESTRAIL_ALLOW_READ_OPERATIONS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-allow-delete-operations",
      "description": "TESTRAIL_ALLOW_DELETE_OPERATIONS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-enable-deprecated-tools",
      "description": "TESTRAIL_ENABLE_DEPRECATED_TOOLS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "testrail-disabled-tools",
      "description": "TESTRAIL_DISABLED_TOOLS",
      "password": true
    }
  ],
  "servers": {
    "testrail-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@uarlouski/testrail-mcp-server"
      ],
      "env": {
        "TESTRAIL_INSTANCE_URL": "${input:testrail-instance-url}",
        "TESTRAIL_USERNAME": "${input:testrail-username}",
        "TESTRAIL_API_KEY": "${input:testrail-api-key}",
        "TESTRAIL_ENABLE_SHARED_STEPS": "${input:testrail-enable-shared-steps}",
        "TESTRAIL_ENABLE_CASE_HISTORY": "${input:testrail-enable-case-history}",
        "TESTRAIL_ENABLE_RAG_TOOLS": "${input:testrail-enable-rag-tools}",
        "TESTRAIL_ALLOW_WRITE_OPERATIONS": "${input:testrail-allow-write-operations}",
        "TESTRAIL_ALLOW_READ_OPERATIONS": "${input:testrail-allow-read-operations}",
        "TESTRAIL_ALLOW_DELETE_OPERATIONS": "${input:testrail-allow-delete-operations}",
        "TESTRAIL_ENABLE_DEPRECATED_TOOLS": "${input:testrail-enable-deprecated-tools}",
        "TESTRAIL_DISABLED_TOOLS": "${input:testrail-disabled-tools}"
      }
    }
  }
}

VS Code prompts for each input the first time the server starts, so no secret is written to the file. VS Code docs

testrail mcp server in other clients