diff --git a/.hugo/hugo.toml b/.hugo/hugo.toml index 0cede0ef4ace..3bbb2da72996 100644 --- a/.hugo/hugo.toml +++ b/.hugo/hugo.toml @@ -37,7 +37,6 @@ ignoreFiles = ["quickstart/shared", "quickstart/python", "quickstart/js", "quick github_subdir = "docs" offlineSearch = false version_menu = "Releases" - disableMigrationBanner = true releases_url = "/genai-toolbox/releases.releases" global_logo_url = "/genai-toolbox/" version = "dev" diff --git a/.hugo/layouts/shortcodes/list-prebuilt-configs.html b/.hugo/layouts/shortcodes/list-prebuilt-configs.html new file mode 100644 index 000000000000..0c0ad5580be6 --- /dev/null +++ b/.hugo/layouts/shortcodes/list-prebuilt-configs.html @@ -0,0 +1,100 @@ +{{ $integrations := site.GetPage "section" "integrations" }} + +
+ {{/*Loop through all database folders alphabetically */}} + {{ range $integrations.Pages.ByTitle }} + {{ $db := . }} + {{/* Only render a row if this database has a 'prebuilt-configs' folder */}} + {{ with $db.GetPage "prebuilt-configs" }} + {{ $displayTitle := $db.Title }} + {{ $targetLink := .RelPermalink }} + {{ $displayDesc := .Description | default (printf "Explore prebuilt configurations for %s." $db.Title) }} + + +
+
+ {{ $displayTitle }} + + + + +
+
{{ $displayDesc | plainify | truncate 120 }}
+
+ + {{ end }} + {{ end }} +
+ + diff --git a/DEVELOPER.md b/DEVELOPER.md index 8da74c9aeac4..64922764c7f4 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -267,11 +267,13 @@ When updating documentation, you must adhere to the structural constraints enfor * If a new database inherits tools from a base integration (like Cloud SQL inheriting Postgres tools), create the `tools/` directory with an `_index.md` file. * Map the inherited tools dynamically by adding the `shared_tools` YAML array to the frontmatter of this `tools/_index.md` file. **This file must strictly contain only frontmatter.** * **Adding Samples:** - * Samples are distributed across the site and aggregated visually via the "Samples Hub". Place your sample based on its scope: - 1. **Quickstarts:** Place in `docs/en/documentation/getting-started/quickstart/`. - 2. **Database-Specific samples:** Place in `docs/en/integrations//samples/`. Make sure to include a `samples/_index.md` wrapper that contains **only frontmatter**. - 3. **General/Cross- samples:** Place directly in `docs/en/samples/`. - * Ensure appropriate **frontmatter tags (`sample_filters`, `is_sample`)** are added so the UI Gallery filters can index them. + * **Physical Location:** + 1. **Quickstarts:** `docs/en/documentation/getting-started/quickstart/`. + 2. **Integration-Specific:** `docs/en/integrations//samples/`. Must include an `_index.md` with strictly only frontmatter. + 3. **General:** `docs/en/samples/`. + * **Frontmatter Requirements (Maintenance):** To ensure samples appear correctly in the Samples Section, you must provide the following tags: + * `is_sample: true` - Required for indexing. + * `sample_filters:` - A YAML array used for UI filtering (e.g., `[postgres, go, sql]`). * **Adding Top-Level Sections:** If you add a completely new top-level documentation directory (e.g., a new section alongside `integrations`, `documentation`), you **must** update the AI documentation layout files located at `.hugo/layouts/index.llms.txt` and `.hugo/layouts/index.llms-full.txt`. Specifically, update the "Diátaxis Narrative Framework" preamble so AI models understand the purpose of your new section. #### Adding Prebuilt Tools @@ -498,6 +500,14 @@ When adding or updating a Tool page, your markdown file must strictly adhere to * **Allowed Optional Headings:** `Compatible Sources`, `Requirements`, `Parameters`, `Output Format`, `Reference`, `Advanced Usage`, `Troubleshooting`, `Additional Resources` * **Compatible Sources Shortcode:** If you include the `## Compatible Sources` heading, you must place the compatible-sources shortcode (e.g., `{{< compatible-sources >}}`) directly beneath it. +#### Prebuilt Configuration Structure (`integrations/**/prebuilt-configs/*.md`) + +To ensure new prebuilt configurations are automatically indexed by the `{{< list-prebuilt-configs >}}` shortcode on the main Prebuilt Configs page, follow these rules: + +* **Location:** Always place documentation for prebuilt configurations in a nested directory named `prebuilt-configs/` inside the database folder (e.g., `docs/en/integrations/alloydb/prebuilt-configs/`). +* **Index Wrapper:** Every `prebuilt-configs/` directory must contain an `_index.md` file. This file acts as the anchor for the directory and must contain the `title` and `description` used in the automated lists. +* **Architecture-Based Mapping:** Map configurations to database folders based on the `kind` defined in the tool's YAML file (in `internal/prebuiltconfigs/tools/`). For example, any tool using the `postgres` kind should live in the `postgres/` integration directory. + #### Frontend Assets & Layouts If you need to modify the visual appearance, navigation, or behavior of the documentation website itself, all frontend assets are isolated within the `.hugo/` directory. diff --git a/GEMINI.md b/GEMINI.md index f344263fe1b0..a4f15ad02b40 100644 --- a/GEMINI.md +++ b/GEMINI.md @@ -161,11 +161,25 @@ When generating or editing documentation for this repository, you must strictly 5. **Shortcode Placement:** If you generate the `## Compatible Sources` section, you must include the `{{< compatible-sources >}}` shortcode beneath it. ##### Samples Architecture Constraints -Sample code is aggregated visually in the UI via the Samples section, but the physical markdown files are distributed logically based on their scope. When adding samples, use the correct location and apply proper frontmatter tags (`sample_filters`, `is_sample`) are added so the UI Gallery filters can index them.for the gallery filtering: +Sample code is aggregated visually in the UI via the Samples section, but the physical markdown files are distributed logically based on their scope. 1. **Quickstarts:** `docs/en/documentation/getting-started/` 2. **Integration-Specific Samples:** `docs/en/integrations//samples/`. (The `samples/_index.md` wrapper must contain **strictly only frontmatter**). 3. **General/Cross-Category Samples:** `docs/en/samples/` +##### Samples Maintenance Rules + +1. **Filtering:** Always include `sample_filters` in the frontmatter. Use specific tags for: + * Data Source (e.g., `bigquery`, `alloydb`) + * Language (e.g., `python`, `js`, `go`) + * Tool Type (e.g., `mcp`, `sdk`) +2. **Metadata:** Ensure `is_sample: true` is present to prevent the sample from being excluded from the Samples Gallery. + +##### Prebuilt Config Constraints (`integrations/**/prebuilt-configs/*.md`) + +1. **Naming & Path:** All prebuilt config docs must reside in `prebuilt-configs/`. +2. **Shortcode Requirement:** The main `documentation/configuration/prebuilt-configs/_index.md` page uses the `{{< list-prebuilt-configs >}}` shortcode, which only detects directories named exactly `prebuilt-configs`. +3. **YAML Mapping:** Always verify the `kind` of the data source in `internal/prebuiltconfigs/tools/` before choosing the integration folder. + ##### Asset Constraints (`docs/`) diff --git a/docs/en/documentation/configuration/prebuilt-configs/_index.md b/docs/en/documentation/configuration/prebuilt-configs/_index.md index 7cb0119a21a5..fac44ebe05bd 100644 --- a/docs/en/documentation/configuration/prebuilt-configs/_index.md +++ b/docs/en/documentation/configuration/prebuilt-configs/_index.md @@ -22,876 +22,6 @@ You can also combine multiple prebuilt configs. See [Usage Examples](../../../reference/cli.md#usage-examples). {{< /notice >}} -## AlloyDB Postgres +## Available Prebuilt Configs -* `--prebuilt` value: `alloydb-postgres` -* **Environment Variables:** - * `ALLOYDB_POSTGRES_PROJECT`: The GCP project ID. - * `ALLOYDB_POSTGRES_REGION`: The region of your AlloyDB instance. - * `ALLOYDB_POSTGRES_CLUSTER`: The ID of your AlloyDB cluster. - * `ALLOYDB_POSTGRES_INSTANCE`: The ID of your AlloyDB instance. - * `ALLOYDB_POSTGRES_DATABASE`: The name of the database to connect to. - * `ALLOYDB_POSTGRES_USER`: (Optional) The database username. Defaults to - IAM authentication if unspecified. - * `ALLOYDB_POSTGRES_PASSWORD`: (Optional) The password for the database - user. Defaults to IAM authentication if unspecified. - * `ALLOYDB_POSTGRES_IP_TYPE`: (Optional) The IP type i.e. "Public" or - "Private" (Default: Public). -* **Permissions:** - * **AlloyDB Client** (`roles/alloydb.client`) to connect to the instance. - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **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 - database. - * `list_top_bloated_tables`: List top bloated tables in the database. - * `list_replication_slots`: Lists replication slots in the database. - * `list_invalid_indexes`: Lists invalid indexes in the database. - * `get_query_plan`: Generate the execution plan of a statement. - * `list_views`: Lists views in the database from pg_views with a default - limit of 50 rows. Returns schemaname, viewname and the ownername. - * `list_schemas`: Lists schemas in the database. - * `database_overview`: Fetches the current state of the PostgreSQL server. - * `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 - -* `--prebuilt` value: `alloydb-postgres-admin` -* **Permissions:** - * **AlloyDB Viewer** (`roles/alloydb.viewer`) is required for `list` and - `get` tools. - * **AlloyDB Admin** (`roles/alloydb.admin`) is required for `create` tools. -* **Tools:** - * `create_cluster`: Creates a new AlloyDB cluster. - * `list_clusters`: Lists all AlloyDB clusters in a project. - * `get_cluster`: Gets information about a specified AlloyDB cluster. - * `create_instance`: Creates a new AlloyDB instance within a cluster. - * `list_instances`: Lists all instances within an AlloyDB cluster. - * `get_instance`: Gets information about a specified AlloyDB instance. - * `create_user`: Creates a new database user in an AlloyDB cluster. - * `list_users`: Lists all database users within an AlloyDB cluster. - * `get_user`: Gets information about a specified database user in an - AlloyDB cluster. - * `wait_for_operation`: Polls the operations API to track the status of - long-running operations. - -## AlloyDB Postgres Observability - -* `--prebuilt` value: `alloydb-postgres-observability` -* **Permissions:** - * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the - project to view monitoring data. -* **Tools:** - * `get_system_metrics`: Fetches system level cloud monitoring data - (timeseries metrics) for an AlloyDB instance using a PromQL query. - * `get_query_metrics`: Fetches query level cloud monitoring data - (timeseries metrics) for queries running in an AlloyDB instance using a - PromQL query. - -## AlloyDB Omni - -* `--prebuilt` value: `alloydb-omni` -* **Environment Variables:** - * `ALLOYDB_OMNI_HOST`: (Optional) The hostname or IP address (Default: localhost). - * `ALLOYDB_OMNI_PORT`: (Optional) The port number (Default: 5432). - * `ALLOYDB_OMNI_DATABASE`: The name of the database to connect to. - * `ALLOYDB_OMNI_USER`: The database username. - * `ALLOYDB_OMNI_PASSWORD`: (Optional) The password for the database user. - * `ALLOYDB_OMNI_QUERY_PARAMS`: (Optional) Connection query parameters. -* **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. - * `list_columnar_recommended_columns`: Lists columns that AlloyDB Omni recommends adding to the columnar engine. - * `list_memory_configurations`: Lists memory-related configurations in the - database. - * `list_top_bloated_tables`: List top bloated tables in the database. - * `list_replication_slots`: Lists replication slots in the database. - * `list_invalid_indexes`: Lists invalid indexes in the database. - * `get_query_plan`: Generate the execution plan of a statement. - * `list_views`: Lists views in the database from pg_views with a default - limit of 50 rows. Returns schemaname, viewname and the ownername. - * `list_schemas`: Lists schemas in the database. - * `database_overview`: Fetches the current state of the PostgreSQL server. - * `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 - -* `--prebuilt` value: `bigquery` -* **Environment Variables:** - * `BIGQUERY_PROJECT`: The GCP project ID. - * `BIGQUERY_LOCATION`: (Optional) The dataset location. - * `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) If `true`, forwards the client's - OAuth access token for authentication. Defaults to `false`. - * `BIGQUERY_SCOPES`: (Optional) A comma-separated list of OAuth scopes to - use for authentication. -* **Permissions:** - * **BigQuery User** (`roles/bigquery.user`) to execute queries and view - metadata. - * **BigQuery Metadata Viewer** (`roles/bigquery.metadataViewer`) to view - all datasets. - * **BigQuery Data Editor** (`roles/bigquery.dataEditor`) to create or - modify datasets and tables. - * **Gemini for Google Cloud** (`roles/cloudaicompanion.user`) to use the - conversational analytics API. -* **Tools:** - * `analyze_contribution`: Use this tool to perform contribution analysis, - also called key driver analysis. - * `ask_data_insights`: Use this tool to perform data analysis, get - insights, or answer complex questions about the contents of specific - BigQuery tables. For more information on required roles, API setup, and - IAM configuration, see the setup and authentication section of the - [Conversational Analytics API - documentation](https://cloud.google.com/gemini/docs/conversational-analytics-api/overview). - * `execute_sql`: Executes a SQL statement. - * `forecast`: Use this tool to forecast time series data. - * `get_dataset_info`: Gets dataset metadata. - * `get_table_info`: Gets table metadata. - * `list_dataset_ids`: Lists datasets. - * `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` -* **Environment Variables:** - * `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. - * `CLOUD_SQL_MYSQL_REGION`: The region of your Cloud SQL instance. - * `CLOUD_SQL_MYSQL_INSTANCE`: The ID of your Cloud SQL instance. - * `CLOUD_SQL_MYSQL_DATABASE`: The name of the database to connect to. - * `CLOUD_SQL_MYSQL_USER`: The database username. - * `CLOUD_SQL_MYSQL_PASSWORD`: The password for the database user. - * `CLOUD_SQL_MYSQL_IP_TYPE`: The IP type i.e. "Public - or "Private" (Default: Public). -* **Permissions:** - * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the - instance. - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - * `get_query_plan`: Provides information about how MySQL executes a SQL - statement. - * `list_active_queries`: Lists ongoing queries. - * `list_tables_missing_unique_indexes`: Looks for tables that do not have - primary or unique key contraint. - * `list_table_fragmentation`: Displays table fragmentation in MySQL. - -## Cloud SQL for MySQL Observability - -* `--prebuilt` value: `cloud-sql-mysql-observability` -* **Permissions:** - * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the - project to view monitoring data. -* **Tools:** - * `get_system_metrics`: Fetches system level cloud monitoring data - (timeseries metrics) for a MySQL instance using a PromQL query. - * `get_query_metrics`: Fetches query level cloud monitoring data - (timeseries metrics) for queries running in a MySQL instance using a - PromQL query. - -## Cloud SQL for MySQL Admin - -* `--prebuilt` value: `cloud-sql-mysql-admin` -* **Permissions:** - * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only - access to resources. - * `get_instance` - * `list_instances` - * `list_databases` - * `wait_for_operation` - * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to - manage existing resources. - * All `viewer` tools - * `create_database` - * `create_backup` - * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over - all resources. - * All `editor` and `viewer` tools - * `create_instance` - * `create_user` - * `clone_instance` - * `restore_backup` - -* **Tools:** - * `create_instance`: Creates a new Cloud SQL for MySQL instance. - * `get_instance`: Gets information about a Cloud SQL instance. - * `list_instances`: Lists Cloud SQL instances in a project. - * `create_database`: Creates a new database in a Cloud SQL instance. - * `list_databases`: Lists all databases for a Cloud SQL instance. - * `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 MySQL instance. - * `create_backup`: Creates a backup on a Cloud SQL instance. - * `restore_backup`: Restores a backup of a Cloud SQL instance. - -## Cloud SQL for PostgreSQL - -* `--prebuilt` value: `cloud-sql-postgres` -* **Environment Variables:** - * `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID. - * `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance. - * `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance. - * `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to. - * `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. Defaults to - IAM authentication if unspecified. - * `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database - user. Defaults to IAM authentication if unspecified. - * `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) The IP type i.e. "Public" or - "Private" (Default: Public). -* **Permissions:** - * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the - instance. - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **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 - database. - * `list_top_bloated_tables`: List top bloated tables in the database. - * `list_replication_slots`: Lists replication slots in the database. - * `list_invalid_indexes`: Lists invalid indexes in the database. - * `get_query_plan`: Generate the execution plan of a statement. - * `list_views`: Lists views in the database from pg_views with a default - limit of 50 rows. Returns schemaname, viewname and the ownername. - * `list_schemas`: Lists schemas in the database. - * `database_overview`: Fetches the current state of the PostgreSQL server. - * `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 - -* `--prebuilt` value: `cloud-sql-postgres-observability` -* **Permissions:** - * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the - project to view monitoring data. -* **Tools:** - * `get_system_metrics`: Fetches system level cloud monitoring data - (timeseries metrics) for a Postgres instance using a PromQL query. - * `get_query_metrics`: Fetches query level cloud monitoring data - (timeseries metrics) for queries running in Postgres instance using a - PromQL query. - -## Cloud SQL for PostgreSQL Admin - -* `--prebuilt` value: `cloud-sql-postgres-admin` -* **Permissions:** - * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only - access to resources. - * `get_instance` - * `list_instances` - * `list_databases` - * `wait_for_operation` - * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to - manage existing resources. - * All `viewer` tools - * `create_database` - * `create_backup` - * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over - all resources. - * All `editor` and `viewer` tools - * `create_instance` - * `create_user` - * `clone_instance` - * `restore_backup` -* **Tools:** - * `create_instance`: Creates a new Cloud SQL for PostgreSQL instance. - * `get_instance`: Gets information about a Cloud SQL instance. - * `list_instances`: Lists Cloud SQL instances in a project. - * `create_database`: Creates a new database in a Cloud SQL instance. - * `list_databases`: Lists all databases for a Cloud SQL instance. - * `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. - -## Cloud SQL for SQL Server - -* `--prebuilt` value: `cloud-sql-mssql` -* **Environment Variables:** - * `CLOUD_SQL_MSSQL_PROJECT`: The GCP project ID. - * `CLOUD_SQL_MSSQL_REGION`: The region of your Cloud SQL instance. - * `CLOUD_SQL_MSSQL_INSTANCE`: The ID of your Cloud SQL instance. - * `CLOUD_SQL_MSSQL_DATABASE`: The name of the database to connect to. - * `CLOUD_SQL_MSSQL_USER`: The database username. - * `CLOUD_SQL_MSSQL_PASSWORD`: The password for the database user. - * `CLOUD_SQL_MSSQL_IP_TYPE`: (Optional) The IP type i.e. "Public" or - "Private" (Default: Public). -* **Permissions:** - * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the - instance. - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - -## Cloud SQL for SQL Server Observability - -* `--prebuilt` value: `cloud-sql-mssql-observability` -* **Permissions:** - * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the - project to view monitoring data. -* **Tools:** - * `get_system_metrics`: Fetches system level cloud monitoring data - (timeseries metrics) for a SQL Server instance using a PromQL query. - -## Cloud SQL for SQL Server Admin - -* `--prebuilt` value: `cloud-sql-mssql-admin` -* **Permissions:** - * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only - access to resources. - * `get_instance` - * `list_instances` - * `list_databases` - * `wait_for_operation` - * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to - manage existing resources. - * All `viewer` tools - * `create_database` - * `create_backup` - * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over - all resources. - * All `editor` and `viewer` tools - * `create_instance` - * `create_user` - * `clone_instance` - * `restore_backup` -* **Tools:** - * `create_instance`: Creates a new Cloud SQL for SQL Server instance. - * `get_instance`: Gets information about a Cloud SQL instance. - * `list_instances`: Lists Cloud SQL instances in a project. - * `create_database`: Creates a new database in a Cloud SQL instance. - * `list_databases`: Lists all databases for a Cloud SQL instance. - * `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 SQL Server instance. - * `create_backup`: Creates a backup on a Cloud SQL instance. - * `restore_backup`: Restores a backup of a Cloud SQL instance. - -## Dataplex - -* `--prebuilt` value: `dataplex` -* **Environment Variables:** - * `DATAPLEX_PROJECT`: The GCP project ID. -* **Permissions:** - * **Dataplex Reader** (`roles/dataplex.viewer`) to search and look up - entries. - * **Dataplex Editor** (`roles/dataplex.editor`) to modify entries. -* **Tools:** - * `search_entries`: Searches for entries in Dataplex Catalog. - * `lookup_entry`: Retrieves a specific entry from Dataplex - Catalog. - * `search_aspect_types`: Finds aspect types relevant to the - query. - -## Dataproc - -* `--prebuilt` value: `dataproc` -* **Environment Variables:** - * `DATAPROC_PROJECT`: The GCP project ID. - * `DATAPROC_REGION`: The Dataproc region. -* **Permissions:** - * **Dataproc Viewer** (`roles/dataproc.viewer`) to examine clusters and jobs. -* **Tools:** - * `list_clusters`: Lists Dataproc clusters. - * `get_cluster`: Gets a Dataproc cluster. - * `list_jobs`: Lists Dataproc jobs. - * `get_job`: Gets a Dataproc job. - -## 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` -* **Environment Variables:** - * `FIRESTORE_PROJECT`: The GCP project ID. - * `FIRESTORE_DATABASE`: (Optional) The Firestore database ID. Defaults to - "(default)". -* **Permissions:** - * **Cloud Datastore User** (`roles/datastore.user`) to get documents, list - collections, and query collections. - * **Firebase Rules Viewer** (`roles/firebaserules.viewer`) to get and - validate Firestore rules. -* **Tools:** - * `get_documents`: Gets multiple documents from Firestore by their paths. - * `add_documents`: Adds a new document to a Firestore collection. - * `update_document`: Updates an existing document in Firestore. - * `list_collections`: Lists Firestore collections for a given parent path. - * `delete_documents`: Deletes multiple documents from Firestore. - * `query_collection`: Retrieves one or more Firestore documents from a - collection. - * `get_rules`: Retrieves the active Firestore security rules. - * `validate_rules`: Checks the provided Firestore Rules source for syntax - and validation errors. - -## Looker - -* `--prebuilt` value: `looker` -* **Environment Variables:** - * `LOOKER_BASE_URL`: The URL of your Looker instance. - * `LOOKER_CLIENT_ID`: The client ID for the Looker API. - * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. - * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. - * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. - * `LOOKER_SHOW_HIDDEN_MODELS`: Whether to show hidden models. - * `LOOKER_SHOW_HIDDEN_EXPLORES`: Whether to show hidden explores. - * `LOOKER_SHOW_HIDDEN_FIELDS`: Whether to show hidden fields. -* **Permissions:** - * A Looker account with permissions to access the desired models, - explores, and data is required. -* **Tools:** - * `get_models`: Retrieves the list of LookML models. - * `get_explores`: Retrieves the list of explores in a model. - * `get_dimensions`: Retrieves the list of dimensions in an explore. - * `get_measures`: Retrieves the list of measures in an explore. - * `get_filters`: Retrieves the list of filters in an explore. - * `get_parameters`: Retrieves the list of parameters in an explore. - * `query`: Runs a query against the LookML model. - * `query_sql`: Generates the SQL for a query. - * `query_url`: Generates a URL for a query in Looker. - * `get_looks`: Searches for saved looks. - * `run_look`: Runs the query associated with a look. - * `make_look`: Creates a new look. - * `get_dashboards`: Searches for saved dashboards. - * `run_dashboard`: Runs the queries associated with a dashboard. - * `make_dashboard`: Creates a new dashboard. - * `add_dashboard_element`: Adds a tile to a dashboard. - * `add_dashboard_filter`: Adds a filter to a dashboard. - * `generate_embed_url`: Generate an embed url for content. - -## Looker Dev - -* `--prebuilt` value: `looker-dev` -* Almost always used in combination with Looker, `--prebuilt looker,looker-dev` -* **Environment Variables:** - * `LOOKER_BASE_URL`: The URL of your Looker instance. - * `LOOKER_CLIENT_ID`: The client ID for the Looker API. - * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. - * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. - * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. - * `LOOKER_SHOW_HIDDEN_MODELS`: Whether to show hidden models. - * `LOOKER_SHOW_HIDDEN_EXPLORES`: Whether to show hidden explores. - * `LOOKER_SHOW_HIDDEN_FIELDS`: Whether to show hidden fields. -* **Permissions:** - * A Looker account with permissions to access the desired projects - and LookML is required. -* **Tools:** - * `health_pulse`: Test the health of a Looker instance. - * `health_analyze`: Analyze the LookML usage of a Looker instance. - * `health_vacuum`: Suggest LookML elements that can be removed. - * `dev_mode`: Activate developer mode. - * `get_projects`: Get the LookML projects in a Looker instance. - * `get_project_files`: List the project files in a project. - * `get_project_file`: Get the content of a LookML file. - * `create_project_file`: Create a new LookML file. - * `update_project_file`: Update an existing LookML file. - * `delete_project_file`: Delete a LookML file. - * `get_project_directories`: Retrieves a list of project directories for a given LookML project. - * `create_project_directory`: Creates a new directory within a specified LookML project. - * `delete_project_directory`: Deletes a directory from a specified LookML project. - * `validate_project`: Check the syntax of a LookML project. - * `get_connections`: Get the available connections in a Looker instance. - * `get_connection_schemas`: Get the available schemas in a connection. - * `get_connection_databases`: Get the available databases in a connection. - * `get_connection_tables`: Get the available tables in a connection. - * `get_connection_table_columns`: Get the available columns for a table. - * `get_lookml_tests`: Retrieves a list of available LookML tests for a project. - * `run_lookml_tests`: Executes specific LookML tests within a project. - * `create_view_from_table`: Generates boilerplate LookML views directly from the database schema. - * `project_git_branch`: Fetch and manipulate the git branch of a LookML project. - -## Looker Conversational Analytics - -* `--prebuilt` value: `looker-conversational-analytics` -* **Environment Variables:** - * `LOOKER_BASE_URL`: The URL of your Looker instance. - * `LOOKER_CLIENT_ID`: The client ID for the Looker API. - * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. - * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. - * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. - * `LOOKER_PROJECT`: The GCP Project to use for Conversational Analytics. - * `LOOKER_LOCATION`: The GCP Location to use for Conversational Analytics. -* **Permissions:** - * A Looker account with permissions to access the desired models, - explores, and data is required. - * **Looker Instance User** (`roles/looker.instanceUser`): IAM role to - access Looker. - * **Gemini for Google Cloud User** (`roles/cloudaicompanion.user`): IAM - role to access Conversational Analytics. - * **Gemini Data Analytics Stateless Chat User (Beta)** - (`roles/geminidataanalytics.dataAgentStatelessUser`): IAM role to - access Conversational Analytics. -* **Tools:** - * `ask_data_insights`: Ask a question of the data. - * `get_models`: Retrieves the list of LookML models. - * `get_explores`: Retrieves the list of explores in a model. - -## Microsoft SQL Server - -* `--prebuilt` value: `mssql` -* **Environment Variables:** - * `MSSQL_HOST`: (Optional) The hostname or IP address of the SQL Server instance. - * `MSSQL_PORT`: (Optional) The port number for the SQL Server instance. - * `MSSQL_DATABASE`: The name of the database to connect to. - * `MSSQL_USER`: The database username. - * `MSSQL_PASSWORD`: The password for the database user. -* **Permissions:** - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **Tools:** - * `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` -* **Environment Variables:** - * `MYSQL_HOST`: The hostname or IP address of the MySQL server. - * `MYSQL_PORT`: The port number for the MySQL server. - * `MYSQL_DATABASE`: The name of the database to connect to. - * `MYSQL_USER`: The database username. - * `MYSQL_PASSWORD`: The password for the database user. -* **Permissions:** - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - * `get_query_plan`: Provides information about how MySQL executes a SQL - statement. - * `list_active_queries`: Lists ongoing queries. - * `list_tables_missing_unique_indexes`: Looks for tables that do not have - primary or unique key contraint. - * `list_table_fragmentation`: Displays table fragmentation in MySQL. - -## OceanBase - -* `--prebuilt` value: `oceanbase` -* **Environment Variables:** - * `OCEANBASE_HOST`: The hostname or IP address of the OceanBase server. - * `OCEANBASE_PORT`: The port number for the OceanBase server. - * `OCEANBASE_DATABASE`: The name of the database to connect to. - * `OCEANBASE_USER`: The database username. - * `OCEANBASE_PASSWORD`: The password for the database user. -* **Permissions:** - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - -## PostgreSQL - -* `--prebuilt` value: `postgres` -* **Environment Variables:** - * `POSTGRES_HOST`: (Optional) The hostname or IP address of the PostgreSQL server. - * `POSTGRES_PORT`: (Optional) The port number for the PostgreSQL server. - * `POSTGRES_DATABASE`: The name of the database to connect to. - * `POSTGRES_USER`: The database username. - * `POSTGRES_PASSWORD`: The password for the database user. - * `POSTGRES_QUERY_PARAMS`: (Optional) Raw query to be added to the db - connection string. -* **Permissions:** - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to - execute queries. -* **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 - database. - * `list_top_bloated_tables`: List top bloated tables in the database. - * `list_replication_slots`: Lists replication slots in the database. - * `list_invalid_indexes`: Lists invalid indexes in the database. - * `get_query_plan`: Generate the execution plan of a statement. - * `list_views`: Lists views in the database from pg_views with a default - limit of 50 rows. Returns schemaname, viewname and the ownername. - * `list_schemas`: Lists schemas in the database. - * `database_overview`: Fetches the current state of the PostgreSQL server. - * `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 - -* `--prebuilt` value: `serverless-spark` -* **Environment Variables:** - * `SERVERLESS_SPARK_PROJECT`: The GCP project ID - * `SERVERLESS_SPARK_LOCATION`: The GCP Location. -* **Permissions:** - * **Dataproc Serverless Viewer** (`roles/dataproc.serverlessViewer`) to - view serverless batches. - * **Dataproc Serverless Editor** (`roles/dataproc.serverlessEditor`) to - 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. - * `list_sessions`: Lists Spark sessions. - * `get_session`: Gets a Spark session. - * `get_session_template`: Gets a Spark session template. - -## 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) - -* `--prebuilt` value: `spanner` -* **Environment Variables:** - * `SPANNER_PROJECT`: The GCP project ID. - * `SPANNER_INSTANCE`: The Spanner instance ID. - * `SPANNER_DATABASE`: The Spanner database ID. -* **Permissions:** - * **Cloud Spanner Database Reader** (`roles/spanner.databaseReader`) to - execute DQL queries and list tables. - * **Cloud Spanner Database User** (`roles/spanner.databaseUser`) to - execute DML queries. -* **Tools:** - * `execute_sql`: Executes a DML SQL query. - * `execute_sql_dql`: Executes a DQL SQL query. - * `list_tables`: Lists tables in the database. - * `list_graphs`: Lists graphs in the database. - -## Spanner (PostgreSQL dialect) - -* `--prebuilt` value: `spanner-postgres` -* **Environment Variables:** - * `SPANNER_PROJECT`: The GCP project ID. - * `SPANNER_INSTANCE`: The Spanner instance ID. - * `SPANNER_DATABASE`: The Spanner database ID. -* **Permissions:** - * **Cloud Spanner Database Reader** (`roles/spanner.databaseReader`) to - execute DQL queries and list tables. - * **Cloud Spanner Database User** (`roles/spanner.databaseUser`) to - execute DML queries. -* **Tools:** - * `execute_sql`: Executes a DML SQL query using the PostgreSQL interface - for Spanner. - * `execute_sql_dql`: Executes a DQL SQL query using the PostgreSQL - interface for Spanner. - * `list_tables`: Lists tables in the database. - -## SQLite - -* `--prebuilt` value: `sqlite` -* **Environment Variables:** - * `SQLITE_DATABASE`: The path to the SQLite database file (e.g., - `./sample.db`). -* **Permissions:** - * File system read/write permissions for the specified database file. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - -## Neo4j - -* `--prebuilt` value: `neo4j` -* **Environment Variables:** - * `NEO4J_URI`: The URI of the Neo4j instance (e.g., - `bolt://localhost:7687`). - * `NEO4J_DATABASE`: The name of the Neo4j database to connect to. - * `NEO4J_USERNAME`: The username for the Neo4j instance. - * `NEO4J_PASSWORD`: The password for the Neo4j instance. -* **Permissions:** - * **Database-level permissions** are required to execute Cypher queries. -* **Tools:** - * `execute_cypher`: Executes a Cypher query. - * `get_schema`: Retrieves the schema of the Neo4j database. - -## Google Cloud Healthcare API -* `--prebuilt` value: `cloud-healthcare` -* **Environment Variables:** - * `CLOUD_HEALTHCARE_PROJECT`: The GCP project ID. - * `CLOUD_HEALTHCARE_REGION`: The Cloud Healthcare API dataset region. - * `CLOUD_HEALTHCARE_DATASET`: The Cloud Healthcare API dataset ID. - * `CLOUD_HEALTHCARE_USE_CLIENT_OAUTH`: (Optional) If `true`, forwards the client's - OAuth access token for authentication. Defaults to `false`. -* **Permissions:** - * **Healthcare FHIR Resource Reader** (`roles/healthcare.fhirResourceReader`) to read an - search FHIR resources. - * **Healthcare DICOM Viewer** (`roles/healthcare.dicomViewer`) to retrieve DICOM images from a - DICOM store. -* **Tools:** - * `get_dataset`: Gets information about a Cloud Healthcare API dataset. - * `list_dicom_stores`: Lists DICOM stores in a Cloud Healthcare API dataset. - * `list_fhir_stores`: Lists FHIR stores in a Cloud Healthcare API dataset. - * `get_fhir_store`: Gets information about a FHIR store. - * `get_fhir_store_metrics`: Gets metrics for a FHIR store. - * `get_fhir_resource`: Gets a FHIR resource from a FHIR store. - * `fhir_patient_search`: Searches for patient resource(s) based on a set of criteria. - * `fhir_patient_everything`: Retrieves resources related to a given patient. - * `fhir_fetch_page`: Fetches a page of FHIR resources. - * `get_dicom_store`: Gets information about a DICOM store. - * `get_dicom_store_metrics`: Gets metrics for a DICOM store. - * `search_dicom_studies`: Searches for DICOM studies. - * `search_dicom_series`: Searches for DICOM series. - * `search_dicom_instances`: Searches for DICOM instances. - * `retrieve_rendered_dicom_instance`: Retrieves a rendered DICOM instance. - -## Oracle - -* `--prebuilt` value: `oracledb` -* **Environment Variables:** - - * `ORACLE_CONNECTION_STRING`: The connection string for the Oracle server (e.g., "hostname:port/servicename"). - * `ORACLE_USERNAME`: The database username. - * `ORACLE_PASSWORD`: The password for the database user. - * `ORACLE_WALLET`: The path to the Oracle DB Wallet file for databases that support this authentication type. - * `ORACLE_USE_OCI`: A boolean flag (`true` or `false`) indicating whether to use the OCI-based driver. Setting to `true` is required for features like Oracle Wallet and requires the Oracle Instant Client libraries to be installed. -* **Permissions:** - * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to execute queries. - * For queries on DBA views like `dba_data_files` and `dba_free_space`, access typically requires elevated database privileges (like `SELECT_CATALOG_ROLE` or direct grants) that a standard user may not have. -* **Tools:** - * `execute_sql`: Executes a SQL query. - * `list_tables`: Lists tables in the database. - * `list_active_sessions`: Lists active database sessions. - * `get_query_plan`: Generate a full execution plan for a single SQL statement. - * `list_top_sql_by_resource`: Lists top SQL statements by resource usage. - * `list_tablespace_usage`: Lists tablespace usage. - * `list_invalid_objects`: Lists invalid objects. +{{< list-prebuilt-configs >}} diff --git a/docs/en/integrations/alloydb-admin/prebuilt-configs/_index.md b/docs/en/integrations/alloydb-admin/prebuilt-configs/_index.md new file mode 100644 index 000000000000..e6907b52e1e7 --- /dev/null +++ b/docs/en/integrations/alloydb-admin/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Alloydb Admin." +--- diff --git a/docs/en/integrations/alloydb-admin/prebuilt-configs/alloydb-postgres-admin.md b/docs/en/integrations/alloydb-admin/prebuilt-configs/alloydb-postgres-admin.md new file mode 100644 index 000000000000..4c0565927645 --- /dev/null +++ b/docs/en/integrations/alloydb-admin/prebuilt-configs/alloydb-postgres-admin.md @@ -0,0 +1,26 @@ +--- +title: "AlloyDB Postgres Admin" +type: docs +description: "Details of the AlloyDB Postgres Admin prebuilt configuration." +--- + +## AlloyDB Postgres Admin + +* `--prebuilt` value: `alloydb-postgres-admin` +* **Permissions:** + * **AlloyDB Viewer** (`roles/alloydb.viewer`) is required for `list` and + `get` tools. + * **AlloyDB Admin** (`roles/alloydb.admin`) is required for `create` tools. +* **Tools:** + * `create_cluster`: Creates a new AlloyDB cluster. + * `list_clusters`: Lists all AlloyDB clusters in a project. + * `get_cluster`: Gets information about a specified AlloyDB cluster. + * `create_instance`: Creates a new AlloyDB instance within a cluster. + * `list_instances`: Lists all instances within an AlloyDB cluster. + * `get_instance`: Gets information about a specified AlloyDB instance. + * `create_user`: Creates a new database user in an AlloyDB cluster. + * `list_users`: Lists all database users within an AlloyDB cluster. + * `get_user`: Gets information about a specified database user in an + AlloyDB cluster. + * `wait_for_operation`: Polls the operations API to track the status of + long-running operations. diff --git a/docs/en/integrations/alloydb/prebuilt-configs/_index.md b/docs/en/integrations/alloydb/prebuilt-configs/_index.md new file mode 100644 index 000000000000..27a229cc309f --- /dev/null +++ b/docs/en/integrations/alloydb/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Alloydb." +--- diff --git a/docs/en/integrations/alloydb/prebuilt-configs/alloydb-postgres.md b/docs/en/integrations/alloydb/prebuilt-configs/alloydb-postgres.md new file mode 100644 index 000000000000..f2a16a1af265 --- /dev/null +++ b/docs/en/integrations/alloydb/prebuilt-configs/alloydb-postgres.md @@ -0,0 +1,59 @@ +--- +title: "AlloyDB Postgres" +type: docs +description: "Details of the AlloyDB Postgres prebuilt configuration." +--- + +## AlloyDB Postgres + +* `--prebuilt` value: `alloydb-postgres` +* **Environment Variables:** + * `ALLOYDB_POSTGRES_PROJECT`: The GCP project ID. + * `ALLOYDB_POSTGRES_REGION`: The region of your AlloyDB instance. + * `ALLOYDB_POSTGRES_CLUSTER`: The ID of your AlloyDB cluster. + * `ALLOYDB_POSTGRES_INSTANCE`: The ID of your AlloyDB instance. + * `ALLOYDB_POSTGRES_DATABASE`: The name of the database to connect to. + * `ALLOYDB_POSTGRES_USER`: (Optional) The database username. Defaults to + IAM authentication if unspecified. + * `ALLOYDB_POSTGRES_PASSWORD`: (Optional) The password for the database + user. Defaults to IAM authentication if unspecified. + * `ALLOYDB_POSTGRES_IP_TYPE`: (Optional) The IP type i.e. "Public" or + "Private" (Default: Public). +* **Permissions:** + * **AlloyDB Client** (`roles/alloydb.client`) to connect to the instance. + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **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 + database. + * `list_top_bloated_tables`: List top bloated tables in the database. + * `list_replication_slots`: Lists replication slots in the database. + * `list_invalid_indexes`: Lists invalid indexes in the database. + * `get_query_plan`: Generate the execution plan of a statement. + * `list_views`: Lists views in the database from pg_views with a default + limit of 50 rows. Returns schemaname, viewname and the ownername. + * `list_schemas`: Lists schemas in the database. + * `database_overview`: Fetches the current state of the PostgreSQL server. + * `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. diff --git a/docs/en/integrations/bigquery/prebuilt-configs/_index.md b/docs/en/integrations/bigquery/prebuilt-configs/_index.md new file mode 100644 index 000000000000..e46051db1d4b --- /dev/null +++ b/docs/en/integrations/bigquery/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Bigquery." +--- diff --git a/docs/en/integrations/bigquery/prebuilt-configs/bigquery.md b/docs/en/integrations/bigquery/prebuilt-configs/bigquery.md new file mode 100644 index 000000000000..70d37d23bcff --- /dev/null +++ b/docs/en/integrations/bigquery/prebuilt-configs/bigquery.md @@ -0,0 +1,41 @@ +--- +title: "BigQuery" +type: docs +description: "Details of the BigQuery prebuilt configuration." +--- + +## BigQuery + +* `--prebuilt` value: `bigquery` +* **Environment Variables:** + * `BIGQUERY_PROJECT`: The GCP project ID. + * `BIGQUERY_LOCATION`: (Optional) The dataset location. + * `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) If `true`, forwards the client's + OAuth access token for authentication. Defaults to `false`. + * `BIGQUERY_SCOPES`: (Optional) A comma-separated list of OAuth scopes to + use for authentication. +* **Permissions:** + * **BigQuery User** (`roles/bigquery.user`) to execute queries and view + metadata. + * **BigQuery Metadata Viewer** (`roles/bigquery.metadataViewer`) to view + all datasets. + * **BigQuery Data Editor** (`roles/bigquery.dataEditor`) to create or + modify datasets and tables. + * **Gemini for Google Cloud** (`roles/cloudaicompanion.user`) to use the + conversational analytics API. +* **Tools:** + * `analyze_contribution`: Use this tool to perform contribution analysis, + also called key driver analysis. + * `ask_data_insights`: Use this tool to perform data analysis, get + insights, or answer complex questions about the contents of specific + BigQuery tables. For more information on required roles, API setup, and + IAM configuration, see the setup and authentication section of the + [Conversational Analytics API + documentation](https://cloud.google.com/gemini/docs/conversational-analytics-api/overview). + * `execute_sql`: Executes a SQL statement. + * `forecast`: Use this tool to forecast time series data. + * `get_dataset_info`: Gets dataset metadata. + * `get_table_info`: Gets table metadata. + * `list_dataset_ids`: Lists datasets. + * `list_table_ids`: Lists tables. + * `search_catalog`: Search for entries based on the provided query. diff --git a/docs/en/integrations/clickhouse/prebuilt-configs/_index.md b/docs/en/integrations/clickhouse/prebuilt-configs/_index.md new file mode 100644 index 000000000000..6df4f8b6546f --- /dev/null +++ b/docs/en/integrations/clickhouse/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Clickhouse." +--- diff --git a/docs/en/integrations/clickhouse/prebuilt-configs/clickhouse.md b/docs/en/integrations/clickhouse/prebuilt-configs/clickhouse.md new file mode 100644 index 000000000000..08b6e462b382 --- /dev/null +++ b/docs/en/integrations/clickhouse/prebuilt-configs/clickhouse.md @@ -0,0 +1,20 @@ +--- +title: "ClickHouse" +type: docs +description: "Details of the ClickHouse prebuilt configuration." +--- + +## 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. diff --git a/docs/en/integrations/cloud-sql-admin/prebuilt-configs/_index.md b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/_index.md new file mode 100644 index 000000000000..f311ad5ac9e9 --- /dev/null +++ b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Sql Admin." +--- diff --git a/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-mysql-admin.md b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-mysql-admin.md new file mode 100644 index 000000000000..ed2e3b850086 --- /dev/null +++ b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-mysql-admin.md @@ -0,0 +1,40 @@ +--- +title: "Cloud SQL for MySQL Admin" +type: docs +description: "Details of the Cloud SQL for MySQL Admin prebuilt configuration." +--- + +## Cloud SQL for MySQL Admin + +* `--prebuilt` value: `cloud-sql-mysql-admin` +* **Permissions:** + * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only + access to resources. + * `get_instance` + * `list_instances` + * `list_databases` + * `wait_for_operation` + * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to + manage existing resources. + * All `viewer` tools + * `create_database` + * `create_backup` + * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over + all resources. + * All `editor` and `viewer` tools + * `create_instance` + * `create_user` + * `clone_instance` + * `restore_backup` + +* **Tools:** + * `create_instance`: Creates a new Cloud SQL for MySQL instance. + * `get_instance`: Gets information about a Cloud SQL instance. + * `list_instances`: Lists Cloud SQL instances in a project. + * `create_database`: Creates a new database in a Cloud SQL instance. + * `list_databases`: Lists all databases for a Cloud SQL instance. + * `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 MySQL instance. + * `create_backup`: Creates a backup on a Cloud SQL instance. + * `restore_backup`: Restores a backup of a Cloud SQL instance. diff --git a/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-postgresql-admin.md b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-postgresql-admin.md new file mode 100644 index 000000000000..617cfc5787ad --- /dev/null +++ b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-postgresql-admin.md @@ -0,0 +1,40 @@ +--- +title: "Cloud SQL for PostgreSQL Admin" +type: docs +description: "Details of the Cloud SQL for PostgreSQL Admin prebuilt configuration." +--- + +## Cloud SQL for PostgreSQL Admin + +* `--prebuilt` value: `cloud-sql-postgres-admin` +* **Permissions:** + * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only + access to resources. + * `get_instance` + * `list_instances` + * `list_databases` + * `wait_for_operation` + * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to + manage existing resources. + * All `viewer` tools + * `create_database` + * `create_backup` + * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over + all resources. + * All `editor` and `viewer` tools + * `create_instance` + * `create_user` + * `clone_instance` + * `restore_backup` +* **Tools:** + * `create_instance`: Creates a new Cloud SQL for PostgreSQL instance. + * `get_instance`: Gets information about a Cloud SQL instance. + * `list_instances`: Lists Cloud SQL instances in a project. + * `create_database`: Creates a new database in a Cloud SQL instance. + * `list_databases`: Lists all databases for a Cloud SQL instance. + * `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. diff --git a/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-sql-server-admin.md b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-sql-server-admin.md new file mode 100644 index 000000000000..69a168dcc1ae --- /dev/null +++ b/docs/en/integrations/cloud-sql-admin/prebuilt-configs/cloud-sql-for-sql-server-admin.md @@ -0,0 +1,39 @@ +--- +title: "Cloud SQL for SQL Server Admin" +type: docs +description: "Details of the Cloud SQL for SQL Server Admin prebuilt configuration." +--- + +## Cloud SQL for SQL Server Admin + +* `--prebuilt` value: `cloud-sql-mssql-admin` +* **Permissions:** + * **Cloud SQL Viewer** (`roles/cloudsql.viewer`): Provides read-only + access to resources. + * `get_instance` + * `list_instances` + * `list_databases` + * `wait_for_operation` + * **Cloud SQL Editor** (`roles/cloudsql.editor`): Provides permissions to + manage existing resources. + * All `viewer` tools + * `create_database` + * `create_backup` + * **Cloud SQL Admin** (`roles/cloudsql.admin`): Provides full control over + all resources. + * All `editor` and `viewer` tools + * `create_instance` + * `create_user` + * `clone_instance` + * `restore_backup` +* **Tools:** + * `create_instance`: Creates a new Cloud SQL for SQL Server instance. + * `get_instance`: Gets information about a Cloud SQL instance. + * `list_instances`: Lists Cloud SQL instances in a project. + * `create_database`: Creates a new database in a Cloud SQL instance. + * `list_databases`: Lists all databases for a Cloud SQL instance. + * `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 SQL Server instance. + * `create_backup`: Creates a backup on a Cloud SQL instance. + * `restore_backup`: Restores a backup of a Cloud SQL instance. diff --git a/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/_index.md b/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/_index.md new file mode 100644 index 000000000000..213a3d905eaa --- /dev/null +++ b/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Sql Mssql." +--- diff --git a/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/cloud-sql-for-sql-server.md b/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/cloud-sql-for-sql-server.md new file mode 100644 index 000000000000..1c441246268f --- /dev/null +++ b/docs/en/integrations/cloud-sql-mssql/prebuilt-configs/cloud-sql-for-sql-server.md @@ -0,0 +1,26 @@ +--- +title: "Cloud SQL for SQL Server" +type: docs +description: "Details of the Cloud SQL for SQL Server prebuilt configuration." +--- + +## Cloud SQL for SQL Server + +* `--prebuilt` value: `cloud-sql-mssql` +* **Environment Variables:** + * `CLOUD_SQL_MSSQL_PROJECT`: The GCP project ID. + * `CLOUD_SQL_MSSQL_REGION`: The region of your Cloud SQL instance. + * `CLOUD_SQL_MSSQL_INSTANCE`: The ID of your Cloud SQL instance. + * `CLOUD_SQL_MSSQL_DATABASE`: The name of the database to connect to. + * `CLOUD_SQL_MSSQL_USER`: The database username. + * `CLOUD_SQL_MSSQL_PASSWORD`: The password for the database user. + * `CLOUD_SQL_MSSQL_IP_TYPE`: (Optional) The IP type i.e. "Public" or + "Private" (Default: Public). +* **Permissions:** + * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the + instance. + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. diff --git a/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/_index.md b/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/_index.md new file mode 100644 index 000000000000..5b152e52b1b0 --- /dev/null +++ b/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Sql Mysql." +--- diff --git a/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/cloud-sql-for-mysql.md b/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/cloud-sql-for-mysql.md new file mode 100644 index 000000000000..594fb3d33008 --- /dev/null +++ b/docs/en/integrations/cloud-sql-mysql/prebuilt-configs/cloud-sql-for-mysql.md @@ -0,0 +1,32 @@ +--- +title: "Cloud SQL for MySQL" +type: docs +description: "Details of the Cloud SQL for MySQL prebuilt configuration." +--- + +## Cloud SQL for MySQL + +* `--prebuilt` value: `cloud-sql-mysql` +* **Environment Variables:** + * `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. + * `CLOUD_SQL_MYSQL_REGION`: The region of your Cloud SQL instance. + * `CLOUD_SQL_MYSQL_INSTANCE`: The ID of your Cloud SQL instance. + * `CLOUD_SQL_MYSQL_DATABASE`: The name of the database to connect to. + * `CLOUD_SQL_MYSQL_USER`: The database username. + * `CLOUD_SQL_MYSQL_PASSWORD`: The password for the database user. + * `CLOUD_SQL_MYSQL_IP_TYPE`: The IP type i.e. "Public + or "Private" (Default: Public). +* **Permissions:** + * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the + instance. + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. + * `get_query_plan`: Provides information about how MySQL executes a SQL + statement. + * `list_active_queries`: Lists ongoing queries. + * `list_tables_missing_unique_indexes`: Looks for tables that do not have + primary or unique key contraint. + * `list_table_fragmentation`: Displays table fragmentation in MySQL. diff --git a/docs/en/integrations/cloud-sql-pg/prebuilt-configs/_index.md b/docs/en/integrations/cloud-sql-pg/prebuilt-configs/_index.md new file mode 100644 index 000000000000..fe0c08d245ef --- /dev/null +++ b/docs/en/integrations/cloud-sql-pg/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Sql Postgres." +--- diff --git a/docs/en/integrations/cloud-sql-pg/prebuilt-configs/cloud-sql-for-postgresql.md b/docs/en/integrations/cloud-sql-pg/prebuilt-configs/cloud-sql-for-postgresql.md new file mode 100644 index 000000000000..120486d1e789 --- /dev/null +++ b/docs/en/integrations/cloud-sql-pg/prebuilt-configs/cloud-sql-for-postgresql.md @@ -0,0 +1,59 @@ +--- +title: "Cloud SQL for PostgreSQL" +type: docs +description: "Details of the Cloud SQL for PostgreSQL prebuilt configuration." +--- + +## Cloud SQL for PostgreSQL + +* `--prebuilt` value: `cloud-sql-postgres` +* **Environment Variables:** + * `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID. + * `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance. + * `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance. + * `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to. + * `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username. Defaults to + IAM authentication if unspecified. + * `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database + user. Defaults to IAM authentication if unspecified. + * `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) The IP type i.e. "Public" or + "Private" (Default: Public). +* **Permissions:** + * **Cloud SQL Client** (`roles/cloudsql.client`) to connect to the + instance. + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **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 + database. + * `list_top_bloated_tables`: List top bloated tables in the database. + * `list_replication_slots`: Lists replication slots in the database. + * `list_invalid_indexes`: Lists invalid indexes in the database. + * `get_query_plan`: Generate the execution plan of a statement. + * `list_views`: Lists views in the database from pg_views with a default + limit of 50 rows. Returns schemaname, viewname and the ownername. + * `list_schemas`: Lists schemas in the database. + * `database_overview`: Fetches the current state of the PostgreSQL server. + * `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. diff --git a/docs/en/integrations/cloudhealthcare/prebuilt-configs/_index.md b/docs/en/integrations/cloudhealthcare/prebuilt-configs/_index.md new file mode 100644 index 000000000000..344335915a94 --- /dev/null +++ b/docs/en/integrations/cloudhealthcare/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Healthcare." +--- diff --git a/docs/en/integrations/cloudhealthcare/prebuilt-configs/google-cloud-healthcare-api.md b/docs/en/integrations/cloudhealthcare/prebuilt-configs/google-cloud-healthcare-api.md new file mode 100644 index 000000000000..9299a99d279d --- /dev/null +++ b/docs/en/integrations/cloudhealthcare/prebuilt-configs/google-cloud-healthcare-api.md @@ -0,0 +1,35 @@ +--- +title: "Google Cloud Healthcare API" +type: docs +description: "Details of the Google Cloud Healthcare API prebuilt configuration." +--- + +## Google Cloud Healthcare API +* `--prebuilt` value: `cloud-healthcare` +* **Environment Variables:** + * `CLOUD_HEALTHCARE_PROJECT`: The GCP project ID. + * `CLOUD_HEALTHCARE_REGION`: The Cloud Healthcare API dataset region. + * `CLOUD_HEALTHCARE_DATASET`: The Cloud Healthcare API dataset ID. + * `CLOUD_HEALTHCARE_USE_CLIENT_OAUTH`: (Optional) If `true`, forwards the client's + OAuth access token for authentication. Defaults to `false`. +* **Permissions:** + * **Healthcare FHIR Resource Reader** (`roles/healthcare.fhirResourceReader`) to read an + search FHIR resources. + * **Healthcare DICOM Viewer** (`roles/healthcare.dicomViewer`) to retrieve DICOM images from a + DICOM store. +* **Tools:** + * `get_dataset`: Gets information about a Cloud Healthcare API dataset. + * `list_dicom_stores`: Lists DICOM stores in a Cloud Healthcare API dataset. + * `list_fhir_stores`: Lists FHIR stores in a Cloud Healthcare API dataset. + * `get_fhir_store`: Gets information about a FHIR store. + * `get_fhir_store_metrics`: Gets metrics for a FHIR store. + * `get_fhir_resource`: Gets a FHIR resource from a FHIR store. + * `fhir_patient_search`: Searches for patient resource(s) based on a set of criteria. + * `fhir_patient_everything`: Retrieves resources related to a given patient. + * `fhir_fetch_page`: Fetches a page of FHIR resources. + * `get_dicom_store`: Gets information about a DICOM store. + * `get_dicom_store_metrics`: Gets metrics for a DICOM store. + * `search_dicom_studies`: Searches for DICOM studies. + * `search_dicom_series`: Searches for DICOM series. + * `search_dicom_instances`: Searches for DICOM instances. + * `retrieve_rendered_dicom_instance`: Retrieves a rendered DICOM instance. diff --git a/docs/en/integrations/cloudmonitoring/prebuilt-configs/_index.md b/docs/en/integrations/cloudmonitoring/prebuilt-configs/_index.md new file mode 100644 index 000000000000..587e25f3d6dc --- /dev/null +++ b/docs/en/integrations/cloudmonitoring/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Cloud Monitoring." +--- diff --git a/docs/en/integrations/cloudmonitoring/prebuilt-configs/alloydb-postgres-observability.md b/docs/en/integrations/cloudmonitoring/prebuilt-configs/alloydb-postgres-observability.md new file mode 100644 index 000000000000..8b8392099305 --- /dev/null +++ b/docs/en/integrations/cloudmonitoring/prebuilt-configs/alloydb-postgres-observability.md @@ -0,0 +1,18 @@ +--- +title: "AlloyDB Postgres Observability" +type: docs +description: "Details of the AlloyDB Postgres Observability prebuilt configuration." +--- + +## AlloyDB Postgres Observability + +* `--prebuilt` value: `alloydb-postgres-observability` +* **Permissions:** + * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the + project to view monitoring data. +* **Tools:** + * `get_system_metrics`: Fetches system level cloud monitoring data + (timeseries metrics) for an AlloyDB instance using a PromQL query. + * `get_query_metrics`: Fetches query level cloud monitoring data + (timeseries metrics) for queries running in an AlloyDB instance using a + PromQL query. diff --git a/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-mysql-observability.md b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-mysql-observability.md new file mode 100644 index 000000000000..fe4485127ffc --- /dev/null +++ b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-mysql-observability.md @@ -0,0 +1,18 @@ +--- +title: "Cloud SQL for MySQL Observability" +type: docs +description: "Details of the Cloud SQL for MySQL Observability prebuilt configuration." +--- + +## Cloud SQL for MySQL Observability + +* `--prebuilt` value: `cloud-sql-mysql-observability` +* **Permissions:** + * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the + project to view monitoring data. +* **Tools:** + * `get_system_metrics`: Fetches system level cloud monitoring data + (timeseries metrics) for a MySQL instance using a PromQL query. + * `get_query_metrics`: Fetches query level cloud monitoring data + (timeseries metrics) for queries running in a MySQL instance using a + PromQL query. diff --git a/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-postgresql-observability.md b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-postgresql-observability.md new file mode 100644 index 000000000000..753648d3bc01 --- /dev/null +++ b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-postgresql-observability.md @@ -0,0 +1,18 @@ +--- +title: "Cloud SQL for PostgreSQL Observability" +type: docs +description: "Details of the Cloud SQL for PostgreSQL Observability prebuilt configuration." +--- + +## Cloud SQL for PostgreSQL Observability + +* `--prebuilt` value: `cloud-sql-postgres-observability` +* **Permissions:** + * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the + project to view monitoring data. +* **Tools:** + * `get_system_metrics`: Fetches system level cloud monitoring data + (timeseries metrics) for a Postgres instance using a PromQL query. + * `get_query_metrics`: Fetches query level cloud monitoring data + (timeseries metrics) for queries running in Postgres instance using a + PromQL query. diff --git a/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-sql-server-observability.md b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-sql-server-observability.md new file mode 100644 index 000000000000..3622ae9299a9 --- /dev/null +++ b/docs/en/integrations/cloudmonitoring/prebuilt-configs/cloud-sql-for-sql-server-observability.md @@ -0,0 +1,15 @@ +--- +title: "Cloud SQL for SQL Server Observability" +type: docs +description: "Details of the Cloud SQL for SQL Server Observability prebuilt configuration." +--- + +## Cloud SQL for SQL Server Observability + +* `--prebuilt` value: `cloud-sql-mssql-observability` +* **Permissions:** + * **Monitoring Viewer** (`roles/monitoring.viewer`) is required on the + project to view monitoring data. +* **Tools:** + * `get_system_metrics`: Fetches system level cloud monitoring data + (timeseries metrics) for a SQL Server instance using a PromQL query. diff --git a/docs/en/integrations/dataplex/prebuilt-configs/_index.md b/docs/en/integrations/dataplex/prebuilt-configs/_index.md new file mode 100644 index 000000000000..a48730323e58 --- /dev/null +++ b/docs/en/integrations/dataplex/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Dataplex." +--- diff --git a/docs/en/integrations/dataplex/prebuilt-configs/dataplex.md b/docs/en/integrations/dataplex/prebuilt-configs/dataplex.md new file mode 100644 index 000000000000..04078446aa75 --- /dev/null +++ b/docs/en/integrations/dataplex/prebuilt-configs/dataplex.md @@ -0,0 +1,21 @@ +--- +title: "Dataplex" +type: docs +description: "Details of the Dataplex prebuilt configuration." +--- + +## Dataplex + +* `--prebuilt` value: `dataplex` +* **Environment Variables:** + * `DATAPLEX_PROJECT`: The GCP project ID. +* **Permissions:** + * **Dataplex Reader** (`roles/dataplex.viewer`) to search and look up + entries. + * **Dataplex Editor** (`roles/dataplex.editor`) to modify entries. +* **Tools:** + * `search_entries`: Searches for entries in Dataplex Catalog. + * `lookup_entry`: Retrieves a specific entry from Dataplex + Catalog. + * `search_aspect_types`: Finds aspect types relevant to the + query. diff --git a/docs/en/integrations/dataproc/prebuilt-configs/_index.md b/docs/en/integrations/dataproc/prebuilt-configs/_index.md new file mode 100644 index 000000000000..a1879187db7b --- /dev/null +++ b/docs/en/integrations/dataproc/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Dataproc." +--- diff --git a/docs/en/integrations/dataproc/prebuilt-configs/dataproc.md b/docs/en/integrations/dataproc/prebuilt-configs/dataproc.md new file mode 100644 index 000000000000..32977f6b94b6 --- /dev/null +++ b/docs/en/integrations/dataproc/prebuilt-configs/dataproc.md @@ -0,0 +1,19 @@ +--- +title: "Dataproc" +type: docs +description: "Details of the Dataproc prebuilt configuration." +--- + +## Dataproc + +* `--prebuilt` value: `dataproc` +* **Environment Variables:** + * `DATAPROC_PROJECT`: The GCP project ID. + * `DATAPROC_REGION`: The Dataproc region. +* **Permissions:** + * **Dataproc Viewer** (`roles/dataproc.viewer`) to examine clusters and jobs. +* **Tools:** + * `list_clusters`: Lists Dataproc clusters. + * `get_cluster`: Gets a Dataproc cluster. + * `list_jobs`: Lists Dataproc jobs. + * `get_job`: Gets a Dataproc job. diff --git a/docs/en/integrations/elasticsearch/prebuilt-configs/_index.md b/docs/en/integrations/elasticsearch/prebuilt-configs/_index.md new file mode 100644 index 000000000000..1c4a01edff91 --- /dev/null +++ b/docs/en/integrations/elasticsearch/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Elasticsearch." +--- diff --git a/docs/en/integrations/elasticsearch/prebuilt-configs/elasticsearch.md b/docs/en/integrations/elasticsearch/prebuilt-configs/elasticsearch.md new file mode 100644 index 000000000000..ee23195e6172 --- /dev/null +++ b/docs/en/integrations/elasticsearch/prebuilt-configs/elasticsearch.md @@ -0,0 +1,14 @@ +--- +title: "Elasticsearch" +type: docs +description: "Details of the Elasticsearch prebuilt configuration." +--- + +## 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. diff --git a/docs/en/integrations/firestore/prebuilt-configs/_index.md b/docs/en/integrations/firestore/prebuilt-configs/_index.md new file mode 100644 index 000000000000..52b2e9098fa3 --- /dev/null +++ b/docs/en/integrations/firestore/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Firestore." +--- diff --git a/docs/en/integrations/firestore/prebuilt-configs/firestore.md b/docs/en/integrations/firestore/prebuilt-configs/firestore.md new file mode 100644 index 000000000000..a1134574dfe0 --- /dev/null +++ b/docs/en/integrations/firestore/prebuilt-configs/firestore.md @@ -0,0 +1,29 @@ +--- +title: "Firestore" +type: docs +description: "Details of the Firestore prebuilt configuration." +--- + +## Firestore + +* `--prebuilt` value: `firestore` +* **Environment Variables:** + * `FIRESTORE_PROJECT`: The GCP project ID. + * `FIRESTORE_DATABASE`: (Optional) The Firestore database ID. Defaults to + "(default)". +* **Permissions:** + * **Cloud Datastore User** (`roles/datastore.user`) to get documents, list + collections, and query collections. + * **Firebase Rules Viewer** (`roles/firebaserules.viewer`) to get and + validate Firestore rules. +* **Tools:** + * `get_documents`: Gets multiple documents from Firestore by their paths. + * `add_documents`: Adds a new document to a Firestore collection. + * `update_document`: Updates an existing document in Firestore. + * `list_collections`: Lists Firestore collections for a given parent path. + * `delete_documents`: Deletes multiple documents from Firestore. + * `query_collection`: Retrieves one or more Firestore documents from a + collection. + * `get_rules`: Retrieves the active Firestore security rules. + * `validate_rules`: Checks the provided Firestore Rules source for syntax + and validation errors. diff --git a/docs/en/integrations/looker/prebuilt-configs/_index.md b/docs/en/integrations/looker/prebuilt-configs/_index.md new file mode 100644 index 000000000000..00a9ac676c31 --- /dev/null +++ b/docs/en/integrations/looker/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Looker." +--- diff --git a/docs/en/integrations/looker/prebuilt-configs/looker-conversational-analytics.md b/docs/en/integrations/looker/prebuilt-configs/looker-conversational-analytics.md new file mode 100644 index 000000000000..400ca8e04288 --- /dev/null +++ b/docs/en/integrations/looker/prebuilt-configs/looker-conversational-analytics.md @@ -0,0 +1,31 @@ +--- +title: "Looker Conversational Analytics" +type: docs +description: "Details of the Looker Conversational Analytics prebuilt configuration." +--- + +## Looker Conversational Analytics + +* `--prebuilt` value: `looker-conversational-analytics` +* **Environment Variables:** + * `LOOKER_BASE_URL`: The URL of your Looker instance. + * `LOOKER_CLIENT_ID`: The client ID for the Looker API. + * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. + * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. + * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. + * `LOOKER_PROJECT`: The GCP Project to use for Conversational Analytics. + * `LOOKER_LOCATION`: The GCP Location to use for Conversational Analytics. +* **Permissions:** + * A Looker account with permissions to access the desired models, + explores, and data is required. + * **Looker Instance User** (`roles/looker.instanceUser`): IAM role to + access Looker. + * **Gemini for Google Cloud User** (`roles/cloudaicompanion.user`): IAM + role to access Conversational Analytics. + * **Gemini Data Analytics Stateless Chat User (Beta)** + (`roles/geminidataanalytics.dataAgentStatelessUser`): IAM role to + access Conversational Analytics. +* **Tools:** + * `ask_data_insights`: Ask a question of the data. + * `get_models`: Retrieves the list of LookML models. + * `get_explores`: Retrieves the list of explores in a model. diff --git a/docs/en/integrations/looker/prebuilt-configs/looker-dev.md b/docs/en/integrations/looker/prebuilt-configs/looker-dev.md new file mode 100644 index 000000000000..d847ca6bfe93 --- /dev/null +++ b/docs/en/integrations/looker/prebuilt-configs/looker-dev.md @@ -0,0 +1,46 @@ +--- +title: "Looker Dev" +type: docs +description: "Details of the Looker Dev prebuilt configuration." +--- + +## Looker Dev + +* `--prebuilt` value: `looker-dev` +* Almost always used in combination with Looker, `--prebuilt looker,looker-dev` +* **Environment Variables:** + * `LOOKER_BASE_URL`: The URL of your Looker instance. + * `LOOKER_CLIENT_ID`: The client ID for the Looker API. + * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. + * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. + * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. + * `LOOKER_SHOW_HIDDEN_MODELS`: Whether to show hidden models. + * `LOOKER_SHOW_HIDDEN_EXPLORES`: Whether to show hidden explores. + * `LOOKER_SHOW_HIDDEN_FIELDS`: Whether to show hidden fields. +* **Permissions:** + * A Looker account with permissions to access the desired projects + and LookML is required. +* **Tools:** + * `health_pulse`: Test the health of a Looker instance. + * `health_analyze`: Analyze the LookML usage of a Looker instance. + * `health_vacuum`: Suggest LookML elements that can be removed. + * `dev_mode`: Activate developer mode. + * `get_projects`: Get the LookML projects in a Looker instance. + * `get_project_files`: List the project files in a project. + * `get_project_file`: Get the content of a LookML file. + * `create_project_file`: Create a new LookML file. + * `update_project_file`: Update an existing LookML file. + * `delete_project_file`: Delete a LookML file. + * `get_project_directories`: Retrieves a list of project directories for a given LookML project. + * `create_project_directory`: Creates a new directory within a specified LookML project. + * `delete_project_directory`: Deletes a directory from a specified LookML project. + * `validate_project`: Check the syntax of a LookML project. + * `get_connections`: Get the available connections in a Looker instance. + * `get_connection_schemas`: Get the available schemas in a connection. + * `get_connection_databases`: Get the available databases in a connection. + * `get_connection_tables`: Get the available tables in a connection. + * `get_connection_table_columns`: Get the available columns for a table. + * `get_lookml_tests`: Retrieves a list of available LookML tests for a project. + * `run_lookml_tests`: Executes specific LookML tests within a project. + * `create_view_from_table`: Generates boilerplate LookML views directly from the database schema. + * `project_git_branch`: Fetch and manipulate the git branch of a LookML project. diff --git a/docs/en/integrations/looker/prebuilt-configs/looker.md b/docs/en/integrations/looker/prebuilt-configs/looker.md new file mode 100644 index 000000000000..bd535c20fdf6 --- /dev/null +++ b/docs/en/integrations/looker/prebuilt-configs/looker.md @@ -0,0 +1,40 @@ +--- +title: "Looker" +type: docs +description: "Details of the Looker prebuilt configuration." +--- + +## Looker + +* `--prebuilt` value: `looker` +* **Environment Variables:** + * `LOOKER_BASE_URL`: The URL of your Looker instance. + * `LOOKER_CLIENT_ID`: The client ID for the Looker API. + * `LOOKER_CLIENT_SECRET`: The client secret for the Looker API. + * `LOOKER_VERIFY_SSL`: Whether to verify SSL certificates. + * `LOOKER_USE_CLIENT_OAUTH`: Whether to use OAuth for authentication. + * `LOOKER_SHOW_HIDDEN_MODELS`: Whether to show hidden models. + * `LOOKER_SHOW_HIDDEN_EXPLORES`: Whether to show hidden explores. + * `LOOKER_SHOW_HIDDEN_FIELDS`: Whether to show hidden fields. +* **Permissions:** + * A Looker account with permissions to access the desired models, + explores, and data is required. +* **Tools:** + * `get_models`: Retrieves the list of LookML models. + * `get_explores`: Retrieves the list of explores in a model. + * `get_dimensions`: Retrieves the list of dimensions in an explore. + * `get_measures`: Retrieves the list of measures in an explore. + * `get_filters`: Retrieves the list of filters in an explore. + * `get_parameters`: Retrieves the list of parameters in an explore. + * `query`: Runs a query against the LookML model. + * `query_sql`: Generates the SQL for a query. + * `query_url`: Generates a URL for a query in Looker. + * `get_looks`: Searches for saved looks. + * `run_look`: Runs the query associated with a look. + * `make_look`: Creates a new look. + * `get_dashboards`: Searches for saved dashboards. + * `run_dashboard`: Runs the queries associated with a dashboard. + * `make_dashboard`: Creates a new dashboard. + * `add_dashboard_element`: Adds a tile to a dashboard. + * `add_dashboard_filter`: Adds a filter to a dashboard. + * `generate_embed_url`: Generate an embed url for content. diff --git a/docs/en/integrations/mindsdb/prebuilt-configs/_index.md b/docs/en/integrations/mindsdb/prebuilt-configs/_index.md new file mode 100644 index 000000000000..912c0423e240 --- /dev/null +++ b/docs/en/integrations/mindsdb/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Mindsdb." +--- diff --git a/docs/en/integrations/mindsdb/prebuilt-configs/mindsdb.md b/docs/en/integrations/mindsdb/prebuilt-configs/mindsdb.md new file mode 100644 index 000000000000..28169db1d297 --- /dev/null +++ b/docs/en/integrations/mindsdb/prebuilt-configs/mindsdb.md @@ -0,0 +1,18 @@ +--- +title: "MindsDB" +type: docs +description: "Details of the MindsDB prebuilt configuration." +--- + +## 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. diff --git a/docs/en/integrations/mssql/prebuilt-configs/_index.md b/docs/en/integrations/mssql/prebuilt-configs/_index.md new file mode 100644 index 000000000000..851ad3fcdb80 --- /dev/null +++ b/docs/en/integrations/mssql/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for SQL Server." +--- diff --git a/docs/en/integrations/mssql/prebuilt-configs/microsoft-sql-server.md b/docs/en/integrations/mssql/prebuilt-configs/microsoft-sql-server.md new file mode 100644 index 000000000000..38565b3273f5 --- /dev/null +++ b/docs/en/integrations/mssql/prebuilt-configs/microsoft-sql-server.md @@ -0,0 +1,21 @@ +--- +title: "Microsoft SQL Server" +type: docs +description: "Details of the Microsoft SQL Server prebuilt configuration." +--- + +## Microsoft SQL Server + +* `--prebuilt` value: `mssql` +* **Environment Variables:** + * `MSSQL_HOST`: (Optional) The hostname or IP address of the SQL Server instance. + * `MSSQL_PORT`: (Optional) The port number for the SQL Server instance. + * `MSSQL_DATABASE`: The name of the database to connect to. + * `MSSQL_USER`: The database username. + * `MSSQL_PASSWORD`: The password for the database user. +* **Permissions:** + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. diff --git a/docs/en/integrations/mysql/prebuilt-configs/_index.md b/docs/en/integrations/mysql/prebuilt-configs/_index.md new file mode 100644 index 000000000000..dbe5646782ee --- /dev/null +++ b/docs/en/integrations/mysql/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Mysql." +--- diff --git a/docs/en/integrations/mysql/prebuilt-configs/mysql.md b/docs/en/integrations/mysql/prebuilt-configs/mysql.md new file mode 100644 index 000000000000..85ba36c030e6 --- /dev/null +++ b/docs/en/integrations/mysql/prebuilt-configs/mysql.md @@ -0,0 +1,27 @@ +--- +title: "MySQL" +type: docs +description: "Details of the MySQL prebuilt configuration." +--- + +## MySQL + +* `--prebuilt` value: `mysql` +* **Environment Variables:** + * `MYSQL_HOST`: The hostname or IP address of the MySQL server. + * `MYSQL_PORT`: The port number for the MySQL server. + * `MYSQL_DATABASE`: The name of the database to connect to. + * `MYSQL_USER`: The database username. + * `MYSQL_PASSWORD`: The password for the database user. +* **Permissions:** + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. + * `get_query_plan`: Provides information about how MySQL executes a SQL + statement. + * `list_active_queries`: Lists ongoing queries. + * `list_tables_missing_unique_indexes`: Looks for tables that do not have + primary or unique key contraint. + * `list_table_fragmentation`: Displays table fragmentation in MySQL. diff --git a/docs/en/integrations/neo4j/prebuilt-configs/_index.md b/docs/en/integrations/neo4j/prebuilt-configs/_index.md new file mode 100644 index 000000000000..d142035ac6a6 --- /dev/null +++ b/docs/en/integrations/neo4j/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Neo4J." +--- diff --git a/docs/en/integrations/neo4j/prebuilt-configs/neo4j.md b/docs/en/integrations/neo4j/prebuilt-configs/neo4j.md new file mode 100644 index 000000000000..1ebc3c131d7b --- /dev/null +++ b/docs/en/integrations/neo4j/prebuilt-configs/neo4j.md @@ -0,0 +1,20 @@ +--- +title: "Neo4j" +type: docs +description: "Details of the Neo4j prebuilt configuration." +--- + +## Neo4j + +* `--prebuilt` value: `neo4j` +* **Environment Variables:** + * `NEO4J_URI`: The URI of the Neo4j instance (e.g., + `bolt://localhost:7687`). + * `NEO4J_DATABASE`: The name of the Neo4j database to connect to. + * `NEO4J_USERNAME`: The username for the Neo4j instance. + * `NEO4J_PASSWORD`: The password for the Neo4j instance. +* **Permissions:** + * **Database-level permissions** are required to execute Cypher queries. +* **Tools:** + * `execute_cypher`: Executes a Cypher query. + * `get_schema`: Retrieves the schema of the Neo4j database. diff --git a/docs/en/integrations/oceanbase/prebuilt-configs/_index.md b/docs/en/integrations/oceanbase/prebuilt-configs/_index.md new file mode 100644 index 000000000000..1e326595a6bc --- /dev/null +++ b/docs/en/integrations/oceanbase/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Oceanbase." +--- diff --git a/docs/en/integrations/oceanbase/prebuilt-configs/oceanbase.md b/docs/en/integrations/oceanbase/prebuilt-configs/oceanbase.md new file mode 100644 index 000000000000..f7163df7113f --- /dev/null +++ b/docs/en/integrations/oceanbase/prebuilt-configs/oceanbase.md @@ -0,0 +1,21 @@ +--- +title: "OceanBase" +type: docs +description: "Details of the OceanBase prebuilt configuration." +--- + +## OceanBase + +* `--prebuilt` value: `oceanbase` +* **Environment Variables:** + * `OCEANBASE_HOST`: The hostname or IP address of the OceanBase server. + * `OCEANBASE_PORT`: The port number for the OceanBase server. + * `OCEANBASE_DATABASE`: The name of the database to connect to. + * `OCEANBASE_USER`: The database username. + * `OCEANBASE_PASSWORD`: The password for the database user. +* **Permissions:** + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. diff --git a/docs/en/integrations/oracle/prebuilt-configs/_index.md b/docs/en/integrations/oracle/prebuilt-configs/_index.md new file mode 100644 index 000000000000..24e76666090a --- /dev/null +++ b/docs/en/integrations/oracle/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Oracle." +--- diff --git a/docs/en/integrations/oracle/prebuilt-configs/oracle.md b/docs/en/integrations/oracle/prebuilt-configs/oracle.md new file mode 100644 index 000000000000..30bdcb083c8a --- /dev/null +++ b/docs/en/integrations/oracle/prebuilt-configs/oracle.md @@ -0,0 +1,27 @@ +--- +title: "Oracle" +type: docs +description: "Details of the Oracle prebuilt configuration." +--- + +## Oracle + +* `--prebuilt` value: `oracledb` +* **Environment Variables:** + + * `ORACLE_CONNECTION_STRING`: The connection string for the Oracle server (e.g., "hostname:port/servicename"). + * `ORACLE_USERNAME`: The database username. + * `ORACLE_PASSWORD`: The password for the database user. + * `ORACLE_WALLET`: The path to the Oracle DB Wallet file for databases that support this authentication type. + * `ORACLE_USE_OCI`: A boolean flag (`true` or `false`) indicating whether to use the OCI-based driver. Setting to `true` is required for features like Oracle Wallet and requires the Oracle Instant Client libraries to be installed. +* **Permissions:** + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to execute queries. + * For queries on DBA views like `dba_data_files` and `dba_free_space`, access typically requires elevated database privileges (like `SELECT_CATALOG_ROLE` or direct grants) that a standard user may not have. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database. + * `list_active_sessions`: Lists active database sessions. + * `get_query_plan`: Generate a full execution plan for a single SQL statement. + * `list_top_sql_by_resource`: Lists top SQL statements by resource usage. + * `list_tablespace_usage`: Lists tablespace usage. + * `list_invalid_objects`: Lists invalid objects. diff --git a/docs/en/integrations/postgres/prebuilt-configs/_index.md b/docs/en/integrations/postgres/prebuilt-configs/_index.md new file mode 100644 index 000000000000..440343803e96 --- /dev/null +++ b/docs/en/integrations/postgres/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Postgres." +--- diff --git a/docs/en/integrations/postgres/prebuilt-configs/alloydb-omni.md b/docs/en/integrations/postgres/prebuilt-configs/alloydb-omni.md new file mode 100644 index 000000000000..147023ae79f6 --- /dev/null +++ b/docs/en/integrations/postgres/prebuilt-configs/alloydb-omni.md @@ -0,0 +1,52 @@ +--- +title: "AlloyDB Omni" +type: docs +description: "Details of the AlloyDB Omni prebuilt configuration." +--- + +## AlloyDB Omni + +* `--prebuilt` value: `alloydb-omni` +* **Environment Variables:** + * `ALLOYDB_OMNI_HOST`: (Optional) The hostname or IP address (Default: localhost). + * `ALLOYDB_OMNI_PORT`: (Optional) The port number (Default: 5432). + * `ALLOYDB_OMNI_DATABASE`: The name of the database to connect to. + * `ALLOYDB_OMNI_USER`: The database username. + * `ALLOYDB_OMNI_PASSWORD`: (Optional) The password for the database user. + * `ALLOYDB_OMNI_QUERY_PARAMS`: (Optional) Connection query parameters. +* **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. + * `list_columnar_recommended_columns`: Lists columns that AlloyDB Omni recommends adding to the columnar engine. + * `list_memory_configurations`: Lists memory-related configurations in the + database. + * `list_top_bloated_tables`: List top bloated tables in the database. + * `list_replication_slots`: Lists replication slots in the database. + * `list_invalid_indexes`: Lists invalid indexes in the database. + * `get_query_plan`: Generate the execution plan of a statement. + * `list_views`: Lists views in the database from pg_views with a default + limit of 50 rows. Returns schemaname, viewname and the ownername. + * `list_schemas`: Lists schemas in the database. + * `database_overview`: Fetches the current state of the PostgreSQL server. + * `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. diff --git a/docs/en/integrations/postgres/prebuilt-configs/postgresql.md b/docs/en/integrations/postgres/prebuilt-configs/postgresql.md new file mode 100644 index 000000000000..0a43dfc6ff07 --- /dev/null +++ b/docs/en/integrations/postgres/prebuilt-configs/postgresql.md @@ -0,0 +1,54 @@ +--- +title: "PostgreSQL" +type: docs +description: "Details of the PostgreSQL prebuilt configuration." +--- + +## PostgreSQL + +* `--prebuilt` value: `postgres` +* **Environment Variables:** + * `POSTGRES_HOST`: (Optional) The hostname or IP address of the PostgreSQL server. + * `POSTGRES_PORT`: (Optional) The port number for the PostgreSQL server. + * `POSTGRES_DATABASE`: The name of the database to connect to. + * `POSTGRES_USER`: The database username. + * `POSTGRES_PASSWORD`: The password for the database user. + * `POSTGRES_QUERY_PARAMS`: (Optional) Raw query to be added to the db + connection string. +* **Permissions:** + * Database-level permissions (e.g., `SELECT`, `INSERT`) are required to + execute queries. +* **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 + database. + * `list_top_bloated_tables`: List top bloated tables in the database. + * `list_replication_slots`: Lists replication slots in the database. + * `list_invalid_indexes`: Lists invalid indexes in the database. + * `get_query_plan`: Generate the execution plan of a statement. + * `list_views`: Lists views in the database from pg_views with a default + limit of 50 rows. Returns schemaname, viewname and the ownername. + * `list_schemas`: Lists schemas in the database. + * `database_overview`: Fetches the current state of the PostgreSQL server. + * `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. diff --git a/docs/en/integrations/serverless-spark/prebuilt-configs/_index.md b/docs/en/integrations/serverless-spark/prebuilt-configs/_index.md new file mode 100644 index 000000000000..08545ca7b98a --- /dev/null +++ b/docs/en/integrations/serverless-spark/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Serverless Spark." +--- diff --git a/docs/en/integrations/serverless-spark/prebuilt-configs/google-cloud-serverless-for-apache-spark.md b/docs/en/integrations/serverless-spark/prebuilt-configs/google-cloud-serverless-for-apache-spark.md new file mode 100644 index 000000000000..06c8540cf6ed --- /dev/null +++ b/docs/en/integrations/serverless-spark/prebuilt-configs/google-cloud-serverless-for-apache-spark.md @@ -0,0 +1,26 @@ +--- +title: "Google Cloud Serverless for Apache Spark" +type: docs +description: "Details of the Google Cloud Serverless for Apache Spark prebuilt configuration." +--- + +## Google Cloud Serverless for Apache Spark + +* `--prebuilt` value: `serverless-spark` +* **Environment Variables:** + * `SERVERLESS_SPARK_PROJECT`: The GCP project ID + * `SERVERLESS_SPARK_LOCATION`: The GCP Location. +* **Permissions:** + * **Dataproc Serverless Viewer** (`roles/dataproc.serverlessViewer`) to + view serverless batches. + * **Dataproc Serverless Editor** (`roles/dataproc.serverlessEditor`) to + 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. + * `list_sessions`: Lists Spark sessions. + * `get_session`: Gets a Spark session. + * `get_session_template`: Gets a Spark session template. diff --git a/docs/en/integrations/singlestore/prebuilt-configs/_index.md b/docs/en/integrations/singlestore/prebuilt-configs/_index.md new file mode 100644 index 000000000000..b7ab43d3ec5a --- /dev/null +++ b/docs/en/integrations/singlestore/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Singlestore." +--- diff --git a/docs/en/integrations/singlestore/prebuilt-configs/singlestore.md b/docs/en/integrations/singlestore/prebuilt-configs/singlestore.md new file mode 100644 index 000000000000..4388bbbb516f --- /dev/null +++ b/docs/en/integrations/singlestore/prebuilt-configs/singlestore.md @@ -0,0 +1,18 @@ +--- +title: "SingleStore" +type: docs +description: "Details of the SingleStore prebuilt configuration." +--- + +## 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. diff --git a/docs/en/integrations/snowflake/prebuilt-configs/_index.md b/docs/en/integrations/snowflake/prebuilt-configs/_index.md new file mode 100644 index 000000000000..8dbaaf7836cb --- /dev/null +++ b/docs/en/integrations/snowflake/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Snowflake." +--- diff --git a/docs/en/integrations/snowflake/prebuilt-configs/snowflake.md b/docs/en/integrations/snowflake/prebuilt-configs/snowflake.md new file mode 100644 index 000000000000..214f84642cfa --- /dev/null +++ b/docs/en/integrations/snowflake/prebuilt-configs/snowflake.md @@ -0,0 +1,20 @@ +--- +title: "Snowflake" +type: docs +description: "Details of the Snowflake prebuilt configuration." +--- + +## 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. diff --git a/docs/en/integrations/spanner/prebuilt-configs/_index.md b/docs/en/integrations/spanner/prebuilt-configs/_index.md new file mode 100644 index 000000000000..99bd382fc9e9 --- /dev/null +++ b/docs/en/integrations/spanner/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Spanner." +--- diff --git a/docs/en/integrations/spanner/prebuilt-configs/spanner-googlesql-dialect.md b/docs/en/integrations/spanner/prebuilt-configs/spanner-googlesql-dialect.md new file mode 100644 index 000000000000..5b5dd49c7f0b --- /dev/null +++ b/docs/en/integrations/spanner/prebuilt-configs/spanner-googlesql-dialect.md @@ -0,0 +1,23 @@ +--- +title: "Spanner (GoogleSQL dialect)" +type: docs +description: "Details of the Spanner (GoogleSQL dialect) prebuilt configuration." +--- + +## Spanner (GoogleSQL dialect) + +* `--prebuilt` value: `spanner` +* **Environment Variables:** + * `SPANNER_PROJECT`: The GCP project ID. + * `SPANNER_INSTANCE`: The Spanner instance ID. + * `SPANNER_DATABASE`: The Spanner database ID. +* **Permissions:** + * **Cloud Spanner Database Reader** (`roles/spanner.databaseReader`) to + execute DQL queries and list tables. + * **Cloud Spanner Database User** (`roles/spanner.databaseUser`) to + execute DML queries. +* **Tools:** + * `execute_sql`: Executes a DML SQL query. + * `execute_sql_dql`: Executes a DQL SQL query. + * `list_tables`: Lists tables in the database. + * `list_graphs`: Lists graphs in the database. diff --git a/docs/en/integrations/spanner/prebuilt-configs/spanner-postgresql-dialect.md b/docs/en/integrations/spanner/prebuilt-configs/spanner-postgresql-dialect.md new file mode 100644 index 000000000000..f72a87927804 --- /dev/null +++ b/docs/en/integrations/spanner/prebuilt-configs/spanner-postgresql-dialect.md @@ -0,0 +1,24 @@ +--- +title: "Spanner (PostgreSQL dialect)" +type: docs +description: "Details of the Spanner (PostgreSQL dialect) prebuilt configuration." +--- + +## Spanner (PostgreSQL dialect) + +* `--prebuilt` value: `spanner-postgres` +* **Environment Variables:** + * `SPANNER_PROJECT`: The GCP project ID. + * `SPANNER_INSTANCE`: The Spanner instance ID. + * `SPANNER_DATABASE`: The Spanner database ID. +* **Permissions:** + * **Cloud Spanner Database Reader** (`roles/spanner.databaseReader`) to + execute DQL queries and list tables. + * **Cloud Spanner Database User** (`roles/spanner.databaseUser`) to + execute DML queries. +* **Tools:** + * `execute_sql`: Executes a DML SQL query using the PostgreSQL interface + for Spanner. + * `execute_sql_dql`: Executes a DQL SQL query using the PostgreSQL + interface for Spanner. + * `list_tables`: Lists tables in the database. diff --git a/docs/en/integrations/sqlite/prebuilt-configs/_index.md b/docs/en/integrations/sqlite/prebuilt-configs/_index.md new file mode 100644 index 000000000000..6351c3ae6a69 --- /dev/null +++ b/docs/en/integrations/sqlite/prebuilt-configs/_index.md @@ -0,0 +1,5 @@ +--- +title: "Prebuilt Configs" +type: docs +description: "Prebuilt configurations for Sqlite." +--- diff --git a/docs/en/integrations/sqlite/prebuilt-configs/sqlite.md b/docs/en/integrations/sqlite/prebuilt-configs/sqlite.md new file mode 100644 index 000000000000..4105a759ebb3 --- /dev/null +++ b/docs/en/integrations/sqlite/prebuilt-configs/sqlite.md @@ -0,0 +1,17 @@ +--- +title: "SQLite" +type: docs +description: "Details of the SQLite prebuilt configuration." +--- + +## SQLite + +* `--prebuilt` value: `sqlite` +* **Environment Variables:** + * `SQLITE_DATABASE`: The path to the SQLite database file (e.g., + `./sample.db`). +* **Permissions:** + * File system read/write permissions for the specified database file. +* **Tools:** + * `execute_sql`: Executes a SQL query. + * `list_tables`: Lists tables in the database.