genai-toolbox/docs/en/resources/sources/looker.md at d013badbdace895d9cbb5572b85d3fffa8917187

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-05-02 03:00:36 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

5.4 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
Looker	docs	1	Looker is a business intelligence tool that also provides a semantic layer.

About

Looker is a web based business intelligence and data management tool that provides a semantic layer to facilitate querying. It can be deployed in the cloud, on GCP, or on premises.

Requirements

Looker User

This source only uses API authentication. You will need to create an API user to login to Looker.

{{< notice note >}} To use the Conversational Analytics API, you will need to have the following Google Cloud Project API enabled and IAM permissions. {{< /notice >}}

API Enablement in GCP

Enable the following APIs in your Google Cloud Project:

gcloud services enable geminidataanalytics.googleapis.com --project=$PROJECT_ID
gcloud services enable cloudaicompanion.googleapis.com --project=$PROJECT_ID

IAM Permissions in GCP

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the following IAM roles (or corresponding permissions):

roles/looker.instanceUser
roles/cloudaicompanion.user
roles/geminidataanalytics.dataAgentStatelessUser

To initialize the application default credential run gcloud auth login --update-adc in your environment before starting MCP Toolbox.

Example

kind: sources
name: my-looker-source
type: looker
base_url: http://looker.example.com
client_id: ${LOOKER_CLIENT_ID}
client_secret: ${LOOKER_CLIENT_SECRET}
project: ${LOOKER_PROJECT}
location: ${LOOKER_LOCATION}
verify_ssl: true
timeout: 600s

The Looker base url will look like "https://looker.example.com", don't include a trailing "/". In some cases, especially if your Looker is deployed on-premises, you may need to add the API port number like "https://looker.example.com:19999".

Verify ssl should almost always be "true" (all lower case) unless you are using a self-signed ssl certificate for the Looker server. Anything other than "true" will be interpreted as false.

The client id and client secret are seemingly random character sequences assigned by the looker server. If you are using Looker OAuth you don't need these settings

The project and location fields are utilized only when using the conversational analytics tool.

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

field	type	required	description
type	string	true	Must be "looker".
base_url	string	true	The URL of your Looker server with no trailing /.
client_id	string	false	The client id assigned by Looker.
client_secret	string	false	The client secret assigned by Looker.
verify_ssl	string	false	Whether to check the ssl certificate of the server.
project	string	false	The project id to use in Google Cloud.
location	string	false	The location to use in Google Cloud. (default: us)
timeout	string	false	Maximum time to wait for query execution (e.g. "30s", "2m"). By default, 120s is applied.
use_client_oauth	string	false	Use OAuth tokens instead of client_id and client_secret. (default: false) If a header name is provided, it will be used instead of "Authorization".
show_hidden_models	string	false	Show or hide hidden models. (default: true)
show_hidden_explores	string	false	Show or hide hidden explores. (default: true)
show_hidden_fields	string	false	Show or hide hidden fields. (default: true)

5.4 KiB Raw Blame History