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.
📑 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
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!
🔧 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 |
| List available automation states |
| 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 |
🧪 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
📊 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! 🚀
This server cannot be installed
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.
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
- 🔧 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!