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

LocalDirectory

data class LocalDirectory constructor(val root: String, val description: String, val notes: String = "", val fileContentTransformers: List<StringTransformer> = listOf(WellKnownFileContentTransformers.removeApacheLicenseHeader)) : FileReadTools, PatternSearch, FileReadLog, LlmReference

Readonly access to a project on the local filesystem.

Constructors

LocalDirectory

constructor(root: String, description: String, notes: String = "", fileContentTransformers: List<StringTransformer> = listOf(WellKnownFileContentTransformers.removeApacheLicenseHeader))

Properties

description

open val description: String

fileContentTransformers

open override 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.

name

open val name: String

namingStrategy

open val namingStrategy: StringTransformer

notes

val notes: String

root

open override val root: String

Root on host machine

toolCallbacks

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

Tool callbacks referenced or exposed.

Functions

contribution

open fun contribution(): String

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

fileSize

open fun fileSize(path: String): String

findFiles

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

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

Find files using glob patterns.

findPatternInProject

open fun findPatternInProject(pattern: String, globPattern: String): String

open fun findPatternInProject(pattern: <Error class: unknown class>, globPattern: String, useParallelSearch: Boolean = true): List<PatternSearch.PatternMatch>

Finds files containing the specified pattern using glob patterns

flushReads

open override fun flushReads()

getPathsAccessed

open override fun getPathsAccessed(): List<String>

getPathsRead

open override fun getPathsRead(): List<String>

getReads

open override fun getReads(): List<FileReads>

listFiles

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

matchesGlob

open fun matchesGlob(path: String, globPattern: String): Boolean

Checks if a file path matches a glob pattern

notes

open override fun notes(): String

Notes about this reference, such as usage guidance. Does not need to consider prompt prefix, name or description as they will be added automatically.

readFile

open fun readFile(path: String): String

recordRead

open override 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.

toolInstances

open fun toolInstances(): List<Any>

Return the instances of tool object. Defaults to this

toolObject

open fun toolObject(): ToolObject

Create a tool object for this reference.

toolPrefix

open fun toolPrefix(): String

A safe prefix for LLM tools associated with this reference. Defaults to the name lowercased with spaces replaced by underscores. Subclasses can override it

tools

open fun tools(): List<Tool>

Return framework-agnostic tools provided by this reference. These tools will be added to the PromptRunner when the reference is added. Defaults to empty list for backward compatibility.

withUsageNotes

fun withUsageNotes(notes: String): LocalDirectory

Returns a copy of this LocalDirectory with the given usage notes.