Skip to main content

ShellTool

Struct ShellTool 

Source
pub struct ShellTool { /* private fields */ }
Expand description

Shell 工具:执行系统命令。

支持超时和输出限制,防止命令执行时间过长或输出过大。

§安全机制

  • 命令黑名单检查
  • 危险操作符检测
  • 路径遍历防护
  • 安全的环境变量(清除敏感变量)
  • 超时和输出大小限制

适用场景:

  • 执行系统命令
  • 运行脚本

输入格式:

{
  "command": "要执行的命令",
  "args": ["命令参数"],
  "timeout": 60,  // 可选,超时时间(秒)
  "working_dir": "/path/to/dir"  // 可选,工作目录
}

Implementations§

Source§

impl ShellTool

Source

pub fn new() -> Self

创建一个新的 ShellTool 实例(使用默认安全配置)。

Source

pub fn with_allowed_commands(self, commands: Vec<String>) -> Self

设置允许的命令白名单。

如果设置了白名单,只有白名单中的命令可以执行。

Source

pub fn with_forbidden_commands(self, commands: Vec<String>) -> Self

添加额外的禁止命令。

Trait Implementations§

Source§

impl Default for ShellTool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Tool for ShellTool

Source§

fn name(&self) -> &str

工具名称(必须唯一) Read more
Source§

fn description(&self) -> Option<&str>

工具描述(可选) Read more
Source§

fn categories(&self) -> &'static [ToolCategory]

工具分类 Read more
Source§

fn input_schema(&self) -> Value

工具输入参数的 schema Read more
Source§

fn call<'life0, 'async_trait>( &'life0 self, input: Value, ) -> Pin<Box<dyn Future<Output = Result<Value, ToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

执行工具 Read more
Source§

fn definition(&self) -> ToolDefinition

获取工具定义 (ToolDefinition) Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more