The Zebrunner MCP Server integrates with Zebrunner Test Case Management to enable QA teams, developers, and managers to comprehensively manage, analyze, and improve test cases through natural language commands via AI assistants.
Core Capabilities:
Test Case Management: Retrieve detailed test case information by key, title, or advanced filters (automation state, priority, dates), with support for batch operations and comprehensive pagination
Test Suite Organization: Navigate hierarchical test suite structures, get tree views with configurable depth, and identify root suites and subsuites
Quality Validation & Improvement: Validate test cases against 100+ checkpoints using a 3-tier intelligent rules system, receive AI-powered improvement suggestions, and apply automated fixes
Test Coverage & Code Generation: Analyze test case coverage against actual implementations, generate draft test code for multiple frameworks (Java/Carina, JavaScript/Jest, Python/Pytest), and perform enhanced rules-based coverage analysis
Duplicate Analysis: Identify similar test cases using both step-based similarity and advanced LLM-powered semantic analysis with detailed similarity matrices
Launch & Execution Management: Access comprehensive launch details, summaries, and test execution results with filtering by milestone, build number, or launch name
Reporting & Analytics: Platform-specific test results by time period, top bug analysis with issue links, project milestone tracking, and completion status
Configuration & Customization: Customizable rules system via Markdown files, multiple output formats (JSON, markdown, string, DTO), and clickable links to Zebrunner web UI
The server supports framework detection, intelligent validation, semantic analysis with LLM-powered clustering, and provides comprehensive test run management capabilities.
Supports Android platform test execution and results analysis through Zebrunner's test management system
Supports iOS platform test execution and results analysis through Zebrunner's test management system
Generates automated test code in JavaScript with frameworks like Jest based on test cases stored in Zebrunner
Generates Jest test code from Zebrunner test cases with intelligent framework detection and coverage analysis
Generates rich formatted reports and documentation from Zebrunner test data in Markdown format
Creates visual diagrams showing test suite hierarchies and test case relationships from Zebrunner data
Generates Python pytest code from Zebrunner test cases with automated framework detection
Generates automated test code in Python based on test cases and test execution data from Zebrunner
Generates Selenium WebDriver test automation code from Zebrunner test cases with coverage analysis
Zebrunner MCP Server
A Model Context Protocol (MCP) server that integrates with Zebrunner Test Case Management to help QA teams manage test cases, test suites, and test execution data through AI assistants like Claude.
๐ Need help with installation? Check out our Step-by-Step Install Guide for detailed setup instructions.
๐ Table of Contents
๐ฏ What is this tool?
This tool allows you to:
Retrieve test cases and test suites from Zebrunner
Analyze test coverage and generate test code
Get test execution results and launch details
Validate test case quality with automated checks using intelligent rules
Generate reports and insights from your test data
Improve test cases with AI-powered suggestions and automated fixes
All through natural language commands in AI assistants!
๐ง Intelligent Rules System
What Makes This Tool Special
Our MCP server includes a sophisticated 3-tier rules system that transforms how you work with test cases:
๐ฏ Test Case Review Rules (test_case_review_rules.md
)
Purpose: Core quality standards and writing guidelines
What it does: Defines fundamental principles for writing high-quality test cases
Key areas: Independence, single responsibility, comprehensive preconditions, complete step coverage
Used by:
validate_test_case
andimprove_test_case
tools
โ
Test Case Analysis Checkpoints (test_case_analysis_checkpoints.md
)
Purpose: Detailed validation checklist with 100+ checkpoints
What it does: Provides granular validation criteria for thorough test case analysis
Key areas: Structure validation, automation readiness, platform considerations, quality assurance
Used by:
validate_test_case
for comprehensive scoring and issue detection
โ๏ธ MCP Zebrunner Rules (mcp-zebrunner-rules.md
)
Purpose: Technical configuration for test generation and coverage analysis
What it does: Defines framework detection patterns, code templates, and coverage thresholds
Key areas: Framework detection, test generation templates, coverage thresholds, quality standards
Used by:
generate_draft_test_by_key
andget_enhanced_test_coverage_with_rules
tools
How the Rules Work Together
Why This Matters
Consistency: All team members follow the same quality standards
Automation: Reduce manual review time with automated validation
Learning: New team members learn best practices through AI feedback
Customization: Adapt rules to your project's specific needs
Continuous Improvement: AI suggests improvements based on proven patterns
Customizing Rules for Your Project
You can customize any of the three rules files:
Example customizations:
Mobile projects: Add mobile-specific validation rules
API projects: Focus on API testing patterns and data validation
Different frameworks: Customize code generation templates
Company standards: Align with your organization's testing guidelines
๐ Prerequisites
What you need to know
Basic command line usage (opening terminal, running commands)
Your Zebrunner credentials (login and API token)
Basic understanding of test management (test cases, test suites)
Software requirements
Node.js 18 or newer - Download here
npm (comes with Node.js)
Access to a Zebrunner instance with API credentials
How to check if you have Node.js
Open your terminal/command prompt and run:
If you see version numbers, you're ready to go!
๐ Quick Start Guide
๐ก Want more detailed instructions? Check out our More Detailed Step-by-step Install Guide with troubleshooting tips and platform-specific instructions.
Step 1: Get the code
Choose one of these methods:
Option A: Clone from repository (recommended)
Option B: Download and extract
Download the project files and extract them to a folder.
Step 2: Install dependencies
Step 3: Configure your Zebrunner connection
Create a .env
file in the project folder with your Zebrunner details:
How to get your Zebrunner API token:
Log into your Zebrunner instance
Go to your profile settings
Find the "API Access" section
Generate a new API token
Copy the token to your
.env
file
Step 4: Build the project
Step 5: Test your connection
If you see "โ Health check completed", you're ready to go!
๐ Updating to New Version
Check current version
Update steps
Important Notes:
โ Your for the health check to work
โ Restart Claude Desktop/Code after updating to reload the MCP server
โ Check release notes for any breaking changes before updating
If the health check fails, verify your .env
configuration and Zebrunner credentials.
๐ง Usage Methods
Method 1: Use with Claude Desktop/Code (Recommended)
Add this configuration to your Claude Desktop or Claude Code settings. Important: You must use the full absolute path to your project folder.
Example paths:
Windows:
C:\\Users\\YourName\\Projects\\mcp-zebrunner\\dist\\server.js
macOS/Linux:
/Users/YourName/Projects/mcp-zebrunner/dist/server.js
Alternative: Command Line Integration (Claude Code)
You can also add the server using the command line:
Important: Replace /full/absolute/path/to/mcp-zebrunner/
with the actual full path to your project folder.
Method 2: Run as standalone server
Development mode (with auto-reload)
Production mode
๐ ๏ธ Available Tools
Once connected, you can use these tools through natural language in your AI assistant. Here's a comprehensive reference of all 33+ available tools organized by category:
๐ Test Case Management
Core Test Case Tools
Tool | Description | Example Usage | Best For |
| Get detailed test case information |
| All roles |
| Advanced filtering with automation states, dates |
| QA, SDETs |
| Filter by specific automation states |
| SDETs, Managers |
| Search test cases by title (partial match) |
| All roles |
| Advanced filtering by suite, dates, priority, automation state |
| QA, Managers |
| List available automation states |
| All roles |
| List available priorities with IDs |
| All roles |
Batch Test Case Operations
Tool | Description | Example Usage | Best For |
| Get ALL test cases (handles pagination) |
| Managers, Leads |
| All test cases with hierarchy info |
| Analysts |
๐ณ Test Suite Hierarchy & Organization
Suite Management
Tool | Description | Example Usage | Best For |
| List suites with pagination |
| All roles |
| Hierarchical tree view |
| Managers, QA |
| Get top-level suites |
| Managers |
| Get all child suites |
| QA, Analysts |
Suite Analysis Tools
Tool | Description | Example Usage | Best For |
| Find specific suite by ID |
| All roles |
| Comprehensive suite listing |
| Managers |
| Find root suite for any suite |
| Analysts |
๐ Test Coverage & Analysis
Coverage Analysis
Tool | Description | Example Usage | Best For |
| Analyze implementation coverage |
| Developers, SDETs |
| Rules-based coverage analysis |
| SDETs, Leads |
Duplicate Analysis
Tool | Description | Example Usage | Best For |
| Find and group similar test cases by step similarity |
| QA Managers, SDETs |
| Advanced semantic analysis with LLM-powered step clustering |
| Senior QA, Test Architects |
๐ Clickable Links Feature: Both duplicate analysis tools support clickable links to Zebrunner web UI:
Add
include_clickable_links: true
to make test case keys clickable in markdown outputJSON/DTO formats automatically include
webUrl
fields when enabledLinks are generated from your
ZEBRUNNER_URL
environment variableExample:
"Analyze suite 17585 for duplicates with clickable links enabled"
๐งช Test Code Generation & Validation
AI-Powered Tools
Tool | Description | Example Usage | Best For |
| Generate test code with framework detection |
| SDETs, Developers |
| Quality validation with improvement |
| QA, Managers |
| Dedicated improvement tool |
| QA, SDETs |
๐ Launch & Execution Management
Launch Operations โญ Essential for Managers
Tool | Description | Example Usage | Best For |
| Comprehensive launch information |
| Managers, Leads |
| Quick launch overview |
| Managers |
| All launches with pagination |
| Managers, Leads |
| Filter by milestone/build |
| Managers, Leads |
๐ Reporting & Analytics
Platform & Results Analysis โญ Critical for Management
Tool | Description | Example Usage | Best For |
| Test results by platform/period |
| Managers, Leads |
| Most frequent defects |
| Managers, Developers |
| Available milestones |
| Managers, PMs |
Project Discovery
Tool | Description | Example Usage | Best For |
| Discover all accessible projects |
| All roles |
| Test API connectivity |
| All roles |
๐ Test Run Management
Public API Test Runs โญ Powerful for Analysis
Tool | Description | Example Usage | Best For |
| Advanced test run filtering |
| Managers, SDETs |
| Detailed test run information |
| Managers, QA |
| Test cases in a specific run |
| QA, Analysts |
Configuration Management
Tool | Description | Example Usage | Best For |
| Available result statuses |
| QA, SDETs |
| Configuration options |
| SDETs, Leads |
๐ฏ Management-Focused Quick Commands
๐ Daily Standup Reports
๐ Test Suite Optimization
๐ Weekly Management Reports
๐ฏ Milestone & Release Planning
๐ Issue Analysis & Troubleshooting
๐ญ Role-Specific Prompts & Workflows
๐ฉโ๐ป Manual QA Engineers
Daily Test Case Review
Test Case Creation & Improvement
Test Suite Organization
Coverage Analysis
๐ค Test Automation Engineers & SDETs
Automation Readiness Assessment
Test Code Generation
Coverage Analysis & Validation
Framework Integration
Batch Automation Analysis
๐จโ๐ป Developers
Test Case Understanding
Implementation Validation
Code Generation for Testing
Bug Analysis
๐ Test Managers & Team Leads
Team Quality Metrics
Test Suite Analysis
Team Performance & Planning
Process Improvement
Reporting & Stakeholder Communication
Daily Management Tasks
๐ข Project Owners & Product Managers
Project Health Overview
Feature Testing Status
Quality Assurance Metrics
Risk Assessment
Planning & Resource Allocation
Executive Reporting
๐ Output Formats
All tools support multiple output formats:
json
- Structured data (default)markdown
- Rich formatted output with sections and tablesstring
- Human-readable text summariesdto
- Raw data objects
Example:
โ๏ธ Configuration Options
Environment Variables
Rules System Configuration
The rules system automatically detects and uses rules files in your project root:
Automatic Detection
If you have a mcp-zebrunner-rules.md
file in your project root, the rules engine will automatically enable itself.
Custom Rules Files
You can customize the three types of rules:
Test Case Review Rules (
test_case_review_rules.md
)
Analysis Checkpoints (
test_case_analysis_checkpoints.md
)
Technical Rules (
mcp-zebrunner-rules.md
)
๐งช Testing Your Setup
Run health checks
Test API connection
Run full test suite
Run specific test types
๐ Troubleshooting
Common Issues
"Authentication failed" or 401 errors
โ Check your
ZEBRUNNER_LOGIN
andZEBRUNNER_TOKEN
โ Verify your API token is still valid
โ Ensure your user has proper permissions in Zebrunner
"Project not found" or 404 errors
โ Check the project key spelling (e.g., "MYAPP", not "myapp")
โ Verify you have access to the project in Zebrunner
โ Some endpoints may not be available on all Zebrunner instances
"Connection timeout" errors
โ Check your
ZEBRUNNER_URL
is correctโ Ensure your network can reach the Zebrunner instance
โ Try increasing timeout in configuration
MCP integration not working
โ Verify the path to
dist/server.js
is correctโ Check that the project built successfully (
npm run build
)โ Ensure environment variables are set in MCP configuration
โ Look at Claude Desktop/Code logs for error messages
Rules engine not working
โ Check that
ENABLE_RULES_ENGINE=true
in your.env
fileโ Verify rules files exist and have meaningful content
โ Restart the MCP server after changing rules files
โ Check debug logs for rules parsing errors
Debug Mode
Enable detailed logging to troubleshoot issues:
This will show:
API requests and responses
Error details and stack traces
Performance metrics
Feature availability
Rules parsing and validation details
Getting Help
Check the logs - Enable debug mode and look for error messages
Test your connection - Run
npm run test:health
Verify your configuration - Double-check your
.env
fileCheck Zebrunner permissions - Ensure your user has proper access
Validate rules files - Ensure rules files have meaningful content
๐ฏ Example Workflows
Workflow 1: Test Case Review (Manual QA)
Workflow 2: Test Automation (SDET)
Workflow 3: Implementation Validation (Developer)
Workflow 4: Quality Management (Team Lead)
Workflow 5: Project Health (Product Manager)
๐ง Advanced Features
Batch Operations
Process multiple test cases at once:
Custom Output Formats
Get data in the format you need:
Filtering and Search
Find exactly what you need:
Rules-Based Analysis
Leverage intelligent validation:
๐ Additional Documentation
๐ง Intelligent Rules System
docs/INTELLIGENT_RULES_SYSTEM.md - ๐ง Complete guide to the 3-tier intelligent rules system
docs/RULES_QUICK_REFERENCE.md - โก Quick reference for rules system commands and configuration
๐ Rules Files (Customizable)
test_case_review_rules.md - ๐ฏ Core quality standards and writing guidelines
test_case_analysis_checkpoints.md - โ 100+ detailed validation checkpoints
mcp-zebrunner-rules.md - โ๏ธ Technical configuration for test generation and coverage analysis
๐ ๏ธ Feature Documentation
docs/NEW_LAUNCHER_TOOL.md - Detailed information about launch and reporting tools
docs/SUITE_HIERARCHY.md - Complete guide to suite hierarchy features
docs/TEST_CASE_VALIDATION_IMPLEMENTATION.md - Test case validation system details
docs/ENHANCED_VALIDATION_FEATURES.md - Advanced validation and improvement features
๐ค Contributing
Fork the repository
Create a feature branch
Make your changes with appropriate tests
Ensure all tests pass:
npm test
Submit a pull request
๐ License
MIT License - see LICENSE file for details.
๐ You're Ready!
Once you've completed the setup:
Test your connection with
npm run test:health
Configure your AI assistant with the MCP server
Start asking questions about your test cases!
Example first commands to try:
"List test suites for project [YOUR_PROJECT_KEY]"
"Get test case [YOUR_TEST_CASE_KEY] details"
"Validate test case [YOUR_TEST_CASE_KEY]"
"Show me the test suite hierarchy"
The intelligent rules system will help ensure your test cases meet quality standards and are ready for both manual execution and automation. Happy testing! ๐
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Integrates with Zebrunner Test Case Management to help QA teams manage test cases, test suites, and test execution data through AI assistants. Features intelligent validation, automated test code generation, and comprehensive reporting capabilities.
- ๐ Table of Contents
- ๐ฏ What is this tool?
- ๐ง Intelligent Rules System
- ๐ Prerequisites
- ๐ Quick Start Guide
- ๐ Updating to New Version
- ๐ง Usage Methods
- ๐ ๏ธ Available Tools
- ๐ฏ Management-Focused Quick Commands
- ๐ญ Role-Specific Prompts & Workflows
- ๐ Output Formats
- โ๏ธ Configuration Options
- ๐งช Testing Your Setup
- ๐ Troubleshooting
- ๐ฏ Example Workflows
- ๐ง Advanced Features
- ๐ Additional Documentation
- ๐ค Contributing
- ๐ License
- ๐ You're Ready!