Home - skindyk/testrail-mcp-server GitHub Wiki

Welcome to the comprehensive documentation for the TestRail MCP Server! This wiki provides detailed guides, examples, and best practices for using the server effectively.

🚀 Quick Start

New to TestRail MCP Server? Start here:

1. Installation & Setup - Get up and running quickly
2. Basic Configuration - Connect MCP Client to your TestRail instance
3. Available Tools - Explore what you can do

📖 Core Documentation

Essential Guides

• Available Tools - Complete reference of all 119 tools
• Field Filtering Guide - Optimize performance for large datasets
• Tool Limiting - Available tools list control

Usage Examples

• Natural Language Commands - Real-world conversation examples
• Common Workflows - Step-by-step guides for typical tasks
• Advanced Features - Enterprise capabilities and integrations

🎯 Use Cases

By Role

• Test Managers - Project planning, reporting, and team coordination
• Test Engineers - Test case creation, execution, and result tracking
• Developers - BDD integration, automated testing, and CI/CD workflows
• Stakeholders - Read-only access for progress monitoring

By Feature

• Test Case Management - Create, organize, and maintain test cases
• Test Execution - Run tests and track results across environments
• Test Planning - Coordinate complex testing initiatives
• Reporting & Analytics - Generate insights and track progress

🆕 What's New

Recent Updates

• Prompts System - Two-tier prompts system that combines built-in default prompts with user-created custom prompts
• Field Filtering - Reduce response size by 80-95% for large datasets
• Enhanced Tool Control - Granular access control with MCP_TOOLS
• Performance Improvements - Optimized for large TestRail instances
• Complete API Coverage - 119 tools covering all TestRail endpoints