ai-elements-core/dev.ai.elements.core.agent/ToolCallContext

ToolCallContext

class ToolCallContext : AbstractCoroutineContextElement(source)

The tool call an AgentTool.execute is running for. Agent loops install it in the coroutine context, so a tool reaches it with current without the AgentTool interface growing parameters:

override suspend fun execute(arguments: JsonObject): String {
    ToolCallContext.current()?.progress("Downloading…")
    …
}

Types

Key

object Key : CoroutineContext.Key<ToolCallContext>

Update

sealed interface Update

What a running tool reports before it returns.

Properties

approver

val approver: ToolApprover

The approver of the enclosing chat; nested agents reuse it so their tools ask the same user.

key

open override val key: CoroutineContext.Key<*>

toolCallId

val toolCallId: String

The model's id for this call.

Functions

content

suspend fun content(mediaType: String, url: String)

Return url to the model as well, as Pydantic AI's ToolReturn.content: on-device model loops send it in a user message right after the tool results, so a vision model sees it (e.g. a browser screenshot); the chat shows it with the call, like file. Servers' protocols carry tool results as text, so it reaches only models the device calls.

data

suspend fun data(id: String, name: String, data: JsonElement)

Add or replace a data part of the reply while the tool runs — e.g. plan for the Plan element. In-process only: servers use their protocol's own channel for this.

file

suspend fun file(mediaType: String, url: String)

Attach a file the call produced — a screenshot of what it did, a generated image — as a file part right after the call (AI SDK file part; the steps view shows it with this call). url is a data: or http(s) URL.

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

plus

open operator fun plus(context: CoroutineContext): CoroutineContext

progress

suspend fun progress(output: String)

Show output as an interim result (AI SDK preliminary tool result).

subagent

suspend fun subagent(message: Message)

Publish the live run of a delegated agent (rendered by the Subagent element).