Table of Contents

Class FileSystemTreeTool

Namespace
LMKit.Agents.Tools.BuiltIn.IO
Assembly
LM-Kit.NET.dll

Generates a directory tree visualization showing the hierarchical structure of files and folders, similar to the tree command.

public sealed class FileSystemTreeTool : IBuiltInTool, ITool, IToolMetadata
Inheritance
FileSystemTreeTool
Implements
Inherited Members

Examples

Producing a project layout overview for documentation:

using LMKit.Agents;
using LMKit.Agents.Tools.BuiltIn.IO;

var agent = Agent.CreateBuilder(model)
.WithTools(t => t.Register(new FileSystemTreeTool()))
.Build();


var result = await agent.RunAsync(@"Show me the directory tree of C:\src\app, depth 3.");

Constructors

FileSystemTreeTool()

Initializes a new instance with default settings.

FileSystemTreeTool(FileSystemToolOptions)

Initializes a new instance with custom options.

Properties

Description

Gets a concise description of what the tool does.

InputSchema

Gets the JSON Schema defining the expected input arguments.

Name

Gets the stable, unique identifier for this tool.

Methods

InvokeAsync(string, CancellationToken)

Executes the tool with the specified JSON arguments.

Share