agents-ext/ai.koog.agents.ext.tool.file/ListDirectoryTool

ListDirectoryTool

class ListDirectoryTool<Path>(fs: FileSystemProvider.ReadOnly<Path>) : Tool<ListDirectoryTool.Args, ListDirectoryTool.Result> (source)

Provides functionality to list directory contents with configurable depth and glob filtering parameters, returning a structured directory tree with file and folder metadata.

Type Parameters

Path

the filesystem path type used by the provider

Constructors

ListDirectoryTool

constructor(fs: FileSystemProvider.ReadOnly<Path>)

Types

Args

@Serializable

data class Args(val absolutePath: String, val depth: Int = 1, val filter: String? = null)

Specifies which directory to list and how to traverse its contents.

Result

@Serializable

data class Result(val root: FileSystemEntry.Folder)

Contains the successfully listed directory with its hierarchical structure and metadata.

Properties

argsType

val argsType: TypeToken

descriptor

val descriptor: ToolDescriptor

metadata

val metadata: Map<String, String>

name

val name: String

resultType

val resultType: TypeToken

Functions

decodeArgs

open fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): ListDirectoryTool.Args

decodeResult

open fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): ListDirectoryTool.Result

encodeArgs

open fun encodeArgs(args: ListDirectoryTool.Args, serializer: JSONSerializer): JSONObject

encodeArgsToString

fun encodeArgsToString(args: ListDirectoryTool.Args, serializer: JSONSerializer): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?, serializer: JSONSerializer): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?, serializer: JSONSerializer): JSONObject

encodeResult

open fun encodeResult(result: ListDirectoryTool.Result, serializer: JSONSerializer): JSONElement

encodeResultToString

open override fun encodeResultToString(result: ListDirectoryTool.Result, serializer: JSONSerializer): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?, serializer: JSONSerializer): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?, serializer: JSONSerializer): JSONElement

execute

open suspend override fun execute(args: ListDirectoryTool.Args): ListDirectoryTool.Result

Lists directory contents from the filesystem with optional depth and pattern filtering.

executeUnsafe

suspend fun executeUnsafe(args: Any?): ListDirectoryTool.Result