Zephyr Scale

by milo0821

Not rated
GitHub

About

Manage Zephyr Scale test cases through the Atlassian REST API.

Details

Author
milo0821
Categories
Productivity

Setup

Install Zephyr Scale in your MCP client (Claude Desktop, Cursor, Windsurf, and others).

Repository: https://github.com/milo0821/Zephyr_mcp_server

Follow the installation instructions in the repository README, then restart your MCP client.

Model Context Protocol server for Zephyr Scale test management, supporting bothJira Cloud and Data Center. Create, read, and manage test cases through the Atlassian REST API withofficial API-compliant schemas. Access live test case data, example payloads, and file resources through a unified resource system.

- ✅Jira Cloud & Data Center Support: Seamlessly connects to both Jira Cloud (using API v2) and self-hosted Data Center instances (using API v1) with automatic configuration detection.
- ✅Official API-Compliant Schemas: Tools and data structures match the official Zephyr Scale REST API, ensuring compatibility and reliability.
- ✅Unified Test Case Creation: A singlecreate_test_casetool handles all script types (BDD, Step-by-Step, Plain Text) for a simplified workflow.
- ✅Full Test Lifecycle Management: Comprehensive tools to create, read, delete test cases, and manage test runs, executions, and folders.
- ✅Live Templating System: Use real test cases from your Zephyr instance as templates (zephyr://testcase/KEY) to ensure consistency and correct project-specific fields.
- ✅Unified Resource System: Access live Zephyr data, local files (file://), and built-in examples through a consistent URI-based system.

You can run the server usingnpxwithout installation, or install it globally fromnpm.

Configure your MCP client with the following structure.

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

Note:JIRA_USERNAMEandJIRA_API_TOKENare optional but required if you want to use theissue_linksfield when creating test cases. Without them, issue linking will fail with a 401 warning (the test case is still created). Generate a Jira API token atid.atlassian.com/manage-profile/security/api-tokens.

{ "mcpServers": { "zephyr-server": { "command": "npx", "args": ["zephyr-scale-mcp-server@latest"], "env": { "ZEPHYR_BASE_URL": "https://your-company.atlassian.net", "ZEPHYR_API_KEY": "your-zephyr-api-key", "JIRA_USERNAME": "your-email@company.com", "JIRA_API_TOKEN": "your-jira-api-token", "ZEPHYR_API_BASE_URL": "https://eu.api.zephyrscale.smartbear.com/v2" } } } }
{ "mcpServers": { "zephyr-server": { "command": "npx", "args": ["zephyr-scale-mcp-server@latest"], "env": { "ZEPHYR_BASE_URL": "https://your-jira-server.com", "ZEPHYR_API_KEY": "your-api-token" } } } }

Then, update thecommandin your MCP configuration to"command": "zephyr-scale-mcp".

The latest version features aunifiedcreate_test_casetoolthat supports all test script types (STEP_BY_STEP, PLAIN_TEXT, and BDD) through a single, consistent interface. This matches the official Zephyr Scale REST API v1 structure exactly, simplifying the test creation process.

The server automatically detects your Jira environment and uses the appropriate API version:

- Jira Cloud: Uses Zephyr Scale API v2.
- Jira Data Center: Uses Zephyr Scale API v1.

Some tools are platform-specific. For example,add_test_cases_to_runis only available on Cloud, as the Data Center API (v1) does not support modifying test runs after creation.

The server provides access to various resources through URI schemes:

- zephyr://testcase/YOUR-TEST-CASE-KEY: Fetch real test case data from your Zephyr instance to use as templates.
- file:///absolute/path/to/your/file.json: Read user-provided files.
- zephyr://examples/...: Access built-in example payloads.

- get_test_case: Get detailed information about a specific test case.
- create_test_case: Create test cases with STEP_BY_STEP, PLAIN_TEXT, or BDD content.
- delete_test_case: Delete a specific test case.
- update_test_case_bdd: Update an existing test case with BDD content (optionally update the test case name).

- create_test_run: Create a new test run.
- get_test_run: Get detailed information about a specific test run, including resolved status name.
- update_test_run: Update an existing test cycle — set owner, name, description, dates, or status.(Cloud only)
- get_test_run_cases: Get test case keys from a test run.
- add_test_cases_to_run: Add test cases to an existing test run.(Cloud only)

- get_test_execution: Get detailed individual test execution results.
- list_executions_by_cycle: List all test executions for a specific test cycle with status, executor, and date.(Cloud only)
- search_test_cases_by_folder: Search for test cases in a specific folder. Automatically paginates through all results.
- search_test_runs: Search for test runs by project key and/or folder path.

- create_folder: Create a new folder in Zephyr Scale.
- get_folders: List folders, optionally filtered by project, type, and path. Whenfolder_pathis given, returns the matching folder and its full subtree at every depth.

{ "project_key": "PROJ", "name": "User Authentication", "test_script": { "type": "BDD", "text": "Given a user with valid credentials\nWhen the user attempts to log in\nThen the user should be authenticated successfully" }, "issue_links": ["PROJ-123", "PROJ-456"] }

Note:issue_linksrequiresJIRA_USERNAMEandJIRA_API_TOKENto be set (Cloud only). Link failures are reported as warnings — the test case is still created.
- Fetch an existing test case:zephyr://testcase/PROJ-T123
- Copy its structure (especiallycustomFieldsandfolder).
- Create a new test case using the same project-specific configuration.

{ "project_key": "PROJ", "name": "Sprint 1 Test Run", "test_case_keys": ["PROJ-T123", "PROJ-T124", "PROJ-T125"] }
{ "test_case_key": "PROJ-T123", "name": "Ensure the axial-flow pump is enabled", "bdd_content": "Feature: Pump Enablement\n\nScenario: Enable the pump\n Given the system is powered on\n When the operator enables the axial-flow pump\n Then the pump should report as enabled" }

Note: The server will convert markdown-style BDD into Gherkin when possible and will preserve all other existing test case fields.

*JIRA_USERNAME+JIRA_API_TOKEN: Required only for theissue_linksfeature on Cloud. The Zephyr API key cannot authenticate against the Jira REST API, so a separate Jira credential is needed to resolve issue keys to numeric IDs. Without these,issue_linkswill fail with a 401 warning — the test case is still created successfully.

The server automatically detects your Jira type based onZEPHYR_BASE_URL— URLs containing.atlassian.netare treated as Cloud, everything else as Data Center. Override withJIRA_TYPE="cloud"orJIRA_TYPE="datacenter".

The 1Password MCP server creates a bridge that allows MCP clients such as Codex and Kiro to manage your 1Password Environments with secure authorization prompts.

This is the 1st, easiest, and cheapest PPT, slides, presentation AI generation MCP Server in the world.

Persistent memory for any AI assistant. Zero token cost until recall. Stores memories in local SQLite, ranks by 6-factor scoring, returns results 79% smaller than JSON. Works with Claude, ChatGPT, Grok, Cursor, Windsurf, and any MCP client.

A MCP server that enables AI assistants to interact with Anki, the spaced repetition flashcard application.

Enables LLM clients to interact with macOS applications through AppleScript. Built using the @beyondbetter/bb-mcp-server library, this server provides safe, controlled execution of predefined scripts with optional support for arbitrary script execution.

An MCP server for WordPress plugin audits

Turn your AI assistant into a digital marketing hub that creates, organizes, and analyzes links and QR Codes on demand.

Connect AI clients to Cal.com scheduling through the Model Context Protocol using the hosted server at mcp.cal.com or a local instance.

Sync Calendars, Scheduling Links, AI Executive Scheduling Assistant, Unified Calendar

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.