Package com.alibaba.cloud.ai.graph.agent.extension.tools.filesystem

Class ListFilesTool

java.lang.Object

com.alibaba.cloud.ai.graph.agent.extension.tools.filesystem.ListFilesTool

All Implemented Interfaces:

BiFunction<String,org.springframework.ai.chat.model.ToolContext,String>

public class ListFilesTool
extends Object
implements BiFunction<String,org.springframework.ai.chat.model.ToolContext,String>

Tool for listing files in a directory.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
ListFilesTool()

Method Summary

Modifier and Type	Method	Description
String	apply(String path, org.springframework.ai.chat.model.ToolContext toolContext)
static org.springframework.ai.tool.ToolCallback	createListFilesToolCallback(String description)
static List<FileInfo>	listFilesContent(Path dirPath, Path cwd, boolean virtualMode)	Core logic for listing files and directories in a directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Field Details

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

ListFilesTool

public ListFilesTool()

Method Details

apply

public String apply(@ToolParam(description="The directory path to list files from")
 String path,
 org.springframework.ai.chat.model.ToolContext toolContext)

Specified by:

apply in interface BiFunction<String,org.springframework.ai.chat.model.ToolContext,String>

listFilesContent

public static List<FileInfo> listFilesContent(Path dirPath,
 Path cwd,
 boolean virtualMode)

Core logic for listing files and directories in a directory. This method can be reused by other classes like FileSystemTools.

Parameters:

dirPath - The directory path to list files from

cwd - Current working directory for virtual mode path processing (null to disable virtual mode)

virtualMode - Whether to use virtual mode (strip cwd prefix from paths)

Returns:

List of FileInfo objects for files and directories

createListFilesToolCallback

public static org.springframework.ai.tool.ToolCallback createListFilesToolCallback(String description)