Class ProcessTool

Namespace: LMKit.Agents.Tools.BuiltIn.IO

Assembly: LM-Kit.NET.dll

A built-in tool for executing shell commands and processes.

Enables agents to run programs, execute scripts, and capture output.

public sealed class ProcessTool : ITool

Inheritance: object

ProcessTool

Implements: ITool

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var tool = new ProcessTool(new ProcessToolOptions
{
    AllowedCommands = new HashSet<string> { "git", "dotnet", "npm" }
});
registry.Register(tool);

Remarks

Security Warning: This tool can execute arbitrary commands. Use ProcessToolOptions to restrict allowed commands.

Constructors

ProcessTool(): Initializes a new instance with default settings.

ProcessTool(ProcessToolOptions): 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.