Class ToolContext

The context of the tool.

This class provides the context for a tool invocation, including access to the invocation context, function call ID, event actions, and authentication response. It also provides methods for requesting credentials, retrieving authentication responses, listing artifacts, and searching memory.

Hierarchy (view full)

CallbackContext
- ToolContext

Index

Constructors

constructor

new ToolContext(invocationContext, options?): ToolContext
Constructor for ToolContext
Parameters
- invocationContext: InvocationContext
- options: {
  functionCallId?: string;
  eventActions?: EventActions;
  } = {}
  - OptionalfunctionCallId?: string
  - OptionaleventActions?: EventActions
Returns ToolContext
Overrides CallbackContext.constructor
- Defined in packages/adk/src/tools/tool-context.ts:26

Properties

`Readonly`_eventActions

_eventActions: EventActions

TODO: make this public for Agent Development Kit, but private for users.

`Protected` `Readonly`_invocationContext

_invocationContext: InvocationContext

`Optional`functionCallId

functionCallId?: string

The function call id of the current tool call. This id was returned in the function call event from LLM to identify a function call. If LLM didn't return this id, ADK will assign one to it. This id is used to map function call response to the original function call.

Accessors

state

get state(): State
The delta-aware state of the current session. For any state change, you can mutate this object directly, e.g. ctx.state['foo'] = 'bar'

Returns State
Inherited from CallbackContext.state
- Defined in packages/adk/src/agents/callback-context.ts:38

eventActions

get eventActions(): EventActions
Gets the event actions associated with this context.

Returns EventActions
Inherited from CallbackContext.eventActions
- Defined in packages/adk/src/agents/callback-context.ts:93

invocationContext

get invocationContext(): InvocationContext
Returns InvocationContext
Inherited from CallbackContext.invocationContext
- Defined in packages/adk/src/agents/callback-context.ts:97

userContent

get userContent(): Content
The user content that started this invocation. READONLY field.

Returns Content
Inherited from CallbackContext.userContent
- Defined in packages/adk/src/agents/readonly-context.ts:17

invocationId

get invocationId(): string
The current invocation id.

Returns string
Inherited from CallbackContext.invocationId
- Defined in packages/adk/src/agents/readonly-context.ts:24

agentName

get agentName(): string
The name of the agent that is currently running.

Returns string
Inherited from CallbackContext.agentName
- Defined in packages/adk/src/agents/readonly-context.ts:31

appName

get appName(): string
The application name for this invocation. READONLY field.

Returns string
Inherited from CallbackContext.appName
- Defined in packages/adk/src/agents/readonly-context.ts:38

userId

get userId(): string
The user ID for this invocation. READONLY field.

Returns string
Inherited from CallbackContext.userId
- Defined in packages/adk/src/agents/readonly-context.ts:45

sessionId

get sessionId(): string
The session ID for this invocation. READONLY field.

Returns string
Inherited from CallbackContext.sessionId
- Defined in packages/adk/src/agents/readonly-context.ts:52

actions

get actions(): EventActions
Gets the event actions of the current tool call

Returns EventActions
- Defined in packages/adk/src/tools/tool-context.ts:40

Methods

loadArtifact

loadArtifact(filename, version?): Promise<Part>
Loads an artifact attached to the current session.
Parameters
- filename: string
  The filename of the artifact.
- Optionalversion: number
  The version of the artifact. If undefined, the latest version will be returned.
Returns Promise<Part>
The artifact.
Inherited from CallbackContext.loadArtifact
- Defined in packages/adk/src/agents/callback-context.ts:49

saveArtifact

saveArtifact(filename, artifact): Promise<number>
Saves an artifact and records it as delta for the current session.
Parameters
- filename: string
  The filename of the artifact.
- artifact: Part
  The artifact to save.
Returns Promise<number>
The version of the artifact.
Inherited from CallbackContext.saveArtifact
- Defined in packages/adk/src/agents/callback-context.ts:73

listArtifacts

listArtifacts(): Promise<string[]>
Lists the filenames of the artifacts attached to the current session

Returns Promise<string[]>
- Defined in packages/adk/src/tools/tool-context.ts:47

searchMemory

searchMemory(query): Promise<SearchMemoryResponse>
Searches the memory of the current user
Parameters
- query: string
Returns Promise<SearchMemoryResponse>
- Defined in packages/adk/src/tools/tool-context.ts:62

Class ToolContext

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalfunctionCallId?: string

OptionaleventActions?: EventActions

Returns ToolContext

Properties

Readonly_eventActions

Protected Readonly_invocationContext

OptionalfunctionCallId

Accessors

state

Returns State

eventActions

Returns EventActions

invocationContext

Returns InvocationContext

userContent

Returns Content

invocationId

Returns string

agentName

Returns string

appName

Returns string

userId

Returns string

sessionId

Returns string

actions

Returns EventActions

Methods

loadArtifact

Parameters

Returns Promise<Part>

saveArtifact

Parameters

Returns Promise<number>

listArtifacts

Returns Promise<string[]>

searchMemory

Parameters

Returns Promise<SearchMemoryResponse>

Settings

On This Page

`Optional`functionCallId?: string

`Optional`eventActions?: EventActions

`Readonly`_eventActions

`Protected` `Readonly`_invocationContext

`Optional`functionCallId