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.

fileFormatLimits

val fileFormatLimits: FileFormatLimits

localPath

val localPath: Path

name

open val name: String

root

open override val root: String

Root on host machine

shouldDeleteOnClose

val shouldDeleteOnClose: Boolean = true

toolCallbacks

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

Tool callbacks referenced or exposed.

url

val url: String

Functions

asInterface

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

Expose the ToolGroup as an interface

open override fun close()

contribution

open fun contribution(): String

equals

open operator override fun equals(other: Any?): Boolean

Equality based on localPath only, not on cleanup behavior or limits.

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

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>

hashCode

open override fun hashCode(): Int

listFiles

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

notes

open override fun notes(): String

Return a prompt contributor if the repo is small enough

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.

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

toString

open override fun toString(): String

writeAllFilesToString

fun writeAllFilesToString(): String

Write all files in the repository to a single string. Only use this for small repositories as it loads everything into memory. Applies file content transformers (like removing Apache license headers). Uses FileVisitor for cross-platform compatibility.