tools

package

v0.6.2 Latest Latest Go to latest Published: May 11, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/floegence/redeven

Links

Open Source Insights

Documentation ¶

Index ¶

func ErrFromToolError(toolErr *ToolError) error
func InvocationRiskInfo(toolName string, args map[string]any) (string, string)
func InvocationRiskLabel(toolName string, args map[string]any) string
func IsDangerousInvocation(toolName string, args map[string]any) bool
func IsMutating(toolName string) bool
func IsMutatingForInvocation(toolName string, args map[string]any) bool
func MergeNormalizedArgs(args map[string]any, normalized map[string]any) map[string]any
func NormalizeTerminalCommand(command string) string
func RequiresApproval(toolName string) bool
func RequiresApprovalForInvocation(toolName string, args map[string]any) bool
func ShouldRetryWithNormalizedArgs(toolErr *ToolError) bool
type Definition
- func LookupDefinition(toolName string) (Definition, bool)
type ErrorCode
type Event
- func NewEvent(kind EventKind, runID string, toolID string, toolName string, ...) Event
type EventKind
type Invocation
type ResultStatus
type TerminalCommandProfile
- func InvocationCommandProfile(toolName string, args map[string]any) TerminalCommandProfile
- func ProfileTerminalCommand(command string) TerminalCommandProfile
type TerminalCommandRisk
- func ClassifyTerminalCommandRisk(command string) TerminalCommandRisk
type ToolError
- func ClassifyError(inv Invocation, err error) *ToolError
- func (e *ToolError) Normalize()
type ToolResultEnvelope
- func (e *ToolResultEnvelope) Normalize()

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ErrFromToolError ¶

func ErrFromToolError(toolErr *ToolError) error

func InvocationRiskInfo ¶

func InvocationRiskInfo(toolName string, args map[string]any) (string, string)

func InvocationRiskLabel ¶

func InvocationRiskLabel(toolName string, args map[string]any) string

func IsDangerousInvocation ¶

func IsDangerousInvocation(toolName string, args map[string]any) bool

func IsMutating ¶

func IsMutating(toolName string) bool

func IsMutatingForInvocation ¶

func IsMutatingForInvocation(toolName string, args map[string]any) bool

func MergeNormalizedArgs ¶

func MergeNormalizedArgs(args map[string]any, normalized map[string]any) map[string]any

func NormalizeTerminalCommand ¶

func NormalizeTerminalCommand(command string) string

func RequiresApproval ¶

func RequiresApproval(toolName string) bool

func RequiresApprovalForInvocation ¶

func RequiresApprovalForInvocation(toolName string, args map[string]any) bool

func ShouldRetryWithNormalizedArgs ¶

func ShouldRetryWithNormalizedArgs(toolErr *ToolError) bool

ShouldRetryWithNormalizedArgs returns true when the caller should perform one deterministic retry.

Types ¶

type Definition ¶

type Definition struct {
	Name             string
	Mutating         bool
	RequiresApproval bool
}

Definition describes built-in tool properties used by policies.

func LookupDefinition ¶

func LookupDefinition(toolName string) (Definition, bool)

type ErrorCode ¶

type ErrorCode string

ErrorCode is a stable, machine-readable tool error code.

const (
	ErrorCodeNotFound         ErrorCode = "NOT_FOUND"
	ErrorCodeInvalidPath      ErrorCode = "INVALID_PATH"
	ErrorCodeInvalidArguments ErrorCode = "INVALID_ARGUMENTS"
	ErrorCodePermissionDenied ErrorCode = "PERMISSION_DENIED"
	ErrorCodeTimeout          ErrorCode = "TIMEOUT"
	ErrorCodeCanceled         ErrorCode = "CANCELED"
	ErrorCodeUnknown          ErrorCode = "UNKNOWN"
)

type Event ¶

type Event struct {
	Kind     EventKind      `json:"kind"`
	RunID    string         `json:"run_id"`
	ToolID   string         `json:"tool_id"`
	ToolName string         `json:"tool_name"`
	AtUnixMs int64          `json:"at_unix_ms"`
	Payload  map[string]any `json:"payload,omitempty"`
}

Event is emitted by the orchestrator and can be forwarded to runtime streams / storage.

func NewEvent ¶

func NewEvent(kind EventKind, runID string, toolID string, toolName string, payload map[string]any) Event

type EventKind ¶

type EventKind string

EventKind is a normalized tool lifecycle event type.

const (
	EventKindBegin    EventKind = "tool.begin"
	EventKindEnd      EventKind = "tool.end"
	EventKindError    EventKind = "tool.error"
	EventKindRecovery EventKind = "tool.recovery"
)

type Invocation ¶

type Invocation struct {
	ToolName     string
	Args         map[string]any
	WorkingDir   string
	AgentHomeDir string
}

Invocation carries the minimum context required for error classification and retry hints.

type ResultStatus ¶

type ResultStatus string

ResultStatus is the normalized status returned by the Go tool runtime.

const (
	ResultStatusSuccess    ResultStatus = "success"
	ResultStatusError      ResultStatus = "error"
	ResultStatusRecovering ResultStatus = "recovering"
)

type TerminalCommandProfile ¶

type TerminalCommandProfile struct {
	Risk              TerminalCommandRisk
	NormalizedCommand string
	Effects           []string
	Reason            string
}

func InvocationCommandProfile ¶

func InvocationCommandProfile(toolName string, args map[string]any) TerminalCommandProfile

func ProfileTerminalCommand ¶

func ProfileTerminalCommand(command string) TerminalCommandProfile

type TerminalCommandRisk ¶

type TerminalCommandRisk string

const (
	TerminalCommandRiskReadonly  TerminalCommandRisk = "readonly"
	TerminalCommandRiskMutating  TerminalCommandRisk = "mutating"
	TerminalCommandRiskDangerous TerminalCommandRisk = "dangerous"
)

func ClassifyTerminalCommandRisk ¶

func ClassifyTerminalCommandRisk(command string) TerminalCommandRisk

type ToolError ¶

type ToolError struct {
	Code           ErrorCode      `json:"code"`
	Message        string         `json:"message"`
	Retryable      bool           `json:"retryable,omitempty"`
	SuggestedFixes []string       `json:"suggested_fixes,omitempty"`
	NormalizedArgs map[string]any `json:"normalized_args,omitempty"`
	Meta           map[string]any `json:"meta,omitempty"`
}

ToolError carries structured tool failure metadata.

func ClassifyError ¶

func ClassifyError(inv Invocation, err error) *ToolError

func (*ToolError) Normalize ¶

func (e *ToolError) Normalize()

type ToolResultEnvelope ¶

type ToolResultEnvelope struct {
	RunID  string       `json:"run_id"`
	ToolID string       `json:"tool_id"`
	Status ResultStatus `json:"status"`
	Result any          `json:"result,omitempty"`
	Error  *ToolError   `json:"error,omitempty"`
}

ToolResultEnvelope is the normalized payload for tool call completion.

func (*ToolResultEnvelope) Normalize ¶

func (e *ToolResultEnvelope) Normalize()

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL