bigquery-execute-sql
2 minute read
About
A bigquery-execute-sql tool executes a SQL statement against BigQuery.
bigquery-execute-sql accepts the following parameters:
sql(required): The GoogleSQL statement to execute.dry_run(optional): If set totrue, the query is validated but not run, returning information about the execution instead. Defaults tofalse.
The behavior of this tool is influenced by the combination of the readOnly
and writeMode settings on its bigquery source:
readOnly | writeMode | Tool Behavior | MCP Tool Annotations |
|---|---|---|---|
false (default) | allowed (default) | All SQL statements are permitted. | (Default / none) |
true | blocked (default if readOnly: true) | Only SELECT statements are allowed. Any other type of statement (e.g., INSERT, UPDATE, CREATE) will be rejected. | readOnlyHint: true |
true | protected | Enables session-based execution. SELECT statements can be used on all tables, while write operations are allowed only for the session’s temporary dataset (e.g., CREATE TEMP TABLE ...). | readOnlyHint: true |
Note: Conflicting configurations, such as
readOnly: truecombined withwriteMode: allowed, are rejected during server startup.
The tool’s behavior is influenced by the allowedDatasets restriction on the
bigquery source. Similar to writeMode, this setting provides an additional
layer of security by controlling which datasets can be accessed:
- Without
allowedDatasetsrestriction: The tool can execute any valid GoogleSQL query. - With
allowedDatasetsrestriction: Before execution, the tool performs a dry run to analyze the query. It will reject the query if it attempts to access any table outside the alloweddatasetslist. To enforce this restriction, the following operations are also disallowed:- Dataset-level operations (e.g.,
CREATE SCHEMA,ALTER SCHEMA). - Unanalyzable operations where the accessed tables cannot be determined
statically (e.g.,
EXECUTE IMMEDIATE,CREATE PROCEDURE,CALL).
- Dataset-level operations (e.g.,
Note: This tool is intended for developer assistant workflows with human-in-the-loop and shouldn’t be used for production agents.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| BigQuery Source |
Example
kind: tool
name: execute_sql_tool
type: bigquery-execute-sql
source: my-bigquery-source
description: Use this tool to execute sql statement.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “bigquery-execute-sql”. |
| source | string | true | Name of the source the SQL should execute on. |
| description | string | true | Description of the tool that is passed to the LLM. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.