mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-29 17:28:05 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
39 lines
2.2 KiB
Markdown
39 lines
2.2 KiB
Markdown
---
|
|
title: "cloud-sql-wait-for-operation"
|
|
type: docs
|
|
weight: 10
|
|
description: >
|
|
Wait for a long-running Cloud SQL operation to complete.
|
|
---
|
|
|
|
The `cloud-sql-wait-for-operation` tool is a utility tool that waits for a
|
|
long-running Cloud SQL operation to complete. It does this by polling the Cloud
|
|
SQL Admin API operation status endpoint until the operation is finished, using
|
|
exponential backoff.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: cloudsql-operations-get
|
|
type: cloud-sql-wait-for-operation
|
|
source: my-cloud-sql-source
|
|
description: "This will poll on operations API until the operation is done. For checking operation status we need projectId and operationId. Once instance is created give follow up steps on how to use the variables to bring data plane MCP server up in local and remote setup."
|
|
delay: 1s
|
|
maxDelay: 4m
|
|
multiplier: 2
|
|
maxRetries: 10
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
| ----------- | :------: | :----------: | ---------------------------------------------------------------------------------------------------------------- |
|
|
| type | string | true | Must be "cloud-sql-wait-for-operation". |
|
|
| source | string | true | The name of a `cloud-sql-admin` source to use for authentication. |
|
|
| description | string | false | A description of the tool. |
|
|
| delay | duration | false | The initial delay between polling requests (e.g., `3s`). Defaults to 3 seconds. |
|
|
| maxDelay | duration | false | The maximum delay between polling requests (e.g., `4m`). Defaults to 4 minutes. |
|
|
| multiplier | float | false | The multiplier for the polling delay. The delay is multiplied by this value after each request. Defaults to 2.0. |
|
|
| maxRetries | int | false | The maximum number of polling attempts before giving up. Defaults to 10. |
|