Struct ListDirectoryTool 

pub struct ListDirectoryTool { /* private fields */ }

Tool for listing directory contents

Implementations

impl ListDirectoryTool

pub fn new() -> Self

Creates a new tool using the current working directory as the base path.

Equivalent to Default::default().

Panics

Panics if the current working directory cannot be determined. Use try_new or with_base_path instead.

pub fn try_new() -> Result<Self>

Creates a new tool using the current working directory as the base path.

Returns an error if the current working directory cannot be determined.

pub fn with_base_path(base_path: PathBuf) -> Self

Creates a tool with a custom base directory.

All file operations will be constrained to this directory.

Trait Implementations

impl Default for ListDirectoryTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for ListDirectoryTool

type Input = ListDirectoryInput

The input type for this tool. Must implement Deserialize and JsonSchema.

fn name(&self) -> &str

The name of the tool (e.g., “read_file”, “calculator”)

fn description(&self) -> &str

A description of what the tool does

async fn execute(&self, input: Self::Input) -> Result<ToolResult, ToolError>

Execute the tool with typed input

fn format_output_plain(&self, result: &ToolResult) -> String

Format tool output as plain text.

fn format_output_ansi(&self, result: &ToolResult) -> String

Format tool output with ANSI colors.

fn format_output_markdown(&self, result: &ToolResult) -> String

Format tool output as Markdown.

fn input_schema(&self) -> Value

Get the JSON schema for this tool’s input.

fn format_input_plain(&self, params: &Value) -> String

Format tool input as plain text (for JIRA, logs, copy/paste).

fn format_input_ansi(&self, params: &Value) -> String

Format tool input with ANSI colors (for terminal display).

fn format_input_markdown(&self, params: &Value) -> String

Format tool input as Markdown (for docs, GitHub, rendered UIs).