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.

Parameters

Path

the filesystem path type used by the provider

Constructors

ListDirectoryTool

constructor(fs: FileSystemProvider.ReadOnly<Path>)

Types

Args

@Serializable

data class Args(val path: 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) : ToolResult.TextSerializable

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

Properties

argsSerializer

open override val argsSerializer: KSerializer<ListDirectoryTool.Args>

description

open override val description: String

descriptor

open val descriptor: ToolDescriptor

name

open override val name: String

resultSerializer

open override val resultSerializer: KSerializer<ListDirectoryTool.Result>

Functions

decodeArgs

fun decodeArgs(rawArgs: JsonObject): ListDirectoryTool.Args

decodeResult

fun decodeResult(rawResult: JsonElement): ListDirectoryTool.Result

encodeArgs

fun encodeArgs(args: ListDirectoryTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: ListDirectoryTool.Args): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?): JsonObject

encodeResult

fun encodeResult(result: ListDirectoryTool.Result): JsonElement

encodeResultToString

open fun encodeResultToString(result: ListDirectoryTool.Result): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?): 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