mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-04-09 03:02:26 -04: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>
136 lines
5.3 KiB
Markdown
136 lines
5.3 KiB
Markdown
---
|
|
title: "firebird-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "firebird-sql" tool executes a pre-defined SQL statement against a Firebird
|
|
database.
|
|
aliases:
|
|
- /resources/tools/firebird-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `firebird-sql` tool executes a pre-defined SQL statement against a Firebird
|
|
database. It's compatible with the following source:
|
|
|
|
- [firebird](../../sources/firebird.md)
|
|
|
|
The specified SQL statement is executed as a [prepared statement][fb-prepare],
|
|
and supports both positional parameters (`?`) and named parameters (`:param_name`).
|
|
Parameters will be inserted according to their position or name. If template
|
|
parameters are included, they will be resolved before the execution of the
|
|
prepared statement.
|
|
|
|
[fb-prepare]: https://firebirdsql.org/refdocs/langrefupd25-psql-execstat.html
|
|
|
|
## 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_flights_by_number
|
|
type: firebird-sql
|
|
source: my_firebird_db
|
|
statement: |
|
|
SELECT * FROM flights
|
|
WHERE airline = ?
|
|
AND flight_number = ?
|
|
LIMIT 10
|
|
description: |
|
|
Use this tool to get information for a specific flight.
|
|
Takes an airline code and flight number and returns info on the flight.
|
|
Do NOT use this tool with a flight id. Do NOT guess an airline code or flight number.
|
|
A airline code is a code for an airline service consisting of two-character
|
|
airline designator and followed by flight number, which is 1 to 4 digit number.
|
|
For example, if given CY 0123, the airline is "CY", and flight_number is "123".
|
|
Another example for this is DL 1234, the airline is "DL", and flight_number is "1234".
|
|
If the tool returns more than one option choose the date closes to today.
|
|
Example:
|
|
{{
|
|
"airline": "CY",
|
|
"flight_number": "888",
|
|
}}
|
|
Example:
|
|
{{
|
|
"airline": "DL",
|
|
"flight_number": "1234",
|
|
}}
|
|
parameters:
|
|
- name: airline
|
|
type: string
|
|
description: Airline unique 2 letter identifier
|
|
- name: flight_number
|
|
type: string
|
|
description: 1 to 4 digit number
|
|
```
|
|
|
|
### Example with Named Parameters
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: search_flights_by_airline
|
|
type: firebird-sql
|
|
source: my_firebird_db
|
|
statement: |
|
|
SELECT * FROM flights
|
|
WHERE airline = :airline
|
|
AND departure_date >= :start_date
|
|
AND departure_date <= :end_date
|
|
ORDER BY departure_date
|
|
description: |
|
|
Search for flights by airline within a date range using named parameters.
|
|
parameters:
|
|
- name: airline
|
|
type: string
|
|
description: Airline unique 2 letter identifier
|
|
- name: start_date
|
|
type: string
|
|
description: Start date in YYYY-MM-DD format
|
|
- name: end_date
|
|
type: string
|
|
description: End date in YYYY-MM-DD format
|
|
```
|
|
|
|
### 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: firebird-sql
|
|
source: my_firebird_db
|
|
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 "firebird-sql". |
|
|
| source | string | true | Name of the source the SQL should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|
|
| statement | string | true | SQL statement to execute on. |
|
|
| parameters | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be inserted into 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. |
|