logo
MCP Toolbox for Databases
[!NOTE] MCP Toolbox for Databases is currently in beta, and may see breaking changes until the first stable release (v1.0).
MCP Toolbox for Databases is an open source MCP server for databases It was
designed with enterprise-grade and production-quality in mind. It enables you to
develop tools easier, faster, and more securely by handling the complexities
such as connection pooling, authentication, and more.
This README provides a brief overview. For comprehensive details, see the full
documentation.
[!NOTE] This product was originally named Gen AI Toolbox for Databases as its initial development predated MCP, but was renamed to align with recently added MCP compatibility.
Table of Contents
- Why Toolbox?
- General Architecture
- Getting Started
- Configuration
- Versioning
- Contributing
Why Toolbox?
Toolbox helps you build Gen AI tools that let your agents access data in your
database. Toolbox provides:
- Simplified development: Integrate tools to your agent in less than 10 lines of code, reuse tools between multiple agents or frameworks, and deploy new versions of tools more easily.
- Better performance: Best practices such as connection pooling, authentication, and more.
- Enhanced security: Integrated auth for more secure access to your data
- End-to-end observability: Out of the box metrics and tracing with built-in support for OpenTelemetry.
General Architecture
Toolbox sits between your application's orchestration framework and your
database, providing a control plane that is used to modify, distribute, or
invoke tools. It simplifies the management of your tools by providing you with a
centralized location to store and update tools, allowing you to share tools
between agents and applications and update those tools without necessarily
redeploying your application.
architecture
Getting Started
Installing the server
For the latest version, check the [releases page][releases] and use the
following instructions for your OS and CPU architecture.
To install Toolbox as a binary:
To install from source, ensure you have the latest version of
Go installed, and then run the following command:
Running the server
Configure a
tools.yaml to define your tools, and then
execute toolbox to start the server:You can use
toolbox help for a full list of flags! To stop the server, send a
terminate signal (ctrl+c on most platforms).For more detailed documentation on deploying to different environments, check
out the resources in the How-to
section
Integrating your application
Once your server is up and running, you can load the tools into your
application. See below the list of Client SDKs for using various frameworks:
- Install [Toolbox Core SDK][toolbox-core]:
- Load tools:
For more detailed instructions on using the Toolbox Core SDK, see the
[project's README][toolbox-core-readme].
- Install [Toolbox LangChain SDK][toolbox-langchain]:
- Load tools:
For more detailed instructions on using the Toolbox LangChain SDK, see the
[project's README][toolbox-langchain-readme].
- Install [Toolbox Llamaindex SDK][toolbox-llamaindex]:
- Load tools:
For more detailed instructions on using the Toolbox Llamaindex SDK, see the
[project's README][toolbox-llamaindex-readme].
Configuration
The primary way to configure Toolbox is through the
tools.yaml file. If you
have multiple files, you can tell toolbox which to load with the --tools_file tools.yaml flag.You can find more detailed reference documentation to all resource types in the
Resources.
Sources
The
sources section of your tools.yaml defines what data sources your
Toolbox should have access to. Most tools will have at least one source to
execute against.For more details on configuring different types of sources, see the
Sources.
Tools
The
tools section of a tools.yaml define the actions an agent can take: what
kind of tool it is, which source(s) it affects, what parameters it uses, etc.For more details on configuring different types of tools, see the
Tools.
Toolsets
The
toolsets section of your tools.yaml allows you to define groups of tools
that you want to be able to load together. This can be useful for defining
different groups based on agent or application.You can load toolsets by name:
Versioning
This project uses semantic versioning, including a
MAJOR.MINOR.PATCH version number that increments with:- MAJOR version when we make incompatible API changes
- MINOR version when we add functionality in a backward compatible manner
- PATCH version when we make backward compatible bug fixes
The public API that this applies to is the CLI associated with Toolbox, the
interactions with official SDKs, and the definitions in the
tools.yaml file. Contributing
Contributions are welcome. Please, see the CONTRIBUTING
to get started.
Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms. See
Contributor Code of Conduct for more information.
logo
MCP Toolbox for Databases
[!NOTE] MCP Toolbox for Databases is currently in beta, and may see breaking changes until the first stable release (v1.0).
MCP Toolbox for Databases is an open source MCP server for databases It was
designed with enterprise-grade and production-quality in mind. It enables you to
develop tools easier, faster, and more securely by handling the complexities
such as connection pooling, authentication, and more.
This README provides a brief overview. For comprehensive details, see the full
documentation.
[!NOTE] This product was originally named Gen AI Toolbox for Databases as its initial development predated MCP, but was renamed to align with recently added MCP compatibility.
Table of Contents
- Why Toolbox?
- General Architecture
- Getting Started
- Configuration
- Versioning
- Contributing
Why Toolbox?
Toolbox helps you build Gen AI tools that let your agents access data in your
database. Toolbox provides:
- Simplified development: Integrate tools to your agent in less than 10 lines of code, reuse tools between multiple agents or frameworks, and deploy new versions of tools more easily.
- Better performance: Best practices such as connection pooling, authentication, and more.
- Enhanced security: Integrated auth for more secure access to your data
- End-to-end observability: Out of the box metrics and tracing with built-in support for OpenTelemetry.
General Architecture
Toolbox sits between your application's orchestration framework and your
database, providing a control plane that is used to modify, distribute, or
invoke tools. It simplifies the management of your tools by providing you with a
centralized location to store and update tools, allowing you to share tools
between agents and applications and update those tools without necessarily
redeploying your application.
architecture
Getting Started
Installing the server
For the latest version, check the [releases page][releases] and use the
following instructions for your OS and CPU architecture.
To install Toolbox as a binary:
To install from source, ensure you have the latest version of
Go installed, and then run the following command:
Running the server
Configure a
tools.yaml to define your tools, and then
execute toolbox to start the server:You can use
toolbox help for a full list of flags! To stop the server, send a
terminate signal (ctrl+c on most platforms).For more detailed documentation on deploying to different environments, check
out the resources in the How-to
section
Integrating your application
Once your server is up and running, you can load the tools into your
application. See below the list of Client SDKs for using various frameworks:
- Install [Toolbox Core SDK][toolbox-core]:
- Load tools:
For more detailed instructions on using the Toolbox Core SDK, see the
[project's README][toolbox-core-readme].
- Install [Toolbox LangChain SDK][toolbox-langchain]:
- Load tools:
For more detailed instructions on using the Toolbox LangChain SDK, see the
[project's README][toolbox-langchain-readme].
- Install [Toolbox Llamaindex SDK][toolbox-llamaindex]:
- Load tools:
For more detailed instructions on using the Toolbox Llamaindex SDK, see the
[project's README][toolbox-llamaindex-readme].
Configuration
The primary way to configure Toolbox is through the
tools.yaml file. If you
have multiple files, you can tell toolbox which to load with the --tools_file tools.yaml flag.You can find more detailed reference documentation to all resource types in the
Resources.
Sources
The
sources section of your tools.yaml defines what data sources your
Toolbox should have access to. Most tools will have at least one source to
execute against.For more details on configuring different types of sources, see the
Sources.
Tools
The
tools section of a tools.yaml define the actions an agent can take: what
kind of tool it is, which source(s) it affects, what parameters it uses, etc.For more details on configuring different types of tools, see the
Tools.
Toolsets
The
toolsets section of your tools.yaml allows you to define groups of tools
that you want to be able to load together. This can be useful for defining
different groups based on agent or application.You can load toolsets by name:
Versioning
This project uses semantic versioning, including a
MAJOR.MINOR.PATCH version number that increments with:- MAJOR version when we make incompatible API changes
- MINOR version when we add functionality in a backward compatible manner
- PATCH version when we make backward compatible bug fixes
The public API that this applies to is the CLI associated with Toolbox, the
interactions with official SDKs, and the definitions in the
tools.yaml file. Contributing
Contributions are welcome. Please, see the CONTRIBUTING
to get started.
Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms. See
Contributor Code of Conduct for more information.