Files
genai-toolbox/docs/en/getting-started/quickstart/shared/configure_toolbox.md
release-please[bot] 964a82eb08 chore(main): release 0.16.0 (#1530)
🤖 I have created a release *beep* *boop*
---


##
[0.16.0](https://github.com/googleapis/genai-toolbox/compare/v0.15.0...v0.16.0)
(2025-09-25)


### ⚠ BREAKING CHANGES

* **tool/bigquery-execute-sql:** add allowed datasets support
([#1443](https://github.com/googleapis/genai-toolbox/issues/1443))
* **tool/bigquery-forecast:** add allowed datasets support
([#1412](https://github.com/googleapis/genai-toolbox/issues/1412))

### Features

* **cassandra:** Add Cassandra Source and Tool
([#1012](https://github.com/googleapis/genai-toolbox/issues/1012))
([6e42053](6e420534ee))
* **sources/postgres:** Add application_name
([#1504](https://github.com/googleapis/genai-toolbox/issues/1504))
([72a2366](72a2366b28))
* **tool/bigquery-execute-sql:** Add allowed datasets support
([#1443](https://github.com/googleapis/genai-toolbox/issues/1443))
([9501ebb](9501ebbdbc))
* **tool/bigquery-forecast:** Add allowed datasets support
([#1412](https://github.com/googleapis/genai-toolbox/issues/1412))
([88bac7e](88bac7e36f))
* **tools/clickhouse-list-tables:** Add list-tables tool
([#1446](https://github.com/googleapis/genai-toolbox/issues/1446))
([69a3caf](69a3cafabe))


### Bug Fixes

* **tool/mongodb-find:** Fix find tool `limit` field
([#1570](https://github.com/googleapis/genai-toolbox/issues/1570))
([4166bf7](4166bf7ab8))
* **tools/mongodb:** Concat filter params only once in mongodb update
tools ([#1545](https://github.com/googleapis/genai-toolbox/issues/1545))
([295f9dc](295f9dc41a))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
2025-09-25 18:05:14 -07:00

4.0 KiB

In this section, we will download Toolbox, configure our tools in a tools.yaml, and then run the Toolbox server.

  1. Download the latest version of Toolbox as a binary:

    {{< notice tip >}} Select the correct binary corresponding to your OS and CPU architecture. {{< /notice >}}

    export OS="linux/amd64" # one of linux/amd64, darwin/arm64, darwin/amd64, or windows/amd64
    curl -O https://storage.googleapis.com/genai-toolbox/v0.16.0/$OS/toolbox
    
  2. Make the binary executable:

    chmod +x toolbox
    
  3. Write the following into a tools.yaml file. Be sure to update any fields such as user, password, or database that you may have customized in the previous step.

    {{< notice tip >}} In practice, use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

    sources:
      my-pg-source:
        kind: postgres
        host: 127.0.0.1
        port: 5432
        database: toolbox_db
        user: ${USER_NAME}
        password: ${PASSWORD}
    tools:
      search-hotels-by-name:
        kind: postgres-sql
        source: my-pg-source
        description: Search for hotels based on name.
        parameters:
          - name: name
            type: string
            description: The name of the hotel.
        statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';
      search-hotels-by-location:
        kind: postgres-sql
        source: my-pg-source
        description: Search for hotels based on location.
        parameters:
          - name: location
            type: string
            description: The location of the hotel.
        statement: SELECT * FROM hotels WHERE location ILIKE '%' || $1 || '%';
      book-hotel:
        kind: postgres-sql
        source: my-pg-source
        description: >-
           Book a hotel by its ID. If the hotel is successfully booked, returns a NULL, raises an error if not.
        parameters:
          - name: hotel_id
            type: string
            description: The ID of the hotel to book.
        statement: UPDATE hotels SET booked = B'1' WHERE id = $1;
      update-hotel:
        kind: postgres-sql
        source: my-pg-source
        description: >-
          Update a hotel's check-in and check-out dates by its ID. Returns a message
          indicating  whether the hotel was successfully updated or not.
        parameters:
          - name: hotel_id
            type: string
            description: The ID of the hotel to update.
          - name: checkin_date
            type: string
            description: The new check-in date of the hotel.
          - name: checkout_date
            type: string
            description: The new check-out date of the hotel.
        statement: >-
          UPDATE hotels SET checkin_date = CAST($2 as date), checkout_date = CAST($3
          as date) WHERE id = $1;
      cancel-hotel:
        kind: postgres-sql
        source: my-pg-source
        description: Cancel a hotel by its ID.
        parameters:
          - name: hotel_id
            type: string
            description: The ID of the hotel to cancel.
        statement: UPDATE hotels SET booked = B'0' WHERE id = $1;
    toolsets:
      my-toolset:
        - search-hotels-by-name
        - search-hotels-by-location
        - book-hotel
        - update-hotel
        - cancel-hotel
    

    For more info on tools, check out the Resources section of the docs.

  4. Run the Toolbox server, pointing to the tools.yaml file created earlier:

    ./toolbox --tools-file "tools.yaml"
    

    {{< notice note >}} Toolbox enables dynamic reloading by default. To disable, use the --disable-reload flag. {{< /notice >}}