# Package-level declarations

## Types

AgentTool
Link copied to clipboard
class AgentTool(val agent: BaseAgent, val skipSummarization: Boolean = false) : BaseTool

A tool that wraps a BaseAgent.

BaseTool
Link copied to clipboard
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
Link copied to clipboard
class ExitLoopTool : BaseTool

A tool that allows an agent to exit a loop.

FunctionTool
Link copied to clipboard
abstract class FunctionTool(val name: String, val description: String, val isLongRunning: Boolean = false, val 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.

GoogleMapsTool
Link copied to clipboard
class GoogleMapsTool(val model: String? = null) : BaseTool

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

GoogleSearchTool
Link copied to clipboard
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.

LoadArtifactsTool
Link copied to clipboard
class LoadArtifactsTool : BaseTool

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

LoadMemoryTool
Link copied to clipboard
class LoadMemoryTool : BaseTool

A tool that loads the memory for the current user.

PreloadMemoryTool
Link copied to clipboard
class PreloadMemoryTool : BaseTool

A tool that preloads the memory for the current user.

PromptFormat
Link copied to clipboard
enum PromptFormat : Enum<PromptFormat>

The format to use when rendering prompt descriptions of tools.

ReadonlyToolContext
Link copied to clipboard
interface ReadonlyToolContext

A readonly view of the tool context.

Schema
Link copied to clipboard
@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
Link copied to clipboard
class SkillToolset(source: SkillSource) : Toolset

Toolset that manages and provides access to a collection of Skills.

ToolContext
Link copied to clipboard
class ToolContext(val invocationContext: InvocationContext, val actions: EventActions = EventActions(), val functionCallId: String? = null, val toolConfirmation: ToolConfirmation? = null, val eventId: String? = null) : ReadonlyToolContext

ToolContext provides a structured context for executing tools or functions.

Toolset
Link copied to clipboard
interface Toolset : AutoCloseable

Base interface for toolsets.

VertexAiSearchTool
Link copied to clipboard
class VertexAiSearchTool(val dataStoreId: String? = null, val dataStoreSpecs: List<VertexAISearchDataStoreSpec>? = null, val searchEngineId: String? = null, val filter: String? = null, val maxResults: Int? = null, val model: String? = null) : BaseTool

A built-in tool using Vertex AI Search.