Skip to main content

steer_tools/tools/
ls.rs

1use schemars::JsonSchema;
2use serde::{Deserialize, Serialize};
3use thiserror::Error;
4
5use crate::ToolSpec;
6use crate::error::{ToolExecutionError, WorkspaceOpError};
7use crate::result::FileListResult;
8
9pub const LS_TOOL_NAME: &str = "ls";
10
11pub struct LsToolSpec;
12
13impl ToolSpec for LsToolSpec {
14    type Params = LsParams;
15    type Result = FileListResult;
16    type Error = LsError;
17
18    const NAME: &'static str = LS_TOOL_NAME;
19    const DISPLAY_NAME: &'static str = "List Files";
20
21    fn execution_error(error: Self::Error) -> ToolExecutionError {
22        ToolExecutionError::Ls(error)
23    }
24}
25
26#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, Error)]
27#[serde(tag = "code", content = "details", rename_all = "snake_case")]
28pub enum LsError {
29    #[error("{0}")]
30    Workspace(WorkspaceOpError),
31}
32
33#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
34pub struct LsParams {
35    /// The absolute path to the directory to list (must be absolute, not relative)
36    pub path: String,
37    /// Optional list of glob patterns to ignore
38    pub ignore: Option<Vec<String>>,
39}