tools

Jun 5, 2026

Changes in this version

+ type PermissionRequest struct

+ InputSummary string

+ RiskLevel string

+ ToolName string

+ type PermissionResponse struct

+ Decision string

+ Pattern string

+ type PromptFunc func(req PermissionRequest) PermissionResponse

type Registry

+ func (r *Registry) SetPromptFunc(fn PromptFunc)

Apr 3, 2026

Changes in this version

+ type HookResult struct

+ Decision string

+ Output string

+ type HookRunner interface

+ RunPostToolUse func(toolName string, input map[string]any) (*HookResult, error)

+ RunPreToolUse func(toolName string, input map[string]any) (*HookResult, error)

type Registry

+ func (r *Registry) SetHookRunner(runner HookRunner)

Apr 1, 2026

Changes in this version

+ type ExecutorResult struct

+ CallID string

+ Err error

+ Result ToolResult

+ State ToolState

+ ToolName string

+ type InterruptBehavior int

+ const InterruptBlock

+ const InterruptCancel

+ type ProgressEvent struct

+ Message string

+ Percent float64

+ ToolName string

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) Count() int

+ func (r *Registry) Execute(ctx context.Context, name string, input map[string]any) (ToolResult, error)

+ func (r *Registry) ExecuteWithProgress(ctx context.Context, name string, input map[string]any, ...) (ToolResult, error)

+ func (r *Registry) Get(name string) (Tool, bool)

+ func (r *Registry) GetAll() []Tool

+ func (r *Registry) GetToolDefinitions() []map[string]any

+ func (r *Registry) GetToolDefinitionsForMode(mode RuntimeMode) []map[string]any

+ func (r *Registry) GetTools(mode RuntimeMode) []Tool

+ func (r *Registry) LoadCustomTools(dir string) error

+ func (r *Registry) Register(tool Tool)

+ func (r *Registry) RegisterWithModes(tool Tool, modes ...RuntimeMode)

+ func (r *Registry) SetPermissionChecker(checker *permissions.Checker)

+ type RuntimeMode int

+ const ModeAgent

+ const ModeChat

+ const ModeClaw

+ const ModeOrchestrator

+ type StreamingToolExecutor struct

+ func NewStreamingToolExecutor(registry *Registry) *StreamingToolExecutor

+ func NewStreamingToolExecutorWithContext(ctx context.Context, registry *Registry) *StreamingToolExecutor

+ func (e *StreamingToolExecutor) AddTool(callID, toolName, inputJSON string)

+ func (e *StreamingToolExecutor) Cancel()

+ func (e *StreamingToolExecutor) Done()

+ func (e *StreamingToolExecutor) OnProgress(fn func(ProgressEvent))

+ func (e *StreamingToolExecutor) SetCascadeOnFailure(enabled bool)

+ func (e *StreamingToolExecutor) States() map[string]ToolState

+ func (e *StreamingToolExecutor) Wait() []ExecutorResult

+ type Tool interface

+ Description func() string

+ Execute func(ctx context.Context, input map[string]any, progress chan<- ProgressEvent) (ToolResult, error)

+ InterruptBehavior func() InterruptBehavior

+ IsConcurrencySafe func(input map[string]any) bool

+ IsReadOnly func() bool

+ Name func() string

+ Parameters func() json.RawMessage

+ ValidateInput func(input map[string]any) error

+ type ToolResult struct

+ Content string

+ Error bool

+ Metadata map[string]any

+ type ToolState int

+ const ToolStateAborted

+ const ToolStateCompleted

+ const ToolStateExecuting

+ const ToolStateFailed

+ const ToolStateQueued

+ func (s ToolState) String() string