# LoadArtifactsTool

class LoadArtifactsTool : BaseTool

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

This tool informs the model about available artifacts and provides their content when requested by the model through a function call.

## Constructors

LoadArtifactsTool
Link copied to clipboard
constructor()

## Types

Companion
Link copied to clipboard
object Companion

## Properties

customMetadata
Link copied to clipboard
val customMetadata: Map<String, Any>

The custom metadata of the tool.

description
Link copied to clipboard
val description: String

The description of the tool.

isLongRunning
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`).

name
Link copied to clipboard
val name: String

The name of the tool.

## Functions

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

Returns the underlying function declaration.

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

Processes the LLM request before it is sent.

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

Executes the tool.