mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-12 16:15:00 -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>
1.7 KiB
1.7 KiB
title, type, weight, description, aliases
| title | type | weight | description | aliases | |
|---|---|---|---|---|---|
| dataform-compile-local | docs | 1 | A "dataform-compile-local" tool runs the `dataform compile` CLI command on a local project directory. |
|
About
A dataform-compile-local tool runs the dataform compile command on a local
Dataform project.
It is a standalone tool and is not compatible with any sources.
At invocation time, the tool executes dataform compile --json in the specified
project directory and returns the resulting JSON object from the CLI.
dataform-compile-local takes the following parameter:
project_dir(string): The absolute or relative path to the local Dataform project directory. The server process must have read access to this path.
Requirements
Dataform CLI
This tool executes the dataform command-line interface (CLI) via a system
call. You must have the dataform CLI installed and available in the
server's system PATH.
You can typically install the CLI via npm:
npm install -g @dataform/cli
See the official Dataform documentation for more details.
Example
kind: tools
name: my_dataform_compiler
type: dataform-compile-local
description: Use this tool to compile a local Dataform project.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "dataform-compile-local". |
| description | string | true | Description of the tool that is passed to the LLM. |