Table of Contents

Class BuiltInTools

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

Factory for creating and registering built-in tools.

Provides convenient access to commonly needed tools without external dependencies. Tools are organized into categories:

  • Data: Json, Xml, Csv, Ini, Html - structured data formats
  • Text: Text, Diff, Regex, Template, Encoding, Slug - text manipulation
  • Numeric: Calculator, Conversion, Stats, Random, Guid - math and generation
  • Security: Hash, Crypto, Validator, Jwt - encoding, validation, auth
  • Utility: DateTime, Cron, SemVer, Url, Color, Performance - general utilities
  • IO: FileSystem, Environment, Process, Compress, Watch - local I/O operations
  • Net: Http, Network, WebSearch, Smtp - network and web operations
public static class BuiltInTools
Inheritance
BuiltInTools
Inherited Members

Examples

// Register all built-in tools
BuiltInTools.RegisterAll(registry);

// Or register specific tools
registry.Register(BuiltInTools.Calculator);
registry.Register(BuiltInTools.DateTime);

// Or use the extension method
builder.WithTools(tools => tools.AddBuiltInTools());

Properties

AsciiArt

Gets a new ASCII Art tool instance.

Base64Image

Gets a new Base64 Image tool instance.

Bitwise

Gets a new Bitwise tool instance.

Calculator

Gets a new Calculator tool instance.

Checksum

Gets a new Checksum tool instance.

Color

Gets a new Color tool instance.

Compress

Gets a new Compress tool instance with default options.

Conversion

Gets a new Conversion tool instance.

Country

Gets a new Country tool instance.

Cron

Gets a new Cron tool instance.

Crypto

Gets a new Crypto tool instance.

Csv

Gets a new CSV tool instance with default options.

Currency

Gets a new Currency tool instance.

DateTime

Gets a new DateTime tool instance.

Diff

Gets a new Diff tool instance.

Duration

Gets a new Duration tool instance.

Encoding

Gets a new Encoding tool instance.

Environment

Gets a new Environment tool instance with default options.

Expression

Gets a new Expression tool instance.

FileSystem

Gets a new FileSystem tool instance with default (read-only) options.

Financial

Gets a new Financial tool instance.

Fuzzy

Gets a new Fuzzy tool instance.

Guid

Gets a new GUID tool instance.

Hash

Gets a new Hash tool instance.

Html

Gets a new HTML tool instance.

Http

Gets a new HTTP tool instance with default options.

Humanize

Gets a new Humanize tool instance.

Ini

Gets a new INI tool instance.

IpCalc

Gets a new IP Calculator tool instance.

Json

Gets a new JSON tool instance.

Jwt

Gets a new JWT tool instance.

Locale

Gets a new Locale tool instance.

Markdown

Gets a new Markdown tool instance.

Mime

Gets a new MIME tool instance.

Network

Gets a new Network tool instance with default options.

Password

Gets a new Password tool instance.

Path

Gets a new Path tool instance.

Performance

Gets a new Performance tool instance.

Phonetic

Gets a new Phonetic tool instance.

Process

Gets a new Process tool instance with default (restricted) options.

QRCode

Gets a new QR Code tool instance.

Random

Gets a new Random tool instance.

Regex

Gets a new Regex tool instance with default options.

Schedule

Gets a new Schedule tool instance.

SemVer

Gets a new SemVer tool instance.

Slug

Gets a new Slug tool instance.

Stats

Gets a new Stats tool instance.

Template

Gets a new Templating tool instance.

Text

Gets a new Text tool instance.

TimeZone

Gets a new TimeZone tool instance.

Url

Gets a new URL tool instance.

Validator

Gets a new Validator tool instance.

Watch

Gets a new Watch tool instance with default options.

WebSearch

Gets a new Web Search tool instance with default options (DuckDuckGo, no API key required).

Xml

Gets a new XML tool instance with default options.

Yaml

Gets a new YAML tool instance.

Methods

CreateCompress(CompressToolOptions)

Gets a new Compress tool instance with custom options.

CreateCsv(CsvToolOptions)

Gets a new CSV tool instance with custom options.

CreateEnvironment(EnvironmentToolOptions)

Gets a new Environment tool instance with custom options.

CreateFileSystem(FileSystemToolOptions)

Gets a new FileSystem tool instance with custom options.

CreateHttp(HttpToolOptions)

Gets a new HTTP tool instance with custom options.

CreateNetwork(NetworkToolOptions)

Gets a new Network tool instance with custom options.

CreateProcess(ProcessToolOptions)

Gets a new Process tool instance with custom options.

CreateRegex(RegexToolOptions)

Gets a new Regex tool instance with custom options.

CreateSmtp(SmtpToolOptions)

Gets a new SMTP tool instance with the specified options.

CreateWatch(WatchToolOptions)

Gets a new Watch tool instance with custom options.

CreateWebSearch(Options)

Gets a new Web Search tool instance with custom options.

CreateWebSearch(Provider, string)

Gets a new Web Search tool instance with the specified provider.

CreateXml(XmlToolOptions)

Gets a new XML tool instance with custom options.

GetAll()

Gets all built-in tools including I/O tools with default options. Note: SmtpTool is not included as it requires explicit configuration.

GetSafeTools()

Gets all safe built-in tools (no I/O capabilities).

GetToolInfo()

Gets tool information for all built-in tools.

RegisterAll(ToolRegistry)

Registers all built-in tools with a registry.

RegisterSafeTools(ToolRegistry)

Registers all safe built-in tools with a registry.