JsSandboxTool class

Secure, isolated JavaScript evaluation tool for Neomage.

Permits the AI agent to execute complex mathematical computations, format conversational structures, and run logic dynamically without ever exposing the host machine's command line or filesystem.

Inheritance

• Object
• Tool
• JsSandboxTool

Constructors

JsSandboxTool()

Properties

alwaysLoad → bool

Whether this tool should always be loaded (never deferred).

no setter, inherited

definition → ToolDefinition

Convert to API tool definition.

no setter, inherited

description → String

Human-readable description.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

inputSchema → Map<String, dynamic>

JSON Schema for the tool's input parameters.

no setter, override

interruptBehavior → InterruptBehavior

How this tool behaves when interrupted by user input.

no setter, inherited

isAvailable → bool

Whether this tool is available on the current platform.

no setter, inherited

isConcurrencySafe → bool

Whether this tool is safe to run concurrently with other tools.

no setter, override

isDestructive → bool

Whether this tool can cause destructive changes.

no setter, inherited

isEnabled → bool

Whether this tool is enabled (can be toggled by config).

no setter, inherited

isMcp → bool

Whether this tool comes from an MCP server.

no setter, inherited

isReadOnly → bool

Whether this tool only reads data (no side effects).

no setter, override

maxResultSizeChars → int?

Maximum size in characters for tool results before disk persistence.

no setter, inherited

mcpInfo → Map<String, dynamic>?

MCP server info if this is an MCP tool.

no setter, inherited

name → String

Tool name as registered with the API.

no setter, override

prompt → String

Detailed prompt text sent in the system prompt for this tool.

no setter, inherited

requiresUserInteraction → bool

Whether this tool requires user interaction (prompts, confirmations).

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shouldDefer → bool

Whether this tool should be deferred (loaded on demand via ToolSearch).

no setter, inherited

strict → bool

Whether this tool enforces strict JSON output.

no setter, inherited

userFacingName → String

Human-facing name for display in permission prompts.

no setter, inherited

Methods

call(Map<String, dynamic> input, ToolUseContext context) → Future<ToolResult>

Execute with full context (default delegates to simple execute).

inherited

checkPermissions(Map<String, dynamic> input, ToolPermissionContext permContext) → Future<PermissionDecision>

Check if this tool use is permitted. Returns a PermissionDecision. Override in subclasses for tool-specific permission logic.

inherited

execute(Map<String, dynamic> input) → Future<ToolResult>

Execute the tool with the given input.

override

getActivityDescription(Map<String, dynamic> input) → String

Activity description for status display.

override

getPermissionExplanation(Map<String, dynamic> input) → PermissionExplanation?

Permission explanation for this tool.

inherited

getToolUseSummary(Map<String, dynamic> input) → String

Short summary of tool use for compact/grouped display.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toAutoClassifierInput(Map<String, dynamic> input) → String

Generate classifier input for auto-permission decisions. Returns empty string to skip classification.

inherited

toString() → String

A string representation of this object.

inherited

validateInput(Map<String, dynamic> input) → ValidationResult

Validate input before execution and permission checks.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited