TestRail MCP Server
Servidor MCP nativo de IA que conecta Claude, Cursor, Windsurf e outros assistentes de IA ao TestRail — gerencie casos de teste, execuções e resultados por meio de conversas em linguagem natural, com esquemas tipados criados para LLMs.
Documentação
🚀 TestRail MCP Server
Um servidor de código aberto do Model Context Protocol (MCP) que conecta Claude, Cursor, Windsurf e outros assistentes de IA diretamente ao TestRail.
Gerencie projetos do TestRail, pesquise e crie casos de teste, inicie execuções de teste, registre resultados e anexe arquivos — tudo por meio de conversas em linguagem natural com seu assistente de IA. Desenvolvido para engenheiros de QA e automação de testes assistida por IA.
Compatível com:
🌟 Por que escolher o TestRail MCP Server?
Gerenciar casos de teste manualmente é tedioso e propenso a erros. Com o TestRail MCP Server, seu assistente de IA (seja Claude, Cursor, Windsurf ou qualquer cliente compatível com MCP) interage diretamente com sua instância do TestRail. Instrua-o a encontrar casos de teste, redigir novos, iniciar execuções de teste e registrar resultados de teste — tudo por meio de conversa natural.
Sem alternância de contexto. Sem copiar e colar tedioso. Basta perguntar à sua IA.
[!NOTE] Linha de base de compatibilidade: A versão de linha de base principal na qual este servidor MCP é testado e validado é TestRail 10.6.2 (API v2). Instâncias mais antigas do TestRail (incluindo paginação pré-7.x) também são suportadas por meio de compatibilidade retroativa integrada.
✨ Principais Recursos e Capacidades
| Capacidade | Descrição |
|---|---|
| 🔍 Descoberta Inteligente | Navegue por projetos, suítes de teste e seções para mapear automaticamente sua organização de QA. |
| 📋 Gerenciamento Completo de Casos | Busque, crie, atualize e edite em massa casos de teste com suporte abrangente a campos personalizados. |
| ▶️ Execução Acionável | Crie execuções de teste, atualize resultados por test_id ou case_id, anexe arquivos e acompanhe status. |
| 🧠 IA Sensível ao Contexto | Expõe dinamicamente modelos, campos, prioridades e status para que LLMs gerem dados estruturados e válidos. |
🚀 Guia de Início Rápido
1. Obtenha Sua Chave de API do TestRail
Navegue até My Settings → API Keys na sua plataforma TestRail e gere uma nova chave para autenticação.
2. Configure Seu Cliente MCP
Adicione o servidor à configuração do seu cliente MCP escolhido. O exemplo do Claude Desktop é mostrado abaixo; Cursor, Windsurf e outros clientes usam o mesmo padrão (veja as seções recolhíveis mais abaixo).
🤖 Claude Desktop
Adicione isto ao seu claude_desktop_config.json:
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["-y", "@uarlouski/testrail-mcp-server@latest"],
"env": {
"TESTRAIL_INSTANCE_URL": "https://your-instance.testrail.io",
"TESTRAIL_USERNAME": "your@email.com",
"TESTRAIL_API_KEY": "your-api-key",
"TESTRAIL_ENABLE_SHARED_STEPS": "true"
}
}
}
}
⌨️ Cursor
Abra Settings → Features → MCP e adicione uma nova configuração:
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["-y", "@uarlouski/testrail-mcp-server@latest"],
"env": {
"TESTRAIL_INSTANCE_URL": "https://your-instance.testrail.io",
"TESTRAIL_USERNAME": "your@email.com",
"TESTRAIL_API_KEY": "your-api-key"
}
}
}
}
🌊 Windsurf
Atualize seu arquivo de configuração do Windsurf MCP:
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": ["-y", "@uarlouski/testrail-mcp-server@latest"],
"env": {
"TESTRAIL_INSTANCE_URL": "https://your-instance.testrail.io",
"TESTRAIL_USERNAME": "your@email.com",
"TESTRAIL_API_KEY": "your-api-key"
}
}
}
}
🌐 Outros Clientes MCP
Qualquer cliente compatível com MCP pode utilizar este servidor. O padrão é universal — aponte seu cliente para o comando npx com as variáveis de ambiente necessárias.
3. Veja em Ação
Depois de configurado, acelere seu fluxo de trabalho de QA perguntando ao seu assistente de IA:
- "Liste todos os projetos no TestRail para encontrar o projeto ativo mais recente."
- "Mostre-me todos os usuários ativos no projeto para encontrar o responsável certo."
- "Mostre-me todos os casos de teste na seção 5 do projeto 3."
- "Crie um caso de teste abrangente para 'Validação de Login' com etapas detalhadas."
- "Inicie uma nova execução de teste contendo casos da seção 5."
- "Marque o caso de teste ID 1042 como aprovado com o comentário 'Testado com sucesso no staging'."
⚙️ Variáveis de Ambiente e Controles de Segurança
| Variável | Descrição | Obrigatória | Padrão |
|---|---|---|---|
TESTRAIL_INSTANCE_URL | URL da sua instância do TestRail (ex.: https://example.testrail.io) | ✅ | |
TESTRAIL_USERNAME | Endereço de e-mail do usuário do TestRail | ✅ | |
TESTRAIL_API_KEY | Sua chave de API do TestRail (Guia) | ✅ | |
TESTRAIL_ENABLE_SHARED_STEPS | Defina como true para habilitar ferramentas de gerenciamento de Shared Steps | false | |
TESTRAIL_ENABLE_CASE_HISTORY | Defina como true para habilitar ferramentas de Histórico de Casos e rastreamento de revisões | false | |
TESTRAIL_ENABLE_RAG_TOOLS | Defina como true para habilitar ferramentas experimentais de exportação de Knowledge Base / RAG (export_cases_for_rag). Sujeito a mudanças na API. | false | |
TESTRAIL_ALLOW_WRITE_OPERATIONS | Permitir operações de escrita (ex.: adicionar/atualizar casos de teste, execuções de teste, seções) | true | |
TESTRAIL_ALLOW_READ_OPERATIONS | Permitir operações de leitura (ex.: recuperar projetos, casos de teste, modelos) | true | |
TESTRAIL_ALLOW_DELETE_OPERATIONS | Permitir operações de exclusão (ex.: excluir casos ou shared steps). Habilitado estritamente via true. | false | |
TESTRAIL_ENABLE_DEPRECATED_TOOLS | Habilitar ferramentas obsoletas para compatibilidade retroativa. Defina como false para reduzir a sobrecarga de tokens de contexto. | true | |
TESTRAIL_DISABLED_TOOLS | Lista separada por vírgulas de nomes específicos de ferramentas para desabilitar (ex.: mutate_suite,delete_entity). Falha se nomes de ferramentas inválidos forem especificados. | - |
⚠️ Ciclo de Vida de Descontinuação e Recursos Programados para Remoção
Para garantir transições suaves, ferramentas obsoletas permanecem disponíveis por padrão (TESTRAIL_ENABLE_DEPRECATED_TOOLS=true) e serão removidas em futuras versões principais:
| Ferramenta Obsoleta | Substituição | Status |
|---|---|---|
add_attachment_to_run | add_attachment (entity_type: "case" | "run") | Obsoleta em 2.3.0, remoção programada para 3.0.0 |
get_sections | query_section (action: "many") | Obsoleta em 2.8.0, remoção programada para 3.0.0 |
💡 Dica de Tokens: Se você não usa ferramentas legadas, defina
TESTRAIL_ENABLE_DEPRECATED_TOOLS=falseno seu ambiente para eliminar definições de ferramentas obsoletas do prompt do LLM e economizar tokens!
📚 Documentação e Referência Completa de Ferramentas
Para um guia abrangente, opções de configuração detalhadas e uma análise completa de todas as ferramentas disponíveis, visite nosso site oficial de documentação:
👉 Documentação do TestRail MCP Server
A documentação inclui explicações detalhadas para:
- 🔭 Descoberta e Navegação: Explorando projetos, suítes e seções.
- 📋 Gerenciamento de Casos de Teste: Buscando, criando e atualizando em massa casos de teste.
- ▶️ Execução e Acompanhamento: Gerenciando execuções de teste e enviando resultados de teste.
- 📎 Anexos: Compactando e enviando automaticamente arquivos ou diretórios.
- 🔗 Shared Steps: Gerenciando definições de etapas reutilizáveis.
🤝 Contribuindo
Contribuições de código aberto são ativamente bem-vindas! Sinta-se à vontade para abrir uma issue para solicitações de recursos ou enviar um pull request para melhorias.
📜 Licença
Este projeto é licenciado de forma segura sob a Apache License 2.0.
TestRail MCP Server · Desenvolvido com o Model Context Protocol