Zephyr Scale MCP Server

This MCP server exposes tools to fetch:

• A Zephyr Scale test case by key
• Test steps (test script) for a Zephyr test case

It uses Zephyr Scale REST API v2 and requires only one environment variable:

• API_KEY - your Zephyr Scale API key

Endpoints used

• GET /v2/testcases/{testCaseKey}
• GET /v2/testcases/{testCaseKey}/testscript (primary)
• GET /v2/testcases/{testCaseKey}/teststeps (fallback when Zephyr returns the known 422 guidance error)

Available MCP tools

1. get_zephyr_test_case

   • Input: { "testCaseKey": "PROJECT-T1" }
   • Returns the full test case payload

2. get_zephyr_test_steps

   • Input: { "testCaseKey": "PROJECT-T1" }
   • Tries: https://api.zephyrscale.smartbear.com/v2/testcases/{testCaseKey}/testscript
   • If Zephyr returns 422 with the "use the other API" message, it automatically falls back to: https://api.zephyrscale.smartbear.com/v2/testcases/{testCaseKey}/teststeps

Install

npm install -g zephyr-mcp-server

Or use via npx:

API_KEY="your-zephyr-api-key" npx zephyr-mcp-server

Run locally

npm install
API_KEY="your-zephyr-api-key" npm start

Example MCP configuration

Using the globally installed binary:

{
  "mcpServers": {
    "zephyr-scale": {
      "command": "zephyr-mcp-server",
      "env": {
        "API_KEY": "your-zephyr-api-key"
      }
    }
  }
}

Using npx:

{
  "mcpServers": {
    "zephyr-scale": {
      "command": "npx",
      "args": ["zephyr-mcp-server"],
      "env": {
        "API_KEY": "your-zephyr-api-key"
      }
    }
  }
}