Testrail
Connect to your TestRail instance to view and manage projects, test cases, and test runs. Generate project dashboards with metrics and analytics to track quality and progress. Streamline QA workflows by creating and organizing cases and runs directly from one place.
Installation
npx mcp-testrailAsk AI about Testrail
Powered by Claude · Grounded in docs
I know everything about Testrail. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
TestRail MCP Server
This Model Context Protocol (MCP) server provides tools for interacting with TestRail directly from Claude AI and other MCP-supported clients like Cursor. It allows you to manage test cases, projects, suites, runs, and more without leaving your conversation with the AI.
Available Tools
The TestRail MCP server provides the following tools:
| Category | Tools |
|---|---|
| Projects | getProjects, getProject |
| Suites | getSuites, getSuite, addSuite, updateSuite |
| Cases | getCase, getCases, addCase, updateCase, deleteCase, getCaseTypes, getCaseFields, copyToSection, moveToSection, getCaseHistory, updateCases, addBdd, getBdd |
| Sections | getSection, getSections, addSection, moveSection, updateSection, deleteSection |
| Runs | getRuns, getRun, addRun, updateRun |
| Tests | getTests, getTest |
| Results | getResults, getResultsForCase, getResultsForRun, addResultForCase, addResultsForCases |
| Plans | getPlans |
| Milestones | getMilestones |
| Shared Steps | getSharedSteps |
Usage
You can connect this MCP server by setting like the below. This method uses npx to automatically download and run the latest version of the package, eliminating the need for local installation.
// Example configuration using npx
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["@bun913/mcp-testrail@latest"],
"env": {
"TESTRAIL_URL": "https://your-instance.testrail.io", // Replace with your TestRail URL
"TESTRAIL_USERNAME": "your-email@example.com", // Replace with your TestRail username
"TESTRAIL_API_KEY": "YOUR_API_KEY" // Replace with your TestRail API key
}
}
}
}
Troubleshooting
-
spawn node ENOENTerrors: Ensure that Node.js is properly installed and in your PATH. -
Authentication issues: Check your TestRail API credentials.
-
Your conversation is too long: Use
limitandoffsetparameters for test cases and sections to paginate results. -
HTTP 400 errors when creating/updating test cases: TestRail projects have different templates, custom fields, and required fields. This MCP server passes your parameters directly to the TestRail API — it does not validate or transform them. If you encounter 400 errors, define your project's rules in
CLAUDE.mdorAGENTS.mdso the LLM sends the correct parameters. For example:# TestRail Rules for This Project - Project ID: 1 - Always use template 2 (Separated Steps) when creating test cases - Use `customStepsSeparated` (array of step objects) - Do NOT send `customSteps` or `customExpected` with template 2 - Required custom fields: custom_automation_type (default: 0) - Call `getCaseFields` at the start of a session to check available fields
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
