mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-18 19:05:19 -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>
101 lines
4.5 KiB
Markdown
101 lines
4.5 KiB
Markdown
---
|
|
title: "couchbase-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "couchbase-sql" tool executes a pre-defined SQL statement against a Couchbase
|
|
database.
|
|
aliases:
|
|
- /resources/tools/couchbase-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `couchbase-sql` tool executes a pre-defined SQL statement against a Couchbase
|
|
database. It's compatible with any of the following sources:
|
|
|
|
- [couchbase](../../sources/couchbase.md)
|
|
|
|
The specified SQL statement is executed as a parameterized statement, and specified
|
|
parameters will be used according to their name: e.g. `$id`.
|
|
|
|
## Example
|
|
|
|
> **Note:** This tool uses parameterized queries to prevent SQL injections.
|
|
> Query parameters can be used as substitutes for arbitrary expressions.
|
|
> Parameters cannot be used as substitutes for identifiers, column names, table
|
|
> names, or other parts of the query.
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: search_products_by_category
|
|
type: couchbase-sql
|
|
source: my-couchbase-instance
|
|
statement: |
|
|
SELECT p.name, p.price, p.description
|
|
FROM products p
|
|
WHERE p.category = $category AND p.price < $max_price
|
|
ORDER BY p.price DESC
|
|
LIMIT 10
|
|
description: |
|
|
Use this tool to get a list of products for a specific category under a maximum price.
|
|
Takes a category name, e.g. "Electronics" and a maximum price e.g 500 and returns a list of product names, prices, and descriptions.
|
|
Do NOT use this tool with invalid category names. Do NOT guess a category name, Do NOT guess a price.
|
|
Example:
|
|
{{
|
|
"category": "Electronics",
|
|
"max_price": 500
|
|
}}
|
|
Example:
|
|
{{
|
|
"category": "Furniture",
|
|
"max_price": 1000
|
|
}}
|
|
parameters:
|
|
- name: category
|
|
type: string
|
|
description: Product category name
|
|
- name: max_price
|
|
type: integer
|
|
description: Maximum price (positive integer)
|
|
```
|
|
|
|
### Example with Template Parameters
|
|
|
|
> **Note:** This tool allows direct modifications to the SQL statement,
|
|
> including identifiers, column names, and table names. **This makes it more
|
|
> vulnerable to SQL injections**. Using basic parameters only (see above) is
|
|
> recommended for performance and safety reasons. For more details, please check
|
|
> [templateParameters](..#template-parameters).
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: list_table
|
|
type: couchbase-sql
|
|
source: my-couchbase-instance
|
|
statement: |
|
|
SELECT * FROM {{.tableName}};
|
|
description: |
|
|
Use this tool to list all information from a specific table.
|
|
Example:
|
|
{{
|
|
"tableName": "flights",
|
|
}}
|
|
templateParameters:
|
|
- name: tableName
|
|
type: string
|
|
description: Table to select from
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|--------------------|:--------------------------------------------:|:------------:|----------------------------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "couchbase-sql". |
|
|
| source | string | true | Name of the source the SQL query should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|
|
| statement | string | true | SQL statement to execute |
|
|
| parameters | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be used with the SQL statement. |
|
|
| templateParameters | [templateParameters](..#template-parameters) | false | List of [templateParameters](..#template-parameters) that will be inserted into the SQL statement before executing prepared statement. |
|
|
| authRequired | array[string] | false | List of auth services that are required to use this tool. |
|