
Advanced Zebrunner MCP Server
io.github.maksimsarychau由 GitHub 帳號 maksimsarychau 發布v9.2.1更新於 Oct 27, 2026
Advanced analytics, reporting, and safe mutations for Zebrunner. 64 tools, 14 resources, 17 prompts.
概覽
本機 MCP 伺服器,讓助理讀取、分析、驗證並安全修改 Zebrunner 的測試案例、測試套件、執行批次與報告。
- 可以做什麼
- 瀏覽與篩選測試案例、測試套件及套件階層,支援批次取得與依自動化狀態、優先級查詢
- 分析執行批次與失敗案例、覆蓋率、重複案例,並依貼上的 Zebrunner 連結進行測試影響分析
- 透過規則引擎驗證並改善測試案例品質,並依框架辨識產生測試程式碼草稿
- 在「先預覽、後確認」的兩段式機制下建立與更新測試套件及測試案例,並寫入稽核日誌
- 產生報告與儀表板,並回答該使用哪個工具的路由問題
- 適用情境
- 適合在 Zebrunner 中維護測試案例與自動化執行批次的 QA 工程師、SDET 與測試管理者,希望助理在對話中排查失敗、檢查覆蓋率或重複案例,並起草或整理測試案例。
- 執行需求
- 需在本機執行,要求 Node.js 18 或更新版本及 npm,可從 npm 套件或程式碼倉庫安裝。需要可連線的 Zebrunner 執行個體,並以環境變數提供 ZEBRUNNER_URL、ZEBRUNNER_LOGIN 與 ZEBRUNNER_TOKEN API 權杖。需能連線至 Zebrunner API 的網路。
安裝
在 SourceWeft 中
- 開啟 儀表板中的 Advanced Zebrunner MCP Server,將其新增到工作區。
- 為需要使用其工具的對話啟用該服務。
Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。
其他 MCP 客戶端
參照 儲存庫 中的啟動說明。
README
Advanced Zebrunner MCP Server
A Model Context Protocol (MCP) server that brings advanced analytics, reporting, failure forensics, and safe TCM mutations to Zebrunner. Designed to coexist with the official Zebrunner MCP (beta) — see the "Dual-MCP setup" section below.
Tool naming: every tool on this server is registered under the canonical
adv_<name>form (e.g.adv_create_test_case,adv_list_test_runs) so it never collides with the official Zebrunner MCP. The legacy names are kept as deprecated aliases so prompts/scripts that called the old names continue to work for now; aliases will be removed in the next major release.
🆕 v9.4.4 — Test-run metadata agent UX: post-mutation steering hints (discover env/config before update; import does not set badges); dual-MCP routing resource for environments vs Build/Platform; richer tool-intel for
adv_manage_test_run. Builds on v9.4.3 env contract — see change-logs.md.v9.4.3 —
adv_prepare_jira_automation_plan+/jira-automation-planprompt: Zebrunner suite → structured Jira plan;adv_manage_test_runPublic APIenvironmentas{ name }/{ id }. See change-logs.md, TEST_PROMPTS.md §20.v9.3.1 — TCM pagination fixes: correct
get_alltoken walks,root_suite_idsubtree scoping, honest bulk metadata. See PUBLIC_API_PAGINATION.md and change-logs.md.v9.3.0 — Multi-PR / period test impact:
change_batches[],/test-impact-period, extended/test-impact. See TEST_IMPACT_WORKFLOW.md and TEST_IMPACT_PR_PERIOD_DESIGN.md.🆕 v9.2.7 — New
adv_scaffold_test_casewizard (hybrid form/conversational) to author test cases from best practices with an automatic warn-only similar-case check, plus optionalprojectAliasesinzebrunner-config.jsonso tools accept short names as well as Zebrunner project keys. See release notes.🆕 v9.2.5 —
adv_get_test_authoring_trend(TAM template 7) completes 22/22 dashboard widget MCP coverage. Hub tools, pass-rate views, period modes. See TEST_PROMPTS.md §18 and change-logs.md.
v9.2.1 — LLM-visible metrics (
include_call_metrics, session breakdown), compact expansion (+19 tools), format/truncation bugfixes. See Token efficiency guide and change-logs.md.
v9.2.0 — Opt-in token/cost optimizations:
format:'compact',detail:'summary',adv_batch_get_test_cases, reportinline:false. Defaults unchanged. See change-logs.md.
v9.1.0 — Launch mutations:
adv_rerun_launch_failures,adv_start_launch(Jenkins Build Now), plus/relaunch-regression-failuresand/feature-scoped-launchprompts. See GitHub Release v9.1.0.📖 Need help with installation? Check out our Step-by-Step Install Guide for detailed setup instructions.
🚀 Installing via npm? See our MCP NPM Installation Guide for Claude Desktop, Cursor, IntelliJ IDEA, and ChatGPT Desktop configuration.
📚 Test vs Test Case vs Launch? See Terminology & Glossary — definitions, counting rules, and how metrics are calculated.
🔥 Why This Server
This is the Advanced Zebrunner MCP Server — built to go well beyond basic test case management and help QA teams work smarter and faster with AI. Compared to the official Zebrunner MCP (beta, ~70 tools spanning Public REST + Reporting/TAM/Launcher), this server provides 76 registered adv_* tools (70 inline-regression suite + 6 handler-module tools; see tools.json) and is safe to run side-by-side with the official server:
- Reporting & Analytics — dashboards, pass-rate trends, regression stability reports, runtime efficiency analysis, bug reviews, and weekly delta tracking
- Test Coverage & Analysis — coverage gaps, automation readiness scoring, and cross-suite analysis
- Intelligent Rules System — 3-tier quality rules with 100+ automated checkpoints for test case validation and improvement
- Screenshot & Video Analysis — OCR, image processing, and video analysis powered by sharp, ffmpeg, and tesseract
- MCP Resources & Prompts —
@context injection and/workflow commands for streamlined daily operations - Multi-Transport & Multi-Auth — STDIO, Streamable HTTP, self-service OAuth, Okta SSO, and token exchange (Modes 1–5)
📑 Table of Contents
- 3.1. What Makes This Tool Special
- 3.2. How the Rules Work Together
- 3.3. Why This Matters
- 3.4. Customizing Rules for Your Project
- 6.1. Method 1: Use with Claude Desktop/Code
- 6.2. Method 2: Run as standalone server
- 6.3. Method 3: Smart URL-Based Analysis 🚀
- 7.1. 📋 Test Case Management
- 7.2. 🌳 Test Suite Hierarchy & Organization
- 7.3. 🔧 Mutation Tools
- 7.4. 🔍 Test Coverage & Analysis
- 7.5. 🧪 Test Code Generation & Validation
- 7.6. 🚀 Launch & Execution Management
- 7.7. 📊 Reporting & Analytics
- 7.8. 🏃 Test Run Management
- 7.9. 🎯 Management-Focused Quick Commands
- 8.1. Resources —
@Context Injection - 8.2. Prompts —
/Workflow Commands
- 9.1. 👩💻 Manual QA Engineers
- 9.2. 🤖 Test Automation Engineers & SDETs
- 9.3. 👨💻 Developers
- 9.4. 👔 Test Managers & Team Leads
- 9.5. 🏢 Project Owners & Product Managers
- 📖 Output Formats
- ⚙️ Configuration Options
- 🧪 Testing Your Setup
- 🔍 Troubleshooting
- 🎯 Example Workflows
- 🔧 Advanced Features
- 📚 Additional Documentation
- 🤝 Contributing
- 📄 License
- 🎉 You're Ready!
🎯 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:
adv_validate_test_caseandadv_improve_test_casetools
✅ 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:
adv_validate_test_casefor 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:
adv_generate_draft_test_by_keyandadv_get_enhanced_test_coverage_with_rulestools
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
.envfile
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
.envfile must be properly configured 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
Method 3: Smart URL-Based Analysis 🚀
NEW in v5.4.1+: Claude can automatically detect Zebrunner URLs and analyze them with optimal settings!
Just paste a Zebrunner URL in your conversation, and Claude will automatically:
- Parse the URL to extract project, launch, and test IDs
- Call the appropriate analysis tool
- Use recommended settings (videos, screenshots, AI analysis enabled)
📋 Supported URL Patterns
1. Test Analysis URLs
What happens:
- Claude automatically calls
adv_analyze_test_failure - Extracts:
projectKey,testRunId(launch ID),testId - Enables:
includeVideo: true,analyzeScreenshotsWithAI: true, all diagnostics
Example:
2. Launch Analysis URLs
What happens:
- Claude automatically calls
adv_detailed_analyze_launch_failures - Extracts:
projectKey,testRunId(launch ID) - Enables:
includeScreenshotAnalysis: true, comprehensive analysis
Example:
✨ Advanced Usage
Override Default Settings
Claude understands natural language overrides:
Multiple URLs
Analyze multiple tests/launches in one request:
Cross-Workspace Support
⚠️ URLs from different workspaces will show a warning but still attempt analysis:
📖 URL Pattern Reference
🎯 Why Use URL-Based Analysis?
✅ Faster: No need to manually specify IDs
✅ Convenient: Copy-paste URLs directly from Zebrunner UI
✅ Optimized: Automatic use of recommended settings
✅ Smart: Claude detects intent and adjusts parameters
✅ Flexible: Natural language overrides work seamlessly
💡 Pro Tips
- Direct from Zebrunner: Copy URL directly from your browser while viewing a test/launch
- Batch Analysis: Paste multiple URLs separated by newlines
- Custom Settings: Add natural language instructions to override defaults
- Quick Checks: URLs work great for quick "what happened here?" questions
- Reports: Combine with format requests: "Generate JIRA ticket for https://...url..."
🤝 Dual-MCP setup (official zebrunner + Advanced)
Zebrunner now offers an official hosted MCP (beta) at
https://{workspace}.zebrunner.com/api/mcp. It is safe to run both servers
in the same Cursor / Claude session: every tool on this server is exposed under
the adv_<name> prefix, so it never collides with the official tools.
Example .cursor/mcp.json:
Rule of thumb when both are connected:
Inside chat, ask adv_about_mcp_tools with mode: "routing" or open the
zebrunner://mcp-routing resource for the full live-generated diff and routing table.
🛠️ Available Tools
Once connected, you can use these tools through natural language in your AI assistant. This section highlights all 76 adv_* tools (see tools.json) organized by category. For the complete catalog with natural-language examples for every tool, see TOOLS_CATALOG.md.
Dashboard widgets: All 22 Zebrunner dashboard templates have MCP coverage (v9.2.5). See docs/TEST_PROMPTS.md §18 for example prompts and npm run test:api verification.
Token-efficient reads
Large TCM exports can consume significant context. Use these opt-in parameters (defaults stay backward-compatible). Full guide: docs/TOKEN_EFFICIENCY.md.
Workflow: list/filter with detail:'summary' + format:'compact' → adv_get_test_case_by_key for full body (steps, preconditions) before create/update.
Example prompts for your assistant:
- "List test cases in project MCP with summary detail and compact JSON."
- "Fetch MCP-1 and MCP-2 in one batch call with summary and compact format."
- "Generate a quality dashboard for MCP with inline false — save to disk."
Tool naming: All tools are exposed as
adv_<name>(e.g.adv_get_test_case_by_key). Use these names in prompts, scripts, and when both the official and Advanced MCP are connected. Legacy short names (get_test_case_by_key, etc.) are deprecated and only registered whenZEBRUNNER_REGISTER_LEGACY_ALIASES=true.
📋 Test Case Management
Core Test Case Tools
Batch Test Case Operations
Test Case Change History
Most test case tools support optional change history enrichment — fetching the audit log of modifications for each test case. This is useful for understanding when steps were changed, when automation state transitioned, or when a test case was deprecated.
Supported on: adv_get_test_case_by_key, adv_get_test_cases_advanced, adv_get_test_cases_by_automation_state, adv_get_test_case_by_title, adv_get_test_case_by_filter, adv_get_all_tcm_test_cases_by_project, adv_get_test_cases_by_suite_smart
Example prompts:
"Get test case MCP-29 with change history"→ setsinclude_history=true"Show me MCP-29 history, events only"→ setsinclude_history=true,history_filter='events_only'"Get all automated test cases with their last 5 changes"→ setsinclude_history=true,history_limit=5
Detected events: became_automated, became_manual, became_deprecated, became_undeprecated, steps_changed, preconditions_changed, postconditions_changed, and dynamically generated became_<state_name> for any project-specific automation state.
🌳 Test Suite Hierarchy & Organization
Suite Management
Suite Analysis Tools
🔧 Mutation Tools
Safety Model: Every mutation tool follows a two-call confirmation gate. The first call returns a preview; only after user approval should
confirm: truebe passed to execute the mutation. All mutations are audit-logged to~/.mcp-zebrunner-audit.jsonl. Usedry_run: truefor raw payload inspection.Next-step steering (v7.2.2): After every successful mutation, the server appends a
Tip:block guiding the LLM to the most useful next action (e.g., "validate quality", "publish the draft", "populate the test run"). Hints are conditional -- they are suppressed when redundant. For example, the quality-check hint is omitted ifreview: truewas already used. Created test cases are always forced todraft=true, and the hint always reminds the LLM to publish viaadv_update_test_case. This approach is inspired by the Strands Agents steering pattern and delivers just-in-time guidance without bloating system prompts.
Suite Mutations
Test Case Mutations
🔍 Test Coverage & Analysis
Test Impact (PR / code changes) (v9.2.8)
Use the /test-impact MCP prompt (optional pr_url) for guided workflow. See TEST_IMPACT_WORKFLOW.md. Configure repositoryProjectMap via .env.example.
Coverage Analysis
Duplicate Analysis
🔗 Clickable Links Feature: Both duplicate analysis tools support clickable links to Zebrunner web UI:
- Add
include_clickable_links: trueto make test case keys clickable in markdown output - JSON/DTO formats automatically include
webUrlfields when enabled - Links are generated from your
ZEBRUNNER_URLenvironment variable - Example:
"Analyze suite 17585 for duplicates with clickable links enabled"
🧪 Test Code Generation & Validation
AI-Powered Tools
🚀 Launch & Execution Management
Launch Operations ⭐ Essential for Managers
adv_analyze_regression_runtime— Usage Examples:
- "Analyze regression runtime for the iOS project on the latest milestone. Show both average runtime per test and per test case, plus WRI and WRI per test case."
- "Run regression runtime analysis for all three projects on their latest milestones. Compare how many test cases fall into Short vs Medium vs Long buckets per team."
- "Analyze regression runtime for the Android project, latest vs previous milestone. Show WRI and WRI per test case for both. Has efficiency improved or degraded?"
- "Analyze regression runtime with medium_threshold_seconds: 120 and long_threshold_seconds: 300. Show which tests fall into each bucket."
- "What is the average time cost per test case in each duration bucket? Are long-running tests covering proportionally more test cases?"
📊 Reporting & Analytics
Test Failure Analysis 🆕 Game Changer
✅ FIXED in v5.2.4! Improved Reliability & Video Links
- 🎥 Video URLs fixed: Now uses test-sessions API (
/api/reporting/v1/launches/{id}/test-sessions) for reliable video artifact extraction- 🛡️ Comprehensive error handling: Gracefully handles missing screenshots/logs (returns empty arrays instead of throwing)
- 🚫 No more "no result received" errors: All API calls have proper try-catch blocks with fallbacks
- 🐛 Better debugging: Enhanced logging when
debug: trueis enabled in config- 📊 Schema updates: Supports both old and new API structures for backward compatibility
🎫 NEW in v4.12.1! Jira-Ready Ticket Format
- Use
format: 'jira'to generate ready-to-paste Jira tickets- Auto-calculated priority based on stability and impact
- Smart labels:
test-automation,locator-issue,flaky-test, etc.- Complete Jira markup: Tables, panels, code blocks, clickable links
- 🎥 Prominent video links: Beautiful panels + links section
- Copy-paste ready: No manual formatting needed
- Saves 5-10 minutes per ticket with consistent quality
🧠 Enhanced in v4.11.1!
adv_detailed_analyze_launch_failuresprovides automatic deep synthesis like Claude would manually provide:
- 🎯 Executive Summary: Key findings, patterns, and stability indicators
- 📅 Timeline Analysis: When failures first appeared, progression tracking
- 🔬 Pattern Analysis: Groups by root cause with affected tests and stability %
- 🎯 Priority-Based Recommendations: 🔴 HIGH / 🟡 MEDIUM / 🟢 LOW with impact analysis
- 📋 Enhanced Test Details: Full error messages, stack traces, timestamps
- ❓ Smart Follow-up Questions: Guides next investigation steps
- Smart filtering: Analyzes only tests WITHOUT linked issues by default
- Optional AI screenshot analysis for all tests
- No manual follow-up needed - get complete picture in one call!
🆕 NEW in v5.11.0! Test Execution History & Comparison
- 📊 Track execution trends: View pass/fail history across launches with
adv_get_test_execution_history- 🔄 Compare with last passed: New
compareWithLastPassedparameter inadv_analyze_test_failure
- Compare logs (new errors detection)
- Compare duration (performance regression)
- Compare environment (device/platform changes)
- Compare screenshots (visual differences)
- ⚠️ Critical detection: Automatically highlights when test failed in all recent executions
- 🎯 Regression analysis: See exactly what changed between passed and failed runs
- 📈 Pass rate metrics: Calculate test stability over time
- See TOOLS_CATALOG.md for example prompts!
Screenshot Analysis & Visual Forensics 🎯 Enhanced in v4.11.0
📸 Enhanced! Screenshot analysis now integrated directly into
adv_analyze_test_failureandanalyze_launch_failures- no need to call separately! See Screenshot Analysis Guide for details.
Platform & Results Analysis ⭐ Critical for Management
Period behavior for reporting widgets: period is passed to Zebrunner widgets as-is (for example Today, Month, Last 30 Days). If a selected widget does not support a specific period label, the API will return an error.
Project Discovery
🏃 Test Run Management
Public API Test Runs ⭐ Powerful for Analysis
Configuration Management
📎 MCP Resources & Prompts (NEW)
Full guide: docs/RESOURCES_AND_PROMPTS.md — detailed usage, examples, reference tables, and contributor guide.
In addition to tools, the server provides 15 resources and 22 MCP prompts (/pass-rate, /jira-automation-plan, etc.) that improve discoverability and automate complex workflows.
Resources — @ Context Injection
Resources are read-only reference data you attach to your conversation via the @ menu. They help the AI use exact parameter values instead of guessing.
Quick example:
Prompts — / Workflow Commands
Prompts are pre-built workflow instructions triggered via the / command menu. Each prompt guides the AI through a tested multi-tool orchestration.
Quick example:
🎯 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
Instance Configuration File (zebrunner-config.json)
The MCP server ships with a zebrunner-config.json in the project root that contains instance-specific settings. Customize this file to adapt the server to your Zebrunner workspace. If the file is missing or contains invalid values, built-in defaults are used automatically.
Individual keys can be omitted — only the keys you include will override the defaults.
Project-specific automation rules (localeTestRunRules & relaunchFailures)
These optional blocks configure launch mutation workflows per project. They do not affect read-only tools, TCM tools, or projects outside the configured scope.
localeTestRunRules — adv_start_launch (Jenkins Build Now) when the effective locale is not en_US:
relaunchFailures — /relaunch-regression-failures prompt and batch rerun guidance:
/feature-scoped-launch does not use zebrunner-config.json for Jenkins suite_path — the prompt resolves it from args, recent launches, or by asking the user.
Examples
CUSTOMER-style deployment (shipped defaults in repo zebrunner-config.json):
Generic / non-CUSTOMER deployment (e.g. only project MCP for demos, no locale exclusions):
Minimal override via env (Docker/K8s without mounting the file):
See also: docs/RESOURCES_AND_PROMPTS.md for how prompts and tools consume these settings.
Per-User Zebrunner URL (v8.1.0+)
When running in HTTP mode with MCP_AUTH_MODE=selfauth and without setting ZEBRUNNER_URL, each user provides their own Zebrunner instance URL on the login form. This enables multi-tenant hosting where a single MCP server serves users across different Zebrunner organizations.
- Login form shows a Zebrunner URL field (e.g.,
https://mcp.zebrunner.com) - Users can update their URL, credentials, or disconnect at
/settings - Per-user URLs are stored encrypted alongside credentials in the token store
- When
ZEBRUNNER_URLIS set as an environment variable, the URL field is hidden and the env value is used globally (existing behavior, no change)
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_LOGINandZEBRUNNER_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_URLis correct - ✅ Ensure your network can reach the Zebrunner instance
- ✅ Try increasing timeout in configuration
MCP integration not working
- ✅ Verify the path to
dist/server.jsis 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
adv_about_mcp_tools shows "Total tools: 0"
- ✅ Upgrade to v9.2.9+ (embeds tool catalog in
dist/for npm/Docker installs) - ✅ Rebuild after upgrade:
npm run build(git clone) or reinstall the package / pull the Docker image
Rules engine not working
- ✅ Check that
ENABLE_RULES_ENGINE=truein your.envfile - ✅ 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
.envfile - Check Zebrunner permissions - Ensure your user has proper access
- Validate rules files - Ensure rules files have meaningful content
- Report issues - If you find a bug, please open an issue at https://github.com/maksimsarychau/mcp-zebrunner/issues
🎯 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
📖 Tool References
- TOOLS_CATALOG.md - Complete catalog of all 76
adv_*tools with natural language examples - docs/TEST_PROMPTS.md - Test prompts per tool; §18 covers all 22 dashboard widgets (MCP + API verify)
- docs/archive/TCM_TAM_WIDGET_BACKLOG.md - Archived widget template ↔ MCP matrix (live: TEST_PROMPTS §18)
- docs/RESOURCES_AND_PROMPTS.md - MCP Resources & Prompts — full usage guide, reference tables, and contributor guide
- INSTALL-GUIDE.md - 📥 Step-by-step installation and setup guide
🧠 Intelligent Rules System
- docs/INTELLIGENT_RULES_SYSTEM.md - 🧠 Complete guide to the 3-tier intelligent rules system
- docs/archive/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
🔍 Specialized Guides
- docs/archive/SCREENSHOT_ANALYSIS.md - 📸 Screenshot download and visual analysis guide
- change-logs.md - 📝 Version history and feature updates
- GitHub Release v9.1.0 - 🆕 v9.1.0 release notes — launch mutations, prompts, and config
🛠️ Feature Documentation
- docs/TERMINOLOGY.md - 📖 Test vs Test Case vs Test Run vs Launch — glossary and counting rules
- docs/archive/NEW_LAUNCHER_TOOL.md - Detailed information about launch and reporting tools
- docs/archive/SUITE_HIERARCHY.md - Complete guide to suite hierarchy features
- docs/archive/TEST_CASE_VALIDATION_IMPLEMENTATION.md - Test case validation system details
- docs/archive/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
License
This project is licensed under AGPL-3.0 to ensure that all improvements to the MCP server remain open-source, especially when the software is deployed as a network service.
If you modify and run the server in a way that users interact with it over a network (e.g., Claude Desktop / Cursor clients), you must make the full modified source code available to those users.
Commercial usage is allowed. For closed-source modifications or enterprise licensing, please contact the author. See LICENSE.md 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! 🚀
First push was: Mon Sep 22 00:54:41 2025 +0200
來源:README.md,提交 c7ae2a9
工具
0版本歷史
1- v9.2.1最新Sep 16, 2026
評分
已滿足適用檢查項的 50%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
- 近 30 天內可連通25 分
請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。
- 已宣告認證方式10 分
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
- 已列出工具15 分
請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。
- 描述必需15 分
- 圖示10 分
- 文件15 分
- 授權條款10 分