Skip to main content
Use Database Query when you want the assistant to translate natural language into SQL over a configured database connection.

Prerequisites

Requirements

  • Tool spec: { "name": "database_query", "type": "database_query_v1" }
  • tool_context: one sql_database context with connection_string

Basic request and response

This example validates a request that enables database query. For validation, it sets tool_choice to none so the validator doesn’t try to connect.
Example response:
To run the request, send the same body to POST /messages and set tool_choice to { \"type\": \"auto\" }.

Tips

  • Use a read-only database user.
  • Limit schemas to reduce inspection time.

Next steps

  • Learn how messages return tool blocks: Messages