Package com.embabel.agent.tools.file

Class LocalDirectory

  • All Implemented Interfaces:
    com.embabel.agent.api.common.LlmReference , com.embabel.agent.api.common.support.SelfToolPublisher , com.embabel.agent.core.ToolPublisher , com.embabel.agent.core.ToolSpec , com.embabel.agent.tools.DirectoryBased , com.embabel.agent.tools.file.FileAccessLog , com.embabel.agent.tools.file.FileReadLog , com.embabel.agent.tools.file.FileReadTools , com.embabel.agent.tools.file.PatternSearch , com.embabel.common.ai.prompt.PromptContributor , com.embabel.common.ai.prompt.PromptElement , com.embabel.common.core.types.Described , com.embabel.common.core.types.Named , com.embabel.common.core.types.NamedAndDescribed 
    
public final class LocalDirectory
 implements FileReadTools, PatternSearch, FileReadLog, LlmReference

    Readonly access to a project on the local filesystem.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getName()
      String getRoot() Root on host machine
      String getDescription()
      final String getNotes()
      List<StringTransformer> getFileContentTransformers() Provide sanitizers that run on file content before returning it.
      String notes() Notes about this reference, such as usage guidance.
      final LocalDirectory withUsageNotes(String notes) Returns a copy of this LocalDirectory with the given usage notes.

      • Methods inherited from class com.embabel.agent.api.common.support.SelfToolPublisher

        getTools

      • Methods inherited from class com.embabel.agent.api.common.LlmReference

        asMatryoshka, contribution, getNamingStrategy, toolInstances, toolObject, toolPrefix, tools

      • Methods inherited from class com.embabel.common.ai.prompt.PromptElement

        getPromptContributionLocation, getRole

      • Methods inherited from class com.embabel.agent.tools.file.FileReadTools

        exists, fileCount, fileSize, findFiles, findFiles, getPathsAccessed, listFiles, readFile, resolveAndValidateFile, resolvePath, safeReadFile

      • Methods inherited from class com.embabel.agent.tools.file.FileReadLog

        flushReads, getPathsRead, getReads, recordRead

      • Methods inherited from class com.embabel.agent.tools.file.PatternSearch

        findPatternInProject, findPatternInProject, matchesGlob

      • Methods inherited from class com.embabel.common.ai.prompt.PromptContributor

        promptContribution

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait