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

Class ShellTool

java.lang.Object

com.alibaba.cloud.ai.graph.agent.tools.ShellTool

All Implemented Interfaces:

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

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

A tool for executing shell commands. This tool allows for the execution of shell commands within a managed session. The session's lifecycle and configuration are handled by the ShellSessionManager. Example of creating a callback for this tool:

 ToolCallback shellToolCallback = ShellTool.createShellToolCallback("/tmp/agent-workspace");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShellTool.Builder
static final record	ShellTool.Request	Defines the parameters for a shell tool request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TOOL_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
ShellTool(ShellSessionManager sessionManager)	Constructs a new ShellTool.

Method Summary

Modifier and Type	Method	Description
String	apply(ShellTool.Request request, org.springframework.ai.chat.model.ToolContext toolContext)
static ShellTool.Builder	builder(String workspaceRoot)
ShellSessionManager	getSessionManager()

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

DEFAULT_TOOL_DESCRIPTION

public static final String DEFAULT_TOOL_DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

ShellTool

public ShellTool(ShellSessionManager sessionManager)

Constructs a new ShellTool.

Parameters:

sessionManager - The manager for the shell session. Must not be null.

Method Details

apply

public String apply(ShellTool.Request request,
 org.springframework.ai.chat.model.ToolContext toolContext)

Specified by:

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

getSessionManager

public ShellSessionManager getSessionManager()

builder

public static ShellTool.Builder builder(String workspaceRoot)