mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-05-02 03:00:36 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

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>

2026-01-27 16:58:43 -08:00

2.6 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
Elasticsearch	docs	1	Elasticsearch is a distributed, free and open search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured.

Elasticsearch Source

Elasticsearch is a distributed, free and open search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured.

If you are new to Elasticsearch, you can learn how to set up a cluster and start indexing data.

Elasticsearch uses ES|QL for querying data. ES|QL is a powerful query language that allows you to search and aggregate data in Elasticsearch.

See the official documentation for more information.

Available Tools

elasticsearch-esql Execute ES|QL queries.

Requirements

API Key

Toolbox uses an API key to authorize and authenticate when interacting with Elasticsearch.

In addition to setting the API key for your server, you need to ensure the API key has the correct permissions for the queries you intend to run. See API key management for more information on applying permissions to an API key.

Example

kind: sources
name: my-elasticsearch-source
type: "elasticsearch"
addresses:
  - "http://localhost:9200"
apikey: "my-api-key"

Reference

field	type	required	description
type	string	true	Must be "elasticsearch".
addresses	[]string	true	List of Elasticsearch hosts to connect to.
apikey	string	true	The API key to use for authentication.

2.6 KiB Raw Blame History