mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -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>
84 lines
3.6 KiB
Markdown
84 lines
3.6 KiB
Markdown
---
|
|
title: "FAQ"
|
|
type: docs
|
|
weight: 2
|
|
description: Frequently asked questions about Toolbox.
|
|
---
|
|
|
|
## How can I deploy or run Toolbox?
|
|
|
|
MCP Toolbox for Databases is open-source and can be run or deployed to a
|
|
multitude of environments. For convenience, we release [compiled binaries and
|
|
docker images][release-notes] (but you can always compile yourself as well!).
|
|
|
|
For detailed instructions, check out these resources:
|
|
|
|
- [Quickstart: How to Run Locally](../getting-started/local_quickstart.md)
|
|
- [Deploy to Cloud Run](../how-to/deploy_toolbox.md)
|
|
|
|
[release-notes]: https://github.com/googleapis/genai-toolbox/releases/
|
|
|
|
## Do I need a Google Cloud account/project to get started with Toolbox?
|
|
|
|
Nope! While some of the sources Toolbox connects to may require GCP credentials,
|
|
Toolbox doesn't require them and can connect to a bunch of different resources
|
|
that don't.
|
|
|
|
## Does Toolbox take contributions from external users?
|
|
|
|
Absolutely! Please check out our [DEVELOPER.md][] for instructions on how to get
|
|
started developing _on_ Toolbox instead of with it, and the [CONTRIBUTING.md][]
|
|
for instructions on completing the CLA and getting a PR accepted.
|
|
|
|
[DEVELOPER.md]: https://github.com/googleapis/genai-toolbox/blob/main/DEVELOPER.md
|
|
[CONTRIBUTING.MD]: https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md
|
|
|
|
## Can Toolbox support a feature to let me do _$FOO_?
|
|
|
|
Maybe? The best place to start is by [opening an issue][github-issue] for
|
|
discussion (or seeing if there is already one open), so we can better understand
|
|
your use case and the best way to solve it. Generally we aim to prioritize the
|
|
most popular issues, so make sure to +1 ones you are the most interested in.
|
|
|
|
[github-issue]: https://github.com/googleapis/genai-toolbox/issues
|
|
|
|
## Can Toolbox be used for non-database tools?
|
|
|
|
**Yes!** While Toolbox is primarily focused on databases, it also supports generic
|
|
**HTTP tools** (`type: http`). These allow you to connect your agents to REST APIs
|
|
and other web services, enabling workflows that extend beyond database interactions.
|
|
|
|
For configuration details, see the [HTTP Tools documentation](../resources/tools/http/http.md).
|
|
|
|
## Can I use _$BAR_ orchestration framework to use tools from Toolbox?
|
|
|
|
Currently, Toolbox only supports a limited number of client SDKs at our initial
|
|
launch. We are investigating support for more frameworks as well as more general
|
|
approaches for users without a framework -- look forward to seeing an update
|
|
soon.
|
|
|
|
## Why does Toolbox use a server-client architecture pattern?
|
|
|
|
Toolbox's server-client architecture allows us to more easily support a wide
|
|
variety of languages and frameworks with a centralized implementation. It also
|
|
allows us to tackle problems like connection pooling, auth, or caching more
|
|
completely than entirely client-side solutions.
|
|
|
|
## Why was Toolbox written in Go?
|
|
|
|
While a large part of the Gen AI Ecosystem is predominately Python, we opted to
|
|
use Go. We chose Go because it's still easy and simple to use, but also easier
|
|
to write fast, efficient, and concurrent servers. Additionally, given the
|
|
server-client architecture, we can still meet many developers where they are
|
|
with clients in their preferred language. As Gen AI matures, we want developers
|
|
to be able to use Toolbox on the serving path of mission critical applications.
|
|
It's easier to build the needed robustness, performance and scalability in Go
|
|
than in Python.
|
|
|
|
## Is Toolbox compatible with Model Context Protocol (MCP)?
|
|
|
|
Yes! Toolbox is compatible with [Anthropic's Model Context Protocol
|
|
(MCP)](https://modelcontextprotocol.io/). Please checkout [Connect via
|
|
MCP](../how-to/connect_via_mcp.md) on how to connect to Toolbox with an MCP
|
|
client.
|