Embabel Agent Documentation/com.embabel.agent.tools.file/FileReadTools

FileReadTools

interface FileReadTools : DirectoryBased, FileReadLog, FileAccessLog, SelfToolCallbackPublisher

LLM-ready ToolCallbacks and convenience methods for file operations. Use at your own risk: This makes changes to your host machine!!

Inheritors

FileTools

Properties

fileContentTransformers

abstract val fileContentTransformers: List<StringTransformer>

Provide sanitizers that run on file content before returning it. They must be sure not to change any content that may need to be replaced as this will break editing if editing is done in the same session.

root

abstract val root: String

Root on host machine

toolCallbacks

open override val toolCallbacks: List<<Error class: unknown class>>

Tool callbacks referenced or exposed.

Functions

asInterface

fun <T> ToolCallbackPublisher.asInterface(intf: Class<T>): T

Expose the ToolGroup as an interface

exists

open fun exists(): Boolean

Does this file exist?

fileCount

open fun fileCount(): Int

Count the total number of files in the repository (excluding .git directory). Uses FileVisitor for cross-platform compatibility (Windows and Linux).

findFiles

open fun findFiles(glob: String): List<String>

open fun findFiles(glob: String, findHighest: Boolean): List<String>

Find files using glob patterns.

flushReads

abstract fun flushReads()

getPathsAccessed

open override fun getPathsAccessed(): List<String>

getPathsRead

open fun getPathsRead(): List<String>

getReads

abstract fun getReads(): List<FileReads>

listFiles

open fun listFiles(path: String): List<String>

readFile

open fun readFile(path: String): String

recordRead

abstract fun recordRead(path: String)

resolveAndValidateFile

open fun resolveAndValidateFile(path: String): Path

resolvePath

open fun resolvePath(path: String): Path

safeReadFile

open fun safeReadFile(path: String): String?

Use for safe reading of files. Returns null if the file doesn't exist or is not readable.