Primeiros passos com a extensão do Looker para VS Code

Com a extensão do Looker para VS Code, é possível desenvolver LookML diretamente no seu ambiente de trabalho local. Ele oferece destaque de sintaxe avançado, sincronização bidirecional de arquivos com sua instância do Looker e integração com agentes de programação de IA para "vibe coding".

A extensão é criada usando o framework do Visual Studio Code (VS Code) e oferece suporte a ambientes de desenvolvimento integrados (IDEs) baseados no VS Code, como os seguintes IDEs e ferramentas de programação:

  • Claude Code
  • Codex
  • Cursor
  • Kiro
  • VS Code
  • Windsurf
  • Zed

Os ambientes de desenvolvimento integrado que não são forks do VS Code, como IntelliJ e Eclipse, não são compatíveis com a extensão do Looker para VS Code.

Este guia mostra como configurar e autenticar a extensão.

Fluxo de trabalho com tecnologia de IA

A extensão do Looker para VS Code faz parte de um fluxo de trabalho de desenvolvimento de agentes com tecnologia de IA para editar e criar arquivos do LookML. Para ativar esse fluxo de trabalho, configure as seguintes ferramentas:

  • A extensão do Looker para VS Code.
  • Um IDE local baseado no VS Code. O IDE precisa ter um agente de IA integrado (por exemplo, Cursor) ou, se não tiver (como o VS Code básico), precisa ser integrado a uma ferramenta independente com agente (como a CLI do Gemini ou o Claude Code). Consulte a documentação do seu ambiente de desenvolvimento integrado local para saber como conectar o ambiente a um agente.
  • Um servidor MCP, como o servidor MCP gerenciado pelo Looker.

Para saber mais sobre o fluxo de trabalho com tecnologia de IA, consulte a página de documentação Desenvolvimento assistido por IA (programação de vibe) com o Looker.

Antes de começar

Antes de instalar a extensão, atenda aos seguintes requisitos:

  • Conecte-se a ferramentas de IA: se você planeja usar o desenvolvimento assistido por IA, conecte seu IDE e seu agente de IA ao servidor MCP gerenciado pelo Looker. A configuração e um exemplo aparecem na página de documentação Servidor MCP gerenciado pelo Looker. Consulte a documentação das ferramentas para mais detalhes.
  • Permissões do Looker: você precisa ter a permissão develop do Looker para editar os modelos.
  • Instância do Looker: sua instância precisa estar executando o Looker 26.6 ou uma versão mais recente.
  • Instalação do Git: é necessário ter o Git instalado na máquina local para clonar e gerenciar o repositório do LookML.
  • Configuração do projeto: seu projeto do LookML precisa estar configurado para o Git.
  • ID do cliente OAuth: se você estiver usando a autenticação OAuth (recomendada), peça um ID do cliente OAuth ao administrador do Looker.

Configuração do Administrador

Se a sua organização usa o OAuth para autenticação, um administrador do Looker precisa registrar a extensão do Looker para VS Code como um cliente OAuth na interface de administrador do Looker.

Use o API Explorer do Looker para configurar a integração do OAuth. É possível acessar o API Explorer usando um dos seguintes métodos:

O API Explorer instalado

Se a instância do Looker já tiver o API Explorer instalado, acesse-o com este formato de URL:

LOOKER_INSTANCE_URL/extensions/marketplace_extension_api_explorer::api-explorer/

O API Explorer não está instalado

Se a sua instância do Looker não tiver o API Explorer, instale-o no Marketplace do Looker. Consulte a página Como usar o API Explorer para saber como instalar a ferramenta.

Instância particular do PSA

Se você estiver usando uma instância de conexões particulares do Looker (Google Cloud Core) que usa o acesso a serviços particulares, o Marketplace do Looker e o APIs Explorer não serão compatíveis. Para registrar um agente de IA, chame diretamente o endpoint de API oauth_client_apps. Se você usar esse método, poderá pular as etapas restantes deste procedimento da API Explorer.

Confira abaixo um exemplo de comando curl que pode ser usado com o endpoint oauth_client_apps para registrar o agente.

curl -X POST "https://LOOKER_INSTANCE_URL/api/4.0/oauth_client_apps/CLIENT_GUID" \
-H "Authorization: token ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "redirect_uri": "REDIRECT_URI",
  "display_name": "CLIENT_NAME",
  "description": "OAuth client to access MCP server using CLIENT_NAME",
  "enabled": true
}'

Para registrar a extensão, siga estas etapas:

  1. Siga as instruções na documentação Registrar um aplicativo cliente OAuth para registrar a extensão.
  2. Para o campo client_guid, siga estas etapas:

    • Use qualquer ID exclusivo global.
    • Prepare-se para distribuir o ID a todos os desenvolvedores de LookML que quiserem usar a extensão.
  3. Para redirect_uri, insira o URL de callback do seu ambiente de desenvolvimento integrado. Dependendo do seu ambiente de desenvolvimento integrado ou ferramenta de programação, use um dos seguintes URLs de callback:

    Ambiente de desenvolvimento integrado ou ferramenta URL de callback
    VS Code
    vscode://google.vscode-looker-official/oauth_callback
    Antigravity
    antigravity://google.vscode-looker-official/oauth_callback
    Code-OSS
    code-oss://google.vscode-looker-official/oauth_callback
    Cursor
    cursor://google.vscode-looker-official/oauth_callback
    HTTPS
    https://google.vscode-looker-official/oauth_callback
    Looker
    looker://google.vscode-looker-official/oauth_callback
    Windsurf
    windsurf://google.vscode-looker-official/oauth_callback
  4. Conclua display_name e description conforme descrito na documentação Registrar um aplicativo cliente OAuth.

Depois que o app for registrado, o API Explorer vai retornar uma resposta com um resumo do registro. Use o endpoint Get OAuth Client App com o client_guid para revisar os detalhes do registro.

Forneça o client_guid gerado aos desenvolvedores, que vão usá-lo ao configurar a extensão.

Instalar a extensão

Siga estas etapas para instalar a extensão:

  1. Instale a extensão do Looker para VS Code no Visual Studio Marketplace.
  2. Abra seu ambiente de desenvolvimento integrado, como VS Code ou Cursor.
  3. Clique no ícone Extensões na barra de atividades.
  4. Encontre a extensão do Looker para VS Code e clique em Instalar.
  5. Depois que a extensão for instalada, o ícone Looker vai aparecer na barra de atividades.

Configurar a extensão

É possível configurar a extensão com os detalhes da sua instância do Looker no arquivo settings.json do espaço de trabalho, no editor visual de configurações do VS Code (Preferências: abrir configurações do espaço de trabalho) ou na UI interativa de integração da extensão do Looker.

As etapas a seguir mostram como editar o arquivo settings.json como exemplo. Se você usar o editor de configurações do VS Code ou a UI da extensão do Looker, vai ter o mesmo resultado.

  1. Com um espaço de trabalho aberto, abra a paleta de comandos (Command-Shift-P no Mac ou Ctrl+Shift+P no Windows/Linux).
  2. Procure e selecione Preferências: abrir configurações do espaço de trabalho (JSON).
  3. Adicione as variáveis de configuração às suas configurações. As variáveis de configuração variam dependendo se o método de autenticação é OAuth ou credenciais da API, conforme descrito nas seções a seguir.

O OAuth 2.1 é o fluxo de autenticação recomendado. Cole essas configurações no arquivo settings.json do espaço de trabalho.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.oauthClientId": "YOUR_OAUTH_CLIENT_ID",
  "looker.projectId": "YOUR_PROJECT_ID"
}

Substitua:

  • https://YOUR_INSTANCE_URL: o URL da sua instância do Looker.
  • YOUR_OAUTH_CLIENT_ID: o ID do cliente OAuth (client_guid) que você recebe do administrador do Looker.
  • YOUR_PROJECT_ID: o nome do projeto que você quer editar. Para encontrar, na sua instância do Looker, abra a página Projetos do LookML. O ID do projeto está na coluna Projeto.

Autenticar com credenciais da API

Se preferir usar chaves de API do Looker, siga a documentação para criar credenciais de API. Você também precisa fornecer o ID do projeto.

{
  "looker.instanceUrl": "https://YOUR_INSTANCE_URL",
  "looker.clientId": "YOUR_CLIENT_ID",
  "looker.clientSecret": "YOUR_CLIENT_SECRET",
  "looker.projectId": "YOUR_PROJECT_ID"
}

Substitua:

  • https://YOUR_INSTANCE_URL: o URL da sua instância do Looker.
  • YOUR_CLIENT_ID e YOUR_CLIENT_SECRET: o ID e a chave secreta do cliente para as credenciais da API que você está usando para autenticar. Para encontrar essas credenciais, na sua instância do Looker, abra a página Conta. Em seguida, na seção Chaves de API, clique no botão Gerenciar. Isso abre a página Chaves de API, onde você pode ver seus IDs e chaves secretas do cliente.
  • YOUR_PROJECT_ID: o nome do projeto que você quer editar. Para encontrar o nome do projeto, na sua instância do Looker, abra a página Projetos do LookML. O ID do projeto está na coluna Projeto.

Configurações

É possível configurar as seguintes opções do MCP no espaço de trabalho do ambiente de desenvolvimento integrado.

Configuração Descrição Padrão
looker.instanceURL URL de base da instância do Looker (por exemplo, https://mycompany.looker.com). -
looker.authURL URL a ser usado para autenticação OAuth. Só defina se for diferente do URL da sua instância. looker.instanceURL
looker.sdkURL URL a ser usado para solicitações de API. Só defina se for diferente do URL da sua instância. looker.instanceURL
looker.oauthClientId ID do cliente OAuth do Looker. Obrigatório para OAuth. -
looker.clientId ID do cliente da API Looker. Obrigatório para autenticação com chave de API. -
looker.clientSecret Chave secreta do cliente da API Looker. Obrigatório para autenticação com chave de API. -
looker.projectId ID do projeto do Looker. -
looker.mcpServerUrl URL do servidor MCP externo a ser usado como proxy (por exemplo, http://localhost:5000/mcp). -
looker.acceptSelfSignedCertificates Ignorar erros de certificado SSL (por exemplo, para certificados autoassinados). Aviso: não recomendamos ativar essa opção. false
looker.askBeforeOverwritingRemote Sempre perguntar antes de substituir arquivos remotos quando um conflito é detectado. false

Configurar o cliente MCP

Para permitir que seu agente de IA interaja com o Looker pela extensão, configure o agente para se conectar ao URL do proxy MCP da extensão. Por padrão, o proxy é executado localmente em http://127.0.0.1:5050.

Se o servidor MCP estiver sendo executado em uma porta diferente de 5000 ou em uma máquina remota, atualize a configuração de proxy da extensão. Para fazer isso, atualize a configuração looker.mcpServerUrl nas configurações do espaço de trabalho do VS Code. Consulte a seção Configurações para mais informações.

Visual Studio Code (Copilot)

  1. Abra o VS Code e crie o diretório .vscode na raiz do projeto, se ele ainda não existir.
  2. Crie e abra o arquivo .vscode/mcp.json, se ele ainda não existir.
  3. Adicione a seguinte configuração e salve o arquivo:
      {
        "servers": {
          "looker": {
            "type": "http",
            "url": "http://127.0.0.1:5050"
          }
        }
      }
  

Claude Code

  1. Crie o arquivo .mcp.json na raiz do projeto, se ele ainda não existir.
  2. Adicione a seguinte configuração e salve o arquivo:
      {
        "mcpServers": {
          "looker": {
            "type": "http",
            "url": "http://127.0.0.1:5050"
          }
        }
      }
  

Cursor

  1. Crie o diretório .cursor na raiz do projeto, se ele ainda não existir.
  2. Crie e abra o arquivo .cursor/mcp.json, se ele ainda não existir.
  3. Adicione a seguinte configuração e salve o arquivo:
      {
        "mcpServers": {
          "looker": {
            "type": "http",
            "url": "http://127.0.0.1:5050"
          }
        }
      }
  
  1. Abra Cursor e navegue até Configurações > Configurações do cursor > MCP. Um status ativo verde aparece quando o servidor se conecta.

Cline

  1. Abra a extensão Cline no VS Code e clique no ícone Servidores MCP.
  2. Clique em Configurar servidores MCP para abrir o arquivo de configuração.
  3. Adicione a seguinte configuração e salve o arquivo:
      {
        "mcpServers": {
          "looker": {
            "type": "http",
            "url": "http://127.0.0.1:5050"
          }
        }
      }
  

Windsurf

  1. Abra o Windsurf e navegue até o assistente do Cascade.
  2. Clique no ícone do MCP e em Configurar para abrir o arquivo de configuração.
  3. Adicione a seguinte configuração e salve o arquivo:
      {
        "mcpServers": {
          "looker": {
            "type": "http",
            "url": "http://127.0.0.1:5050"
          }
        }
      }
  

Autenticar pelo Looker

Se você estiver usando a autenticação OAuth, faça login para vincular seu IDE local à sua conta do Looker.

  1. Abra a paleta de comandos.
  2. Execute o comando: Looker: fazer login (OAuth).
  3. Confirme a solicitação para abrir o navegador.
  4. No navegador, autorize a extensão a acessar sua conta do Looker.
  5. Depois de autorizar, o navegador redireciona você de volta para o ambiente de desenvolvimento integrado. Você vai receber uma notificação informando Login no Looker concluído com sucesso!

Clonar seu projeto do LookML

Para começar o desenvolvimento, clone o repositório LookML na sua máquina local.

  1. No VS Code, abra uma nova janela.
  2. Abra a paleta de comandos e selecione Git: Clone.
  3. Insira o URL do seu repositório Git remoto (por exemplo, do GitHub ou GitLab) e escolha uma pasta local.
  4. Abra a pasta clonada no seu IDE.

A extensão detecta automaticamente os arquivos LookML e começa a sincronizar com sua ramificação verificada no modo de desenvolvimento da instância do Looker.

Solução de problemas

É possível conferir os registros de extensão no painel Saída do seu ambiente de desenvolvimento integrado. Selecione o canal Looker para ver os registros. Para registros mais detalhados, abra a paleta de comandos, execute o comando Desenvolvedor: definir nível de registro e selecione Depurar ou Trace.

  • Erros de autenticação: verifique se o looker.instanceUrl e o looker.oauthClientId estão corretos. Verifique se o URI de redirecionamento no Looker corresponde exatamente.
  • Problemas de sincronização: verifique os registros de extensão para resolver problemas de sincronização. Para ver os registros, abra o painel Saída e selecione Looker no menu suspenso.
  • Resposta de solicitação inválida durante o OAuth: verifique se a instância do Looker está acessível na sua rede local e se você tem uma conexão de Internet válida.

Se você tiver problemas com a extensão, execute o comando Desenvolvedor: recarregar janela na paleta de comandos para resolvê-los.

A seguir