Database Tools

This page covers installation and server-side configuration for built-in database tools.

Use this together with:

• Tools for request examples and runtime usage

Supported database tools

Built-in database tools include:

• database_query_v1
• /v1/tools/database-query

How to install

Choose the smallest extra that matches your database:

If you only want the database tool itself, tool-database is the simplest entry point. If you want a narrower install, use the driver-specific extra directly.

Examples:

$
uv sync --extra database-postgres
$
uv sync --extra database-mysql
$
uv sync --extra database-mssql
$
uv sync --extra database-db2
$
uv sync --extra tool-database

database_query_v1 will also work when you install broader bundles that include database support, such as private-gpt[database], private-gpt[tool-database], private-gpt[tools], or private-gpt[core].

Settings reference

Database query does not have a global enabled flag in settings.yaml. Instead, the server uses runtime limits from database_query, and each request provides the target database through a sql_database artifact.

1
database_query:
2
  timeout_seconds: 1000
3
  batch_size: 1000
4
  max_mb_result: 150

Settings

Runtime requirement

The database connection is not configured globally in settings.yaml. Pass it in the request as a sql_database artifact.

See Tools for Messages API and standalone tool endpoint examples.