Class EnvironmentTool

Namespace: LMKit.Agents.Tools.BuiltIn.IO

Assembly: LM-Kit.NET.dll

A built-in tool for accessing environment and system information.

Provides access to environment variables, system info, and runtime details.

public sealed class EnvironmentTool : ITool

Inheritance: object

EnvironmentTool

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 EnvironmentTool();
registry.Register(tool);

// Agent can now get system info, environment variables, etc.

Remarks

This tool provides real system context that LLMs cannot access on their own. Use EnvironmentToolOptions to control what information is exposed.

Constructors

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

EnvironmentTool(EnvironmentToolOptions): 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.