Enum ToolSideEffect

Namespace

LMKit.Agents.Tools

Assembly

LM-Kit.NET.dll

Classifies the external side effects a tool may produce when invoked.

public enum ToolSideEffect

Fields

None = 0

The tool is pure computation with no side effects. It reads no external state and writes nothing. Examples: calculator, text manipulation, encoding.

LocalRead = 1

The tool reads local state but does not modify it. Examples: reading files, listing directories, reading environment variables.

LocalWrite = 2

The tool modifies local state (files, processes, clipboard). Examples: writing files, creating directories, killing processes.

NetworkRead = 3

The tool performs read-only network operations. Examples: HTTP GET, DNS lookup, ping, web search.

NetworkWrite = 4

The tool performs network operations that modify remote state. Examples: HTTP POST/PUT/DELETE, sending emails, FTP upload.

Irreversible = 5

The tool performs an irreversible or destructive operation. Examples: deleting files, dropping database tables, sending emails.

Remarks

Side effect classification helps security policies and approval workflows understand what a tool does beyond returning a result. Tools with higher side effect levels typically require stricter governance.