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

Package-level declarations

Types

open class AgentTool(val agent: BaseAgent, val skipSummarization: Boolean = false, val includePlugins: Boolean = true, val propagateGroundingMetadata: Boolean = false) : BaseTool

A tool that wraps a BaseAgent.

BaseRetrievalTool

abstract class BaseRetrievalTool(name: String, description: String, isLongRunning: Boolean = false) : BaseTool

Base class for retrieval tools.

BaseTool

abstract class BaseTool(val name: String, val description: String, val isLongRunning: Boolean = false, val customMetadata: Map<String, Any> = emptyMap()) : AutoCloseable

Abstract base class for defining and executing tools.

ExitLoopTool

class ExitLoopTool : BaseTool

A tool that allows an agent to exit a loop.

FunctionTool

abstract class FunctionTool(name: String, description: String, isLongRunning: Boolean = false, customMetadata: Map<String, Any> = emptyMap(), requiresConfirmation: (Map<String, Any?>) -> Boolean = { false }) : BaseTool

Represents a compile-time generated tool that wraps a function annotated with com.google.adk.kt.annotations.Tool.

GetUserChoiceTool

class GetUserChoiceTool : BaseTool

Built-in long-running tool that presents a list of options and pauses the invocation until the user picks one.

GoogleMapsTool

class GoogleMapsTool : BaseTool

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

GoogleSearchTool

class GoogleSearchTool(val bypassMultiToolsLimit: Boolean = false) : BaseTool

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

LoadArtifactsTool

class LoadArtifactsTool : BaseTool

A tool that loads artifacts and adds them to the session.

LoadMemoryTool

class LoadMemoryTool : BaseTool

A tool that loads the memory for the current user.

PreloadMemoryTool

class PreloadMemoryTool : BaseTool

A tool that preloads the memory for the current user.

ReadonlyToolContext

interface ReadonlyToolContext

A readonly view of the tool context.

RequestInputTool

class RequestInputTool : BaseTool

Built-in long-running tool that asks the user a question and pauses the invocation until they respond.

Schema

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])

annotation class Schema(val name: String = "", val description: String = "", val optional: Boolean = false)

The annotation for binding the 'Schema' input.

SkillToolset

class SkillToolset(source: SkillSource) : Toolset

Toolset exposing the skills a SkillSource provides.

ToolContext

class ToolContext(invocationContext: InvocationContext, actions: EventActions = EventActions(), functionCallId: String? = null, toolConfirmation: ToolConfirmation? = null, eventId: String? = null) : Context

Context passed to tool executions.

ToolFilter

sealed interface ToolFilter

Selects which tools a Toolset exposes to the LLM.

ToolPredicate

fun interface ToolPredicate

Decides whether a BaseTool should be exposed to the LLM under the current context.

Toolset

interface Toolset : AutoCloseable

Base interface for toolsets.

UrlContextTool

class UrlContextTool : BaseTool

A built-in tool that is automatically invoked by Gemini models to retrieve content from the given URLs and use that content to inform and shape its response.

VertexAiRagClientTool

class VertexAiRagClientTool : BaseRetrievalTool

A client-side retrieval tool that fetches context from a Vertex AI RAG corpus.

VertexAiRagRetrieval

class VertexAiRagRetrieval(name: String, description: String, val ragCorpora: List<String>? = null, val ragResources: List<VertexRagStoreRagResource>? = null, val similarityTopK: Int? = null, val vectorDistanceThreshold: Double? = null) : BaseTool

A built-in tool that uses Vertex AI RAG (Retrieval-Augmented Generation) to retrieve data.

VertexAiSearchTool

class VertexAiSearchTool(val dataStoreId: String? = null, val dataStoreSpecs: List<VertexAISearchDataStoreSpec>? = null, val searchEngineId: String? = null, val filter: String? = null, val maxResults: Int? = null, val bypassMultiToolsLimit: Boolean = false) : BaseTool

A built-in tool using Vertex AI Search.

Functions

isToolSelected

fun ToolFilter?.isToolSelected(tool: BaseTool, readonlyContext: ReadonlyContext? = null): Boolean

Returns whether tool is selected by this filter under readonlyContext.

toJsonSchema

fun Schema.toJsonSchema(): JsonObject

Renders this Schema as a JSON Schema JsonObject, the same shape used in prompt tool descriptions. Exposed so an adapter can hand a tool's parameter schema to another framework rather than forking this conversion.