Embabel Agent Documentation/com.embabel.agent.api.reference/LocalDirectoryReference

LocalDirectoryReference

data class LocalDirectoryReference(val root: String, val description: String, val notes: String, val name: String = root.substringAfterLast('/')) : LlmReferenceProvider, LlmReference

Reference for a local directory on the filesystem. Provides readonly access via file read tools.

Parameters

root

the root directory path

notes

notes on how to use this reference

Constructors

Link copied to clipboard
constructor(root: String, description: String, notes: String, name: String = root.substringAfterLast('/'))

Properties

Link copied to clipboard
open val description: String
Link copied to clipboard
open val name: String
Link copied to clipboard
open val namingStrategy: StringTransformer

Naming strategy for tools associated with this reference. Defaults to prefixing tool names with the tool prefix and an underscore.

Link copied to clipboard
val notes: String
Link copied to clipboard
val root: String

Functions

Link copied to clipboard
open fun asMatryoshka(): LlmReference

Convert this reference to a MatryoshkaReference, exposing a single tool object that supports nesting. Do not rewrap a MatryoshkaReference. Thus repeated calls to this method are safe.

Link copied to clipboard
open fun contribution(): String
Link copied to clipboard
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.

Link copied to clipboard
open override fun reference(): LlmReference

Create an LLM reference

Link copied to clipboard
open fun toolInstances(): List<Any>

Return the instances of tool object. Defaults to this

Link copied to clipboard
open fun toolObject(): ToolObject

Create a tool object for this reference.

Link copied to clipboard
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

Link copied to clipboard
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.

Link copied to clipboard
open fun withUnfolding(): LlmReference

Convert this reference to a reference exposing a single unfolding tool. Does not rewrap an unfolding reference. Thus repeated calls to this method are safe.