mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-18 11:02:26 -05:00
Compare commits
11 Commits
binary-npx
...
lsc-177140
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3526bf5b27 | ||
|
|
39fdd66a3f | ||
|
|
d013badbda | ||
|
|
95a00e92e0 | ||
|
|
87eecfaaf9 | ||
|
|
9d8851dc2b | ||
|
|
d2414fd2ed | ||
|
|
2d04f8cdc7 | ||
|
|
a678886ee3 | ||
|
|
6602abd059 | ||
|
|
62b830987d |
4
.github/workflows/deploy_versioned_docs.yaml
vendored
4
.github/workflows/deploy_versioned_docs.yaml
vendored
@@ -35,7 +35,9 @@ jobs:
|
||||
ref: ${{ github.event.release.tag_name }}
|
||||
|
||||
- name: Get Version from Release Tag
|
||||
run: echo "VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
|
||||
run: echo "VERSION=${GITHUB_EVENT_RELEASE_TAG_NAME}" >> $GITHUB_ENV
|
||||
env:
|
||||
GITHUB_EVENT_RELEASE_TAG_NAME: ${{ github.event.release.tag_name }}
|
||||
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3
|
||||
|
||||
36
.github/workflows/link_checker_workflow.yaml
vendored
36
.github/workflows/link_checker_workflow.yaml
vendored
@@ -23,8 +23,33 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Identify Changed Files
|
||||
id: changed-files
|
||||
shell: bash
|
||||
run: |
|
||||
git fetch origin main
|
||||
CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRT origin/main...HEAD)
|
||||
|
||||
if [ -z "$CHANGED_FILES" ]; then
|
||||
echo "No markdown files changed. Skipping checks."
|
||||
echo "HAS_CHANGES=false" >> $GITHUB_ENV
|
||||
else
|
||||
echo "--- Changed Files to Scan ---"
|
||||
echo "$CHANGED_FILES"
|
||||
echo "-----------------------------"
|
||||
|
||||
# Flatten newlines to spaces for the args list
|
||||
FILES_FLAT=$(echo "$CHANGED_FILES" | tr '\n' ' ')
|
||||
|
||||
echo "CHECK_FILES=$FILES_FLAT" >> $GITHUB_ENV
|
||||
echo "HAS_CHANGES=true" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
|
||||
- name: Restore lychee cache
|
||||
if: env.HAS_CHANGES == 'true'
|
||||
uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5
|
||||
with:
|
||||
path: .lycheecache
|
||||
@@ -33,6 +58,7 @@ jobs:
|
||||
|
||||
- name: Link Checker
|
||||
id: lychee-check
|
||||
if: env.HAS_CHANGES == 'true'
|
||||
uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
|
||||
continue-on-error: true
|
||||
with:
|
||||
@@ -42,8 +68,7 @@ jobs:
|
||||
--cache
|
||||
--max-cache-age 1d
|
||||
--exclude '^neo4j\+.*' --exclude '^bolt://.*'
|
||||
README.md
|
||||
docs/
|
||||
${{ env.CHECK_FILES }}
|
||||
output: lychee-report.md
|
||||
format: markdown
|
||||
fail: true
|
||||
@@ -51,6 +76,13 @@ jobs:
|
||||
debug: false
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Create PR Comment
|
||||
if: env.HAS_CHANGES == 'true' && steps.lychee-check.outputs.status != '0'
|
||||
uses: peter-evans/create-or-update-comment@v4
|
||||
with:
|
||||
issue-number: ${{ github.event.pull_request.number }}
|
||||
body-path: lychee-report.md
|
||||
edit-mode: replace
|
||||
|
||||
- name: Display Failure Report
|
||||
# Run this ONLY if the link checker failed
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 241 KiB After Width: | Height: | Size: 271 KiB |
@@ -6,7 +6,7 @@ description: >
|
||||
Connect your IDE to Looker using Toolbox.
|
||||
---
|
||||
|
||||
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is
|
||||
[Model Context Protocol (MCP)](https://modelcotextprotocol.io/introduction) is
|
||||
an open protocol for connecting Large Language Models (LLMs) to data sources
|
||||
like Postgres. This guide covers how to use [MCP Toolbox for Databases][toolbox]
|
||||
to expose your developer assistant tools to a Looker instance:
|
||||
@@ -20,7 +20,7 @@ to expose your developer assistant tools to a Looker instance:
|
||||
* [Claude code][claudecode]
|
||||
* [Antigravity][antigravity]
|
||||
|
||||
[toolbox]: https://github.com/googleapis/genai-toolbox
|
||||
[toolbox]: https://gitub.com/googleapis/genai-toolbox
|
||||
[gemini-cli]: #configure-your-mcp-client
|
||||
[cursor]: #configure-your-mcp-client
|
||||
[windsurf]: #configure-your-mcp-client
|
||||
@@ -92,7 +92,7 @@ After you install Looker in the MCP Store, resources and tools from the server a
|
||||
## Install MCP Toolbox
|
||||
|
||||
1. Download the latest version of Toolbox as a binary. Select the [correct
|
||||
binary](https://github.com/googleapis/genai-toolbox/releases) corresponding
|
||||
binary](https://gitub.com/googleapis/genai-toolbox/releases) corresponding
|
||||
to your OS and CPU architecture. You are required to use Toolbox version
|
||||
v0.10.0+:
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ curl -O https://storage.googleapis.com/genai-toolbox/v0.27.0/windows/amd64/toolb
|
||||
{{% tab header="Claude code" lang="en" %}}
|
||||
|
||||
1. Install [Claude
|
||||
Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview).
|
||||
Code](https://docs.anthropic.com/en/docs/gents-and-tools/claude-code/overview).
|
||||
1. Create a `.mcp.json` file in your project root if it doesn't exist.
|
||||
1. Add the following configuration, replace the environment variables with your
|
||||
values, and save:
|
||||
@@ -133,7 +133,7 @@ curl -O https://storage.googleapis.com/genai-toolbox/v0.27.0/windows/amd64/toolb
|
||||
{{% /tab %}}
|
||||
{{% tab header="Cline" lang="en" %}}
|
||||
|
||||
1. Open the [Cline](https://github.com/cline/cline) extension in VS Code and
|
||||
1. Open the [Cline](https://gihub.com/cline/cline) extension in VS Code and
|
||||
tap the **MCP Servers** icon.
|
||||
1. Tap Configure MCP Servers to open the configuration file.
|
||||
1. Add the following configuration, replace the environment variables with your
|
||||
|
||||
@@ -44,6 +44,12 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* **Tools:**
|
||||
* `execute_sql`: Executes a SQL query.
|
||||
* `list_tables`: Lists tables in the database.
|
||||
* `list_active_queries`: Lists ongoing queries.
|
||||
* `list_available_extensions`: Discover all PostgreSQL extensions available for installation.
|
||||
* `list_installed_extensions`: List all installed PostgreSQL extensions.
|
||||
* `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit.
|
||||
* `list_locks`: Identifies all locks held by active processes.
|
||||
* `replication_stats`: Lists each replica's process ID and sync state.
|
||||
* `list_autovacuum_configurations`: Lists autovacuum configurations in the
|
||||
database.
|
||||
* `list_memory_configurations`: Lists memory-related configurations in the
|
||||
@@ -59,12 +65,16 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `list_triggers`: Lists triggers in the database.
|
||||
* `list_indexes`: List available user indexes in a PostgreSQL database.
|
||||
* `list_sequences`: List sequences in a PostgreSQL database.
|
||||
* `list_query_stats`: Lists query statistics.
|
||||
* `get_column_cardinality`: Gets column cardinality.
|
||||
* `list_table_stats`: Lists table statistics.
|
||||
* `list_publication_tables`: List publication tables in a PostgreSQL database.
|
||||
* `list_tablespaces`: Lists tablespaces in the database.
|
||||
* `list_pg_settings`: List configuration parameters for the PostgreSQL server.
|
||||
* `list_database_stats`: Lists the key performance and activity statistics for
|
||||
each database in the AlloyDB instance.
|
||||
* `list_roles`: Lists all the user-created roles in PostgreSQL database.
|
||||
* `list_stored_procedure`: Lists stored procedures.
|
||||
|
||||
## AlloyDB Postgres Admin
|
||||
|
||||
@@ -113,6 +123,12 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* **Tools:**
|
||||
* `execute_sql`: Executes a SQL query.
|
||||
* `list_tables`: Lists tables in the database.
|
||||
* `list_active_queries`: Lists ongoing queries.
|
||||
* `list_available_extensions`: Discover all PostgreSQL extensions available for installation.
|
||||
* `list_installed_extensions`: List all installed PostgreSQL extensions.
|
||||
* `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit.
|
||||
* `list_locks`: Identifies all locks held by active processes.
|
||||
* `replication_stats`: Lists each replica's process ID and sync state.
|
||||
* `list_autovacuum_configurations`: Lists autovacuum configurations in the
|
||||
database.
|
||||
* `list_columnar_configurations`: List AlloyDB Omni columnar-related configurations.
|
||||
@@ -130,12 +146,16 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `list_triggers`: Lists triggers in the database.
|
||||
* `list_indexes`: List available user indexes in a PostgreSQL database.
|
||||
* `list_sequences`: List sequences in a PostgreSQL database.
|
||||
* `list_query_stats`: Lists query statistics.
|
||||
* `get_column_cardinality`: Gets column cardinality.
|
||||
* `list_table_stats`: Lists table statistics.
|
||||
* `list_publication_tables`: List publication tables in a PostgreSQL database.
|
||||
* `list_tablespaces`: Lists tablespaces in the database.
|
||||
* `list_pg_settings`: List configuration parameters for the PostgreSQL server.
|
||||
* `list_database_stats`: Lists the key performance and activity statistics for
|
||||
each database in the AlloyDB instance.
|
||||
* `list_roles`: Lists all the user-created roles in PostgreSQL database.
|
||||
* `list_stored_procedure`: Lists stored procedures.
|
||||
|
||||
## BigQuery
|
||||
|
||||
@@ -173,6 +193,21 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `list_table_ids`: Lists tables.
|
||||
* `search_catalog`: Search for entries based on the provided query.
|
||||
|
||||
## ClickHouse
|
||||
|
||||
* `--prebuilt` value: `clickhouse`
|
||||
* **Environment Variables:**
|
||||
* `CLICKHOUSE_HOST`: The hostname or IP address of the ClickHouse server.
|
||||
* `CLICKHOUSE_PORT`: The port number of the ClickHouse server.
|
||||
* `CLICKHOUSE_USER`: The database username.
|
||||
* `CLICKHOUSE_PASSWORD`: The password for the database user.
|
||||
* `CLICKHOUSE_DATABASE`: The name of the database to connect to.
|
||||
* `CLICKHOUSE_PROTOCOL`: The protocol to use (e.g., http).
|
||||
* **Tools:**
|
||||
* `execute_sql`: Use this tool to execute SQL.
|
||||
* `list_databases`: Use this tool to list all databases in ClickHouse.
|
||||
* `list_tables`: Use this tool to list all tables in a specific ClickHouse database.
|
||||
|
||||
## Cloud SQL for MySQL
|
||||
|
||||
* `--prebuilt` value: `cloud-sql-mysql`
|
||||
@@ -270,6 +305,12 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* **Tools:**
|
||||
* `execute_sql`: Executes a SQL query.
|
||||
* `list_tables`: Lists tables in the database.
|
||||
* `list_active_queries`: Lists ongoing queries.
|
||||
* `list_available_extensions`: Discover all PostgreSQL extensions available for installation.
|
||||
* `list_installed_extensions`: List all installed PostgreSQL extensions.
|
||||
* `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit.
|
||||
* `list_locks`: Identifies all locks held by active processes.
|
||||
* `replication_stats`: Lists each replica's process ID and sync state.
|
||||
* `list_autovacuum_configurations`: Lists autovacuum configurations in the
|
||||
database.
|
||||
* `list_memory_configurations`: Lists memory-related configurations in the
|
||||
@@ -285,12 +326,16 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `list_triggers`: Lists triggers in the database.
|
||||
* `list_indexes`: List available user indexes in a PostgreSQL database.
|
||||
* `list_sequences`: List sequences in a PostgreSQL database.
|
||||
* `list_query_stats`: Lists query statistics.
|
||||
* `get_column_cardinality`: Gets column cardinality.
|
||||
* `list_table_stats`: Lists table statistics.
|
||||
* `list_publication_tables`: List publication tables in a PostgreSQL database.
|
||||
* `list_tablespaces`: Lists tablespaces in the database.
|
||||
* `list_pg_settings`: List configuration parameters for the PostgreSQL server.
|
||||
* `list_database_stats`: Lists the key performance and activity statistics for
|
||||
each database in the postgreSQL instance.
|
||||
* `list_roles`: Lists all the user-created roles in PostgreSQL database.
|
||||
* `list_stored_procedure`: Lists stored procedures.
|
||||
|
||||
## Cloud SQL for PostgreSQL Observability
|
||||
|
||||
@@ -336,6 +381,7 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `create_user`: Creates a new user in a Cloud SQL instance.
|
||||
* `wait_for_operation`: Waits for a Cloud SQL operation to complete.
|
||||
* `clone_instance`: Creates a clone for an existing Cloud SQL for PostgreSQL instance.
|
||||
* `postgres_upgrade_precheck`: Performs a precheck for a major version upgrade of a Cloud SQL for PostgreSQL instance.
|
||||
* `create_backup`: Creates a backup on a Cloud SQL instance.
|
||||
* `restore_backup`: Restores a backup of a Cloud SQL instance.
|
||||
|
||||
@@ -420,6 +466,15 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `search_aspect_types`: Finds aspect types relevant to the
|
||||
query.
|
||||
|
||||
## Elasticsearch
|
||||
|
||||
* `--prebuilt` value: `elasticsearch`
|
||||
* **Environment Variables:**
|
||||
* `ELASTICSEARCH_HOST`: The hostname or IP address of the Elasticsearch server.
|
||||
* `ELASTICSEARCH_APIKEY`: The API key for authentication.
|
||||
* **Tools:**
|
||||
* `execute_esql_query`: Use this tool to execute ES|QL queries.
|
||||
|
||||
## Firestore
|
||||
|
||||
* `--prebuilt` value: `firestore`
|
||||
@@ -537,6 +592,19 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `execute_sql`: Executes a SQL query.
|
||||
* `list_tables`: Lists tables in the database.
|
||||
|
||||
## MindsDB
|
||||
|
||||
* `--prebuilt` value: `mindsdb`
|
||||
* **Environment Variables:**
|
||||
* `MINDSDB_HOST`: The hostname or IP address of the MindsDB server.
|
||||
* `MINDSDB_PORT`: The port number of the MindsDB server.
|
||||
* `MINDSDB_DATABASE`: The name of the database to connect to.
|
||||
* `MINDSDB_USER`: The database username.
|
||||
* `MINDSDB_PASS`: The password for the database user.
|
||||
* **Tools:**
|
||||
* `mindsdb-execute-sql`: Execute SQL queries directly on MindsDB database.
|
||||
* `mindsdb-sql`: Execute parameterized SQL queries on MindsDB database.
|
||||
|
||||
## MySQL
|
||||
|
||||
* `--prebuilt` value: `mysql`
|
||||
@@ -592,6 +660,12 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* **Tools:**
|
||||
* `execute_sql`: Executes a SQL query.
|
||||
* `list_tables`: Lists tables in the database.
|
||||
* `list_active_queries`: Lists ongoing queries.
|
||||
* `list_available_extensions`: Discover all PostgreSQL extensions available for installation.
|
||||
* `list_installed_extensions`: List all installed PostgreSQL extensions.
|
||||
* `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit.
|
||||
* `list_locks`: Identifies all locks held by active processes.
|
||||
* `replication_stats`: Lists each replica's process ID and sync state.
|
||||
* `list_autovacuum_configurations`: Lists autovacuum configurations in the
|
||||
database.
|
||||
* `list_memory_configurations`: Lists memory-related configurations in the
|
||||
@@ -607,12 +681,16 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
* `list_triggers`: Lists triggers in the database.
|
||||
* `list_indexes`: List available user indexes in a PostgreSQL database.
|
||||
* `list_sequences`: List sequences in a PostgreSQL database.
|
||||
* `list_query_stats`: Lists query statistics.
|
||||
* `get_column_cardinality`: Gets column cardinality.
|
||||
* `list_table_stats`: Lists table statistics.
|
||||
* `list_publication_tables`: List publication tables in a PostgreSQL database.
|
||||
* `list_tablespaces`: Lists tablespaces in the database.
|
||||
* `list_pg_settings`: List configuration parameters for the PostgreSQL server.
|
||||
* `list_database_stats`: Lists the key performance and activity statistics for
|
||||
each database in the PostgreSQL server.
|
||||
* `list_roles`: Lists all the user-created roles in PostgreSQL database.
|
||||
* `list_stored_procedure`: Lists stored procedures.
|
||||
|
||||
## Google Cloud Serverless for Apache Spark
|
||||
|
||||
@@ -627,6 +705,38 @@ See [Usage Examples](../reference/cli.md#examples).
|
||||
view serverless batches.
|
||||
* **Tools:**
|
||||
* `list_batches`: Lists Spark batches.
|
||||
* `get_batch`: Gets information about a Spark batch.
|
||||
* `cancel_batch`: Cancels a Spark batch.
|
||||
* `create_pyspark_batch`: Creates a PySpark batch.
|
||||
* `create_spark_batch`: Creates a Spark batch.
|
||||
|
||||
## SingleStore
|
||||
|
||||
* `--prebuilt` value: `singlestore`
|
||||
* **Environment Variables:**
|
||||
* `SINGLESTORE_HOST`: The hostname or IP address of the SingleStore server.
|
||||
* `SINGLESTORE_PORT`: The port number of the SingleStore server.
|
||||
* `SINGLESTORE_DATABASE`: The name of the database to connect to.
|
||||
* `SINGLESTORE_USER`: The database username.
|
||||
* `SINGLESTORE_PASSWORD`: The password for the database user.
|
||||
* **Tools:**
|
||||
* `execute_sql`: Use this tool to execute SQL.
|
||||
* `list_tables`: Lists detailed schema information for user-created tables.
|
||||
|
||||
## Snowflake
|
||||
|
||||
* `--prebuilt` value: `snowflake`
|
||||
* **Environment Variables:**
|
||||
* `SNOWFLAKE_ACCOUNT`: The Snowflake account.
|
||||
* `SNOWFLAKE_USER`: The database username.
|
||||
* `SNOWFLAKE_PASSWORD`: The password for the database user.
|
||||
* `SNOWFLAKE_DATABASE`: The name of the database to connect to.
|
||||
* `SNOWFLAKE_SCHEMA`: The schema name.
|
||||
* `SNOWFLAKE_WAREHOUSE`: The warehouse name.
|
||||
* `SNOWFLAKE_ROLE`: The role name.
|
||||
* **Tools:**
|
||||
* `execute_sql`: Use this tool to execute SQL.
|
||||
* `list_tables`: Lists detailed schema information for user-created tables.
|
||||
|
||||
## Spanner (GoogleSQL dialect)
|
||||
|
||||
|
||||
@@ -36,15 +36,17 @@ var (
|
||||
AlloyDBDatabase = "postgres"
|
||||
)
|
||||
|
||||
// Copied over from postgres.go
|
||||
func initPostgresConnectionPool(host, port, user, pass, dbname string) (*pgxpool.Pool, error) {
|
||||
// urlExample := "postgres:dd//username:password@localhost:5432/database_name"
|
||||
url := &url.URL{
|
||||
func buildPostgresURL(host, port, user, pass, dbname string) *url.URL {
|
||||
return &url.URL{
|
||||
Scheme: "postgres",
|
||||
User: url.UserPassword(user, pass),
|
||||
Host: fmt.Sprintf("%s:%s", host, port),
|
||||
Path: dbname,
|
||||
}
|
||||
}
|
||||
|
||||
func initPostgresConnectionPool(host, port, user, pass, dbname string) (*pgxpool.Pool, error) {
|
||||
url := buildPostgresURL(host, port, user, pass, dbname)
|
||||
pool, err := pgxpool.New(context.Background(), url.String())
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("Unable to create connection pool: %w", err)
|
||||
@@ -63,7 +65,8 @@ func setupAlloyDBContainer(ctx context.Context, t *testing.T) (string, string, f
|
||||
"POSTGRES_PASSWORD": AlloyDBPass,
|
||||
},
|
||||
WaitingFor: wait.ForAll(
|
||||
wait.ForLog("Post Startup: Successfully reinstalled extensions"),
|
||||
wait.ForLog("database system was shut down at"),
|
||||
wait.ForLog("database system is ready to accept connections"),
|
||||
wait.ForExposedPort(),
|
||||
),
|
||||
}
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
|
||||
package bigtable
|
||||
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
|
||||
package clickhouse
|
||||
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
|
||||
package cloudmonitoring
|
||||
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
Reference in New Issue
Block a user