Ngrok MCP Server

ngrok MCP Server

Servidor MCP (Model Context Protocol) para gerenciar túneis ngrok diretamente do OpenCode ou outros clientes MCP.

Instalação

# Clone o repositório
git clone https://github.com/SamukDantas/ngrok-mcp-server.git
cd ngrok-mcp-server

# Instale as dependências
npm install

# Compile o TypeScript
npm run build

Configuração

1. Configure o authtoken do ngrok

Crie um arquivo ngrok-config.json no diretório ~/.config/opencode/:

{
  "authtoken": "SEU_AUTHTOKEN_AQUI"
}

Para obter seu authtoken, vá em: https://dashboard.ngrok.com/get-started/your-authtoken

2. Configure o OpenCode

Adicione o MCP do ngrok no seu opencode.json:

{
  "mcpServers": {
    "ngrok": {
      "command": "node",
      "args": ["C:/Users/SamukDantas/.config/opencode/mcp-servers/ngrok/dist/index.js"]
    }
  }
}

Ferramentas Disponíveis

Gerenciamento de Túneis

Protocolos

Configuração e Manutenção

Inspeção

Exemplos de Uso

Criar um túnel HTTP básico

await ngrok_http({ port: 3000 });

Criar um túnel HTTP com autenticação

await ngrok_http({
  port: 3000,
  basicAuth: "user:password"
});

Criar um túnel com OAuth

await ngrok_http({
  port: 8080,
  oauthProvider: "google",
  oauthAllowDomain: "exemplo.com",
  oauthScope: "email,profile"
});

Cri

ar um túnel TCPawait ngrok_tcp({ port: 22 });

Criar um túnel TLS com certificado

await ngrok_tls({
  port: 443,
  crt: "/path/to/cert.crt",
  key: "/path/to/key.key"
});

Criar um túnel com IP restriction

await ngrok_http({
  port: 3000,
  cidrAllow: "192.168.1.0/24",
  cidrDeny: "10.0.0.0/8"
});

Listar túneis ativos

await ngrok_list_tunnels();

Desconectar um túnel

await ngrok_disconnect({ url: "https://abc123.ngrok.io" });

Diagnóstico de conectividade

await ngrok_diagnose({ region: "us" });

Opções Avançadas

ngrok_http

ngrok_tls

Requisitos

• Node.js 18+
• npm ou yarn
• ngrok CLI (instalado automaticamente via npx)
• Conta no ngrok (gratuita ou paga)

Licença

MIT