google-adk-kotlin-core/com.google.adk.kt.tools/GoogleSearchTool

GoogleSearchTool

class GoogleSearchTool(val bypassMultiToolsLimit: Boolean = false, val model: String? = null) : BaseTool

A built-in tool that is automatically invoked by Gemini 2 and 3 models to retrieve search results from Google Search.

This tool operates internally within the model and does not require or perform local code execution.

Constructors

Link copied to clipboard
constructor(bypassMultiToolsLimit: Boolean = false, model: String? = null)

Properties

Link copied to clipboard
val bypassMultiToolsLimit: Boolean = false
Link copied to clipboard
val customMetadata: Map<String, Any>

The custom metadata of the tool.

Link copied to clipboard
val description: String

The description of the tool.

Link copied to clipboard
val isLongRunning: Boolean = false

Whether the tool's final result will be delivered out-of-band. When true, the framework marks the call as long-running and uses the tool's return value as the function-response payload (or suppresses the response entirely if the tool returns Unit).

Link copied to clipboard
val model: String? = null
Link copied to clipboard
val name: String

The name of the tool.

Functions

Link copied to clipboard
open override fun close()
Link copied to clipboard
open override fun declaration(): FunctionDeclaration?

Returns the underlying function declaration.

Link copied to clipboard
open suspend override fun processLlmRequest(toolContext: ToolContext, llmRequest: LlmRequest): LlmRequest

Processes the LLM request before it is sent.

Link copied to clipboard
open suspend override fun run(context: ToolContext, args: Map<String, Any>): Any

Executes the tool.