Package Exports

zephyr-scale-mcp-server
zephyr-scale-mcp-server/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zephyr-scale-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Zephyr Scale MCP Server

Model Context Protocol server for Zephyr Scale test management. Create, read, and manage test cases through the Atlassian REST API.

Quick Start

Option 1: Using npx (Recommended - No installation required)

Just configure your MCP client with the npx command below.

Option 2: Install from npm

npm install -g zephyr-scale-mcp-server

MCP Configuration

Option 1: Using npx (Recommended - No installation required)

{
  "mcpServers": {
    "zephyr-server": {
      "command": "npx",
      "args": ["zephyr-scale-mcp-server@latest"],
      "env": {
        "ZEPHYR_API_KEY": "your-api-token",
        "ZEPHYR_BASE_URL": "https://your-company.atlassian.net"
      }
    }
  }
}

Option 2: Using global npm installation

First install the package globally:

npm install -g zephyr-scale-mcp-server

Then configure:

{
  "mcpServers": {
    "zephyr-server": {
      "command": "zephyr-scale-mcp",
      "env": {
        "ZEPHYR_API_KEY": "your-api-token",
        "ZEPHYR_BASE_URL": "https://your-company.atlassian.net"
      }
    }
  }
}

Available Tools

Test Case Management

get_test_case - Get detailed information about a specific test case
create_test_case - Create a new test case with STEP_BY_STEP or PLAIN_TEXT content
create_test_case_with_bdd - Create a new test case with BDD content
update_test_case_bdd - Update an existing test case with BDD content
delete_test_case - Delete a specific test case

Test Run Management

create_test_run - Create a new test run
get_test_run - Get detailed information about a specific test run
get_test_run_cases - Get test case keys from a test run

Test Execution

get_test_execution - Get detailed individual test execution results including step-by-step results, timestamps, comments, and attachments

Organization

create_folder - Create a new folder in Zephyr Scale

Examples

Simple Test Case

{
  "project_key": "PROJ",
  "name": "Login Test"
}

Step-by-Step Test Case

{
  "project_key": "PROJ",
  "name": "User Login Flow",
  "test_script_type": "STEP_BY_STEP",
  "steps": [
    {
      "description": "Navigate to login page",
      "testData": "URL: https://app.example.com/login",
      "expectedResult": "Login form is displayed"
    }
  ]
}

BDD Test Case

{
  "project_key": "PROJ",
  "name": "User Authentication",
  "bdd_content": "**Given** a user with valid credentials\n**When** the user attempts to log in\n**Then** the user should be authenticated successfully"
}

Delete Test Case

{
  "test_case_key": "PROJ-T123"
}

Create Test Run

{
  "project_key": "PROJ",
  "name": "Sprint 1 Test Run",
  "test_case_keys": ["PROJ-T123", "PROJ-T124", "PROJ-T125"],
  "environment": "Production",
  "description": "Testing core functionality for Sprint 1"
}

Get Test Run

{
  "test_run_key": "PROJ-R456"
}

Get Test Execution

{
  "execution_id": "5805255"
}

Authentication

Get your API token from:

Atlassian account settings
Security → API tokens
Create new token for Zephyr Scale

License

MIT