TestRail

Interaja com as entidades principais do TestRail, como casos de teste, execuções e resultados, usando um protocolo padronizado.

Documentação

TestRail MCP Server

smithery badge

Um servidor Model Context Protocol (MCP) para TestRail que permite interação com as entidades principais do TestRail através de um protocolo padronizado.

Recursos

  • Autenticação com a API do TestRail
  • Acesso às entidades do TestRail:
    • Projects
    • Cases
    • Runs
    • Results
    • Datasets
  • Suporte completo ao Model Context Protocol
  • Compatível com qualquer cliente MCP (Claude Desktop, Cursor, Windsurf, etc.)

Veja em ação junto com o Octomind MCP

Video Title

Instalação

Instalando via Smithery

Para instalar o testrail-mcp para Claude Desktop automaticamente via Smithery:

npx -y @smithery/cli install @sker65/testrail-mcp --client claude

Instalação Manual

  1. Clone este repositório:

    git clone https://github.com/yourusername/testrail-mcp.git
    cd testrail-mcp
    
  2. Crie e ative um ambiente virtual:

    python -m venv .venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    
  3. Instale as dependências:

    pip install -e .
    

Configuração

O servidor MCP do TestRail requer variáveis de ambiente específicas para autenticar com sua instância do TestRail. Elas devem ser definidas antes de executar o servidor.

  1. Crie um arquivo .env no diretório raiz do projeto:

    TESTRAIL_URL=https://your-instance.testrail.io
    TESTRAIL_USERNAME=your-email@example.com
    TESTRAIL_API_KEY=your-api-key
    

    Notas Importantes:

    • TESTRAIL_URL deve ser a URL completa da sua instância do TestRail (por exemplo, https://example.testrail.io)
    • TESTRAIL_USERNAME é o seu endereço de e-mail do TestRail usado para login
    • TESTRAIL_API_KEY é a sua chave de API do TestRail (não a sua senha)
      • Para gerar uma chave de API, faça login no TestRail, vá em "My Settings" > "API Keys" e crie uma nova chave
  2. Verifique se a configuração foi carregada corretamente:

    uvx testrail-mcp --config
    

    Isso exibirá as informações de configuração do seu TestRail, incluindo sua URL, nome de usuário e os primeiros caracteres da sua chave de API para verificação.

Se você estiver usando este servidor com um cliente como Claude Desktop ou Cursor, certifique-se de que as variáveis de ambiente estejam acessíveis ao processo que executa o servidor. Talvez seja necessário definir essas variáveis no ambiente do sistema ou garantir que elas sejam carregadas do arquivo .env.

Uso

Executando o Servidor

O servidor pode ser executado diretamente usando o script instalado:

uvx testrail-mcp

Isso iniciará o servidor MCP no modo stdio, que pode ser usado com clientes MCP que suportam comunicação stdio.

Usando com Clientes MCP

Claude Desktop

No Claude Desktop, adicione um novo servidor com a seguinte configuração:

{
  "mcpServers": {
    "testrail": {
      "command": "uvx",
      "args": [
        "testrail-mcp"
      ],
      "env": {
        "TESTRAIL_URL": "https://your-instance.testrail.io",
        "TESTRAIL_USERNAME": "your-email@example.com",
        "TESTRAIL_API_KEY": "your-api-key"
      }
    }
  }
}

Cursor

No Cursor, adicione uma nova ferramenta personalizada com a seguinte configuração:

{
  "name": "TestRail MCP",
  "command": "uvx",
  "args": [
    "testrail-mcp"
  ],
  "env": {
    "TESTRAIL_URL": "https://your-instance.testrail.io",
    "TESTRAIL_USERNAME": "your-email@example.com",
    "TESTRAIL_API_KEY": "your-api-key"
  }
}

Windsurf

No Windsurf, adicione uma nova ferramenta com a seguinte configuração:

{
  "name": "TestRail MCP",
  "command": "uvx",
  "args": [
    "testrail-mcp"
  ],
  "env": {
    "TESTRAIL_URL": "https://your-instance.testrail.io",
    "TESTRAIL_USERNAME": "your-email@example.com",
    "TESTRAIL_API_KEY": "your-api-key"
  }
}

Testando com o MCP Inspector

Para testes e depuração, você pode usar o MCP Inspector:

npx @modelcontextprotocol/inspector \
  -e TESTRAIL_URL=<your-url> \
  -e TESTRAIL_USERNAME=<your-username> \
  -e TESTRAIL_API_KEY=<your-api-key> \
  uvx testrail-mcp

Isso abrirá uma interface web onde você pode explorar e testar todas as ferramentas e recursos disponíveis.

Desenvolvimento

Este servidor é construído usando:

  • FastMCP - Um framework Python para construir servidores MCP
  • Requests - Para comunicação HTTP com a API do TestRail
  • python-dotenv - Para gerenciamento de variáveis de ambiente

Licença

MIT