Erste Schritte mit der Looker-Erweiterung für VS Code

Mit der Looker-Erweiterung für VS Code können Sie LookML direkt in Ihrer lokalen Desktopumgebung entwickeln. Sie bietet umfassende Syntaxhervorhebung, bidirektionale Dateisynchronisierung mit Ihrer Looker-Instanz und Integration mit KI-basierten Coding-Agenten für „Vibe Coding“.

Die Erweiterung wird mit dem Visual Studio Code-Framework (VS Code) erstellt und unterstützt integrierte Entwicklungsumgebungen (IDEs), die auf der VS Code-IDE basieren, z. B. die folgenden IDEs und Coding-Tools:

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

IDEs, die keine Forks von VS Code sind, z. B. IntelliJ und Eclipse, werden von der Looker-Erweiterung für VS Code nicht unterstützt.

In dieser Anleitung wird beschrieben, wie Sie die Erweiterung einrichten und authentifizieren.

KI-basierter Workflow

Die Looker-Erweiterung für VS Code ist Teil eines KI-basierten agentenbasierten Entwicklungsworkflows zum Bearbeiten und Erstellen von LookML-Dateien. Konfigurieren Sie die folgenden Tools, um diesen Workflow zu aktivieren:

  • Die Looker-Erweiterung für VS Code.
  • Eine lokale IDE , die auf VS Code basiert. Die IDE muss entweder einen integrierten KI-Agenten (z. B. Cursor) enthalten oder, wenn die IDE keinen integrierten KI-Agenten enthält (z. B. VS Code), muss die IDE in ein eigenständiges agentenbasiertes Tool (z. B. Gemini CLI oder Claude Code) eingebunden sein. Informationen zum Verbinden Ihrer IDE mit einem Agenten finden Sie in der Dokumentation Ihrer lokalen IDE.
  • Ein MCP-Server, z. B. der von Looker verwaltete MCP-Server.

Weitere Informationen zum KI-basierten Workflow finden Sie auf der Dokumentationsseite KI-basierte Entwicklung (Vibe Coding) mit Looker.

Hinweis

Bevor Sie die Erweiterung installieren, müssen die folgenden Voraussetzungen erfüllt sein:

Einrichtung durch Administrator

Wenn Ihre Organisation OAuth zur Authentifizierung verwendet, muss ein Looker-Administrator die Looker-Erweiterung für VS Code als OAuth-Client in der Looker-Admin-UI registrieren.

Verwenden Sie den Looker API Explorer, um die OAuth-Integration einzurichten. Sie können auf eine der folgenden Arten auf den API Explorer zugreifen:

API Explorer installiert

Wenn der API Explorer bereits in Ihrer Looker-Instanz installiert ist, können Sie mit diesem URL-Format darauf zugreifen:

LOOKER_INSTANCE_URL/extensions/marketplace_extension_api_explorer::api-explorer/

API Explorer nicht installiert

Wenn der API Explorer nicht in Ihrer Looker-Instanz vorhanden ist, können Sie ihn im Looker Marketplace installieren. Informationen zum Installieren des API Explorer finden Sie auf der Seite API Explorer verwenden.

Private PSA-Instanz

Wenn Sie eine private Looker (Google Cloud Core)-Instanz mit privaten Verbindungen verwenden, die Zugriff auf private Dienste nutzt, werden der Looker Marketplace und der API Explorer nicht unterstützt. Um einen KI-Agenten zu registrieren, müssen Sie den oauth_client_apps API-Endpunkt direkt aufrufen. Wenn Sie diese Methode verwenden, können Sie die verbleibenden Schritte dieser API Explorer-Anleitung überspringen.

Im Folgenden sehen Sie ein Beispiel für einen curl-Befehl, den Sie mit dem Endpunkt oauth_client_apps verwenden können, um den Agenten zu registrieren.

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
}'

Führen Sie die folgenden Schritte aus, um die Erweiterung zu registrieren:

  1. Folgen Sie der Anleitung unter OAuth-Clientanwendung registrieren, um die Erweiterung zu registrieren.

  2. Führen Sie für das Feld client_guid die folgenden Schritte aus:

    • Verwenden Sie eine global eindeutige ID.
    • Halten Sie die ID bereit, um sie an alle LookML-Entwickler weiterzugeben, die die Erweiterung verwenden möchten.

  3. Verwenden Sie für redirect_uri:

    vscode://google.vscode-looker-official/oauth_callback

  4. Füllen Sie display_name und description wie in der Dokumentation OAuth-Clientanwendung registrieren beschrieben aus.

Nachdem die App registriert wurde, gibt der API Explorer eine Antwort mit einer Zusammenfassung der Registrierung zurück. Sie können den Endpunkt Get OAuth Client App mit der client_guid verwenden, um die Registrierungsdetails zu prüfen.

Geben Sie die generierte client_guid an Ihre Entwickler weiter. Sie verwenden sie bei der Konfiguration der Erweiterung.

Erweiterung installieren

Führen Sie die folgenden Schritte aus, um die Erweiterung zu installieren:

  1. Installieren Sie die Looker-Erweiterung für VS Code aus dem Visual Studio Marketplace.
  2. Öffnen Sie Ihre IDE, z. B. VS Code oder Cursor.
  3. Klicken Sie in der Aktivitätsleiste auf das Symbol Erweiterungen.
  4. Suchen Sie nach der Looker-Erweiterung für VS Code und klicken Sie auf Installieren.
  5. Nachdem die Erweiterung installiert wurde, wird in der Aktivitätsleiste das Symbol Looker angezeigt.

Erweiterung konfigurieren

Sie müssen die Erweiterung mit den Details Ihrer Looker-Instanz in der Datei settings.json Ihres Arbeitsbereichs konfigurieren.

  1. Öffnen Sie bei geöffnetem Arbeitsbereich die Befehlspalette (Command-Shift-P unter Mac oder Strg+Shift+P unter Windows/Linux).
  2. Suchen Sie nach Einstellungen: Arbeitsbereichseinstellungen öffnen (JSON) und wählen Sie diese Option aus.
  3. Fügen Sie die Konfigurationsvariablen zu Ihren Einstellungen hinzu. Die Konfigurationsvariablen variieren je nachdem, ob Sie die OAuth-Authentifizierung oder API-Anmeldedaten verwenden.

OAuth 2.1 ist der empfohlene Authentifizierungsablauf. Fügen Sie diese Einstellungen in die Datei settings.json Ihres Arbeitsbereichs ein.

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

Ersetzen Sie Folgendes:

  • https://YOUR_INSTANCE_URL: Die URL Ihrer Looker-Instanz.
  • YOUR_OAUTH_CLIENT_ID: Die OAuth-Client-ID (client_guid), die Sie von Ihrem Looker-Administrator erhalten.
  • YOUR_PROJECT_ID: Der Name des Projekts, das Sie bearbeiten möchten. Öffnen Sie dazu in Ihrer Looker-Instanz die Seite LookML-Projekte. Die Projekt-ID befindet sich in der Spalte Projekt.

Mit API-Anmeldedaten authentifizieren

Wenn Sie Looker API-Schlüssel verwenden möchten, folgen Sie der Anleitung zum Erstellen von API-Anmeldedaten. Sie müssen auch Ihre Projekt-ID angeben.

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

Ersetzen Sie Folgendes:

  • https://YOUR_INSTANCE_URL: Die URL Ihrer Looker-Instanz.
  • YOUR_CLIENT_ID und YOUR_CLIENT_SECRET: Die Client-ID und der Clientschlüssel für die API-Anmeldedaten, die Sie zur Authentifizierung verwenden. Öffnen Sie dazu in Ihrer Looker-Instanz die Konto-Seite und klicken Sie dann im Bereich API-Schlüssel auf die Schaltfläche Verwalten. Dadurch wird die Seite API-Schlüssel geöffnet, auf der Sie Ihre Client-IDs und Clientschlüssel sehen können.
  • YOUR_PROJECT_ID: Der Name des Projekts, das Sie bearbeiten möchten. Öffnen Sie dazu in Ihrer Looker-Instanz die LookML-Projekte Seite. Die Projekt-ID befindet sich in der Spalte Projekt.

Einstellungen

Sie können die folgenden MCP-Einstellungen im Arbeitsbereich Ihrer IDE konfigurieren.

Einstellung Beschreibung Standard
looker.instanceURL Basis-URL der Looker-Instanz (z. B. https://mycompany.looker.com). -
looker.authURL URL für die OAuth-Authentifizierung. Nur festlegen, wenn sie sich von der Instanz-URL unterscheidet. looker.instanceURL
looker.sdkURL URL für API-Anfragen. Nur festlegen, wenn sie sich von der Instanz-URL unterscheidet. looker.instanceURL
looker.oauthClientId Looker OAuth-Client-ID. Für OAuth erforderlich. -
looker.clientId Looker API-Client-ID. Für die API-Schlüsselauthentifizierung erforderlich. -
looker.clientSecret Looker API-Clientschlüssel. Für die API-Schlüsselauthentifizierung erforderlich. -
looker.projectId Looker-Projekt-ID. -
looker.mcpServerUrl URL des externen MCP-Servers, der als Proxy verwendet werden soll (z. B. http://localhost:5000/mcp). -
looker.acceptSelfSignedCertificates SSL-Zertifikatfehler ignorieren (z. B. bei selbstsignierten Zertifikaten). Warnung: Es wird nicht empfohlen, diese Option zu aktivieren. false
looker.askBeforeOverwritingRemote Immer fragen, bevor Remote-Dateien überschrieben werden, wenn ein Konflikt erkannt wird. false

Über Looker authentifizieren

Wenn Sie die OAuth-Authentifizierung verwenden, müssen Sie sich anmelden, um Ihre lokale IDE mit Ihrem Looker-Konto zu verknüpfen.

  1. Öffnen Sie die Befehlspalette.
  2. Führen Sie den Befehl Looker: Anmelden (OAuth) aus.
  3. Bestätigen Sie die Aufforderung, Ihren Browser zu öffnen.
  4. Autorisieren Sie im Browser die Erweiterung, auf Ihr Looker-Konto zuzugreifen.
  5. Nach der Autorisierung werden Sie im Browser wieder zu Ihrer IDE weitergeleitet. Sie sollten eine Benachrichtigung mit dem Text Erfolgreich bei Looker angemeldet sehen.

LookML-Projekt klonen

Um mit der Entwicklung zu beginnen, müssen Sie Ihr LookML-Repository auf Ihren lokalen Computer klonen.

  1. Öffnen Sie in VS Code ein neues Fenster.
  2. Öffnen Sie die Befehlspalette und wählen Sie Git: Klonen aus.
  3. Geben Sie die URL Ihres Remote-Git-Repositorys ein (z. B. von GitHub oder GitLab) und wählen Sie einen lokalen Ordner aus.
  4. Öffnen Sie den geklonten Ordner in Ihrer IDE.

Die Erweiterung erkennt die LookML-Dateien automatisch und beginnt mit der Synchronisierung mit Ihrem ausgecheckten Branch im Entwicklermodus Ihrer Looker-Instanz.

Fehlerbehebung

Sie können die Erweiterungsprotokolle im Bereich Ausgabe Ihrer IDE ansehen. Wählen Sie den Kanal Looker aus, um Protokolle anzusehen. Öffnen Sie für detailliertere Protokolle die Befehlspalette, führen Sie den Befehl Entwickler: Protokollebene festlegen aus und wählen Sie Debug oder Trace aus.

  • Authentifizierungsfehler: Prüfen Sie, ob looker.instanceUrl und looker.oauthClientId korrekt sind. Achten Sie darauf, dass die Umleitungs-URI in Looker genau übereinstimmt.
  • Synchronisierungsprobleme: Prüfen Sie die Erweiterungsprotokolle, um Synchronisierungsprobleme zu beheben. Öffnen Sie dazu den Bereich Ausgabe und wählen Sie im Drop-down-Menü Looker aus.
  • Antwort „Bad Request“ während OAuth: Achten Sie darauf, dass Ihre Looker-Instanz über Ihr lokales Netzwerk zugänglich ist und dass Sie eine funktionierende Internetverbindung haben.

Wenn Probleme mit der Erweiterung auftreten, kann es helfen, den Befehl Entwickler: Fenster neu laden über die Befehlspalette auszuführen.

Nächste Schritte