tools

package

Go to main page

Versions in this module

v2

v2.13.0

Oct 8, 2026

Changes in this version

+ var ErrTemplatedURLHost = errors.New(...)

type ToolDescriptor

+ Agent *packspec.AgentDef

+ Declaration *packspec.Tool

v2.12.1

Oct 3, 2026

v2.12.0

Oct 3, 2026

v2.11.0

Oct 1, 2026

v2.10.0

Oct 1, 2026

Changes in this version

type MCPExecutor

+ func (e *MCPExecutor) ExecuteMultimodal(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []types.ContentPart, error)

v2.9.1

Sep 30, 2026

v2.9.0

Sep 30, 2026

v2.8.0

Sep 29, 2026

v2.7.0

Sep 28, 2026

Changes in this version

type ToolConfig

+ func (c *ToolConfig) FunctionName() string

v2.6.0

Sep 22, 2026

v2.5.0

Sep 18, 2026

v2.4.0

Sep 18, 2026

v2.3.0

Sep 16, 2026

Changes in this version

type Registry

+ func (r *Registry) Child(opts ...RegistryOption) *Registry

v2.2.1

Sep 14, 2026

v2.2.0

Sep 13, 2026

v2.1.0

Sep 12, 2026

v2.0.0

Sep 12, 2026

Changes in this version

+ const DeclineStrategyError

+ const DeclineStrategyFallback

+ const DeclineStrategyRetry

+ const DefaultMaxAggregateSize

+ const DefaultMaxSchemaCacheSize

+ const DefaultMaxToolResultSize

+ const DefaultToolTimeout

+ const NamespaceSep

+ var ErrAggregateResponseSizeExceeded = fmt.Errorf("aggregate HTTP response size limit exceeded")

+ var ErrInputSchemaRequired = errors.New("input schema is required")

+ var ErrInvalidToolMode = errors.New(...)

+ var ErrMCPExecutorOnly = errors.New("MCP executor can only execute mcp tools")

+ var ErrMockExecutorOnly = errors.New("executor can only execute mock tools")

+ var ErrOutputSchemaRequired = errors.New("output schema is required")

+ var ErrRateLimitExceeded = fmt.Errorf("tool rate limit exceeded")

+ var ErrToolDescriptionRequired = errors.New("tool description is required")

+ var ErrToolNameRequired = errors.New("tool name is required")

+ var ErrToolNotFound = errors.New("tool not found")

+ var ErrToolTimeout = errors.New("tool execution timed out")

+ func CallIDFromContext(ctx context.Context) string

+ func ContentTypeToMediaType(contentType string) string

+ func DecodeArgsExtras(args json.RawMessage, typed any, knownKeys ...string) (map[string]any, error)

+ func IsBinaryContentType(contentType string, acceptTypes []string) bool

+ func IsImplicitTool(name string) bool

+ func IsSystemTool(name string) bool

+ func MatchToolPattern(pattern, name string) bool

+ func MergeExtrasIntoMetadata(target, extras map[string]any) map[string]any

+ func ParseToolName(name string) (namespace, localName string)

+ func QualifyToolName(namespace, localName string) string

+ func ReadMultimodalResponse(resp *http.Response, aggregateSize *atomic.Int64, maxAggregateSize int64) (json.RawMessage, []types.ContentPart, error)

+ func RedactFields(data []byte, fields []string) []byte

+ func ResolveMockParts(parts []types.ContentPart) ([]types.ContentPart, error)

+ func WithCallID(ctx context.Context, id string) context.Context

+ func WithMCPRegistry(ctx context.Context, reg mcp.Registry) context.Context

+ type A2AAuthConfig struct

+ Scheme string

+ Token string

+ TokenEnv string

+ type A2AConfig struct

+ AgentURL string

+ Auth *A2AAuthConfig

+ Headers map[string]string

+ HeadersFromEnv []string

+ RetryPolicy *A2ARetryConfig

+ SkillFilter *A2ASkillFilter

+ SkillID string

+ TimeoutMs int

+ type A2ARetryConfig struct

+ InitialDelayMs int

+ MaxDelayMs int

+ MaxRetries int

+ type A2ASkillFilter struct

+ Allowlist []string

+ Blocklist []string

+ func (f *A2ASkillFilter) IncludesSkill(skillID string) bool

+ type ApprovalChecker func(ctx context.Context, callID, name string, args map[string]any) *PendingToolInfo

+ type AsyncToolExecutor interface

+ ExecuteAsync func(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (*ToolExecutionResult, error)

+ type ClientConfig struct

+ Categories []string

+ Consent *ConsentConfig

+ TimeoutMs int

+ ValidateOutput bool

+ type Coercion struct

+ From any

+ Path string

+ To any

+ type ConsentConfig struct

+ DeclineStrategy string

+ Message string

+ Required bool

+ type DefaultRequestMapper struct

+ func (m *DefaultRequestMapper) BuildBody(bodyArgs map[string]any, jmespathExpr string) (json.RawMessage, error)

+ func (m *DefaultRequestMapper) PartitionArgs(args map[string]any, cfg *RequestMapping, urlTemplate string) (query, header, body map[string]any)

+ func (m *DefaultRequestMapper) RenderHeaders(templates map[string]string, args map[string]any) (map[string]string, error)

+ func (m *DefaultRequestMapper) RenderURL(urlTemplate string, args map[string]any) (string, error)

+ type DefaultResponseMapper struct

+ func (m *DefaultResponseMapper) MapResponse(response json.RawMessage, jmespathExpr string) (json.RawMessage, error)

+ type ErrToolsPending struct

+ Pending []PendingToolExecution

+ func IsErrToolsPending(err error) (*ErrToolsPending, bool)

+ func (e *ErrToolsPending) Error() string

+ type ExecConfig struct

+ Args []string

+ Command string

+ Env []string

+ Runtime string

+ TimeoutMs int

+ type ExecExecutor struct

+ func (e *ExecExecutor) Execute(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *ExecExecutor) Name() string

+ type Executor interface

+ Execute func(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ Name func() string

+ type FileToolResponseRepository struct

+ func NewFileToolResponseRepository(scenarioID string, toolResponses map[string][]MockToolResponseConfig) *FileToolResponseRepository

+ func (r *FileToolResponseRepository) GetToolResponse(toolName string, args map[string]any, contextKey string) (*ToolResponseData, error)

+ type HTTPConfig struct

+ Headers map[string]string

+ HeadersFromEnv []string

+ Method string

+ Multimodal *MultimodalConfig

+ Redact []string

+ Request *RequestMapping

+ Response *ResponseMapping

+ TimeoutMs int

+ URL string

+ type HTTPExecutor struct

+ RequestMapper RequestMapper

+ ResponseMapper ResponseMapper

+ func NewHTTPExecutor() *HTTPExecutor

+ func NewHTTPExecutorWithClient(client *http.Client) *HTTPExecutor

+ func NewHTTPExecutorWithMaxAggregate(maxAggregate int64) *HTTPExecutor

+ func (e *HTTPExecutor) AggregateResponseSize() int64

+ func (e *HTTPExecutor) Execute(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *HTTPExecutor) ExecuteMultimodal(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []types.ContentPart, error)

+ func (e *HTTPExecutor) Name() string

+ func (e *HTTPExecutor) ResetAggregateSize()

+ type HostExtras map[string]any

+ type InMemoryToolResponseRepository struct

+ func NewInMemoryToolResponseRepository() *InMemoryToolResponseRepository

+ func (r *InMemoryToolResponseRepository) AddResponse(contextKey, toolName string, response *ToolResponseData)

+ func (r *InMemoryToolResponseRepository) GetToolResponse(toolName string, args map[string]any, contextKey string) (*ToolResponseData, error)

+ type MCPExecutor struct

+ func NewMCPExecutor(registry mcp.Registry) *MCPExecutor

+ func (e *MCPExecutor) Execute(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *MCPExecutor) Name() string

+ type MockScriptedExecutor struct

+ func NewMockScriptedExecutor() *MockScriptedExecutor

+ func (e *MockScriptedExecutor) Execute(_ context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *MockScriptedExecutor) ExecuteMultimodal(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []types.ContentPart, error)

+ func (e *MockScriptedExecutor) Name() string

+ type MockStaticExecutor struct

+ func NewMockStaticExecutor() *MockStaticExecutor

+ func (e *MockStaticExecutor) Execute(_ context.Context, descriptor *ToolDescriptor, _ json.RawMessage) (json.RawMessage, error)

+ func (e *MockStaticExecutor) ExecuteMultimodal(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []types.ContentPart, error)

+ func (e *MockStaticExecutor) Name() string

+ type MockToolErrorConfig struct

+ Message string

+ Type string

+ type MockToolResponseConfig struct

+ CallArgs map[string]any

+ Error *MockToolErrorConfig

+ Result any

+ type MultimodalConfig struct

+ AcceptTypes []string

+ Enabled bool

+ type MultimodalExecutor interface

+ ExecuteMultimodal func(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []types.ContentPart, error)

+ type PendingToolExecution struct

+ Args map[string]any

+ CallID string

+ PendingInfo *PendingToolInfo

+ ToolName string

+ ToolResult types.MessageToolResult

+ type PendingToolInfo struct

+ Args json.RawMessage

+ CallbackURL string

+ ExpiresAt *time.Time

+ Message string

+ Metadata map[string]any

+ Reason string

+ ToolName string

+ func (p PendingToolInfo) MarshalJSON() ([]byte, error)

+ type Registry struct

+ func NewRegistry(opts ...RegistryOption) *Registry

+ func NewRegistryWithRepository(repo ToolRepository, opts ...RegistryOption) *Registry

+ func (r *Registry) Execute(ctx context.Context, toolName string, args json.RawMessage) (*ToolResult, error)

+ func (r *Registry) ExecuteAsync(ctx context.Context, toolName string, args json.RawMessage) (*ToolExecutionResult, error)

+ func (r *Registry) Fork() *Registry

+ func (r *Registry) Get(name string) *ToolDescriptor

+ func (r *Registry) GetByNamespace(ns string) []*ToolDescriptor

+ func (r *Registry) GetTool(name string) (*ToolDescriptor, error)

+ func (r *Registry) GetTools() map[string]*ToolDescriptor

+ func (r *Registry) GetToolsByNames(names []string) ([]*ToolDescriptor, error)

+ func (r *Registry) IterateTools(fn func(name string, tool *ToolDescriptor))

+ func (r *Registry) List() []string

+ func (r *Registry) LoadToolFromBytes(filename string, data []byte) error

+ func (r *Registry) MaxToolResultSize() int

+ func (r *Registry) Register(descriptor *ToolDescriptor) error

+ func (r *Registry) RegisterExecutor(executor Executor)

+ func (r *Registry) Unregister(name string) bool

+ type RegistryOption func(*Registry)

+ func WithDefaultTimeout(ms int) RegistryOption

+ func WithMaxToolResultSize(bytes int) RegistryOption

+ func WithRateLimit(maxCallsPerMinute int) RegistryOption

+ type RepositoryToolExecutor struct

+ func NewRepositoryToolExecutor(baseExecutor Executor, repo ToolResponseRepository, contextKey string) *RepositoryToolExecutor

+ func (e *RepositoryToolExecutor) Execute(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *RepositoryToolExecutor) Name() string

+ type RequestMapper interface

+ BuildBody func(bodyArgs map[string]any, jmespathExpr string) (json.RawMessage, error)

+ PartitionArgs func(args map[string]any, cfg *RequestMapping, urlTemplate string) (query, header, body map[string]any)

+ RenderHeaders func(templates map[string]string, args map[string]any) (map[string]string, error)

+ RenderURL func(urlTemplate string, args map[string]any) (string, error)

+ type RequestMapping struct

+ BodyMapping string

+ Exclude []string

+ HeaderParams map[string]string

+ QueryParams []string

+ StaticBody map[string]any

+ StaticHeaders map[string]string

+ StaticQuery map[string]string

+ type ResponseMapper interface

+ MapResponse func(response json.RawMessage, jmespathExpr string) (json.RawMessage, error)

+ type ResponseMapping struct

+ BodyMapping string

+ type SchemaValidator struct

+ func NewSchemaValidator() *SchemaValidator

+ func NewSchemaValidatorWithSize(maxSize int) *SchemaValidator

+ func (sv *SchemaValidator) CacheLen() int

+ func (sv *SchemaValidator) CoerceArgs(descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, []Coercion, error)

+ func (sv *SchemaValidator) CoerceResult(descriptor *ToolDescriptor, result json.RawMessage) (json.RawMessage, []Coercion, error)

+ func (sv *SchemaValidator) ValidateArgs(descriptor *ToolDescriptor, args json.RawMessage) error

+ func (sv *SchemaValidator) ValidateResult(descriptor *ToolDescriptor, result json.RawMessage) error

+ type ServerExecutor struct

+ func (e *ServerExecutor) Close() error

+ func (e *ServerExecutor) Execute(ctx context.Context, descriptor *ToolDescriptor, args json.RawMessage) (json.RawMessage, error)

+ func (e *ServerExecutor) Name() string

+ type ToolCall struct

+ Args json.RawMessage

+ ID string

+ Name string

+ func (c ToolCall) MarshalJSON() ([]byte, error)

+ type ToolConfig struct

+ APIVersion string

+ Kind string

+ Metadata metav1.ObjectMeta

+ Spec ToolDescriptor

+ type ToolDescriptor struct

+ A2AConfig *A2AConfig

+ ClientConfig *ClientConfig

+ Description string

+ ExecConfig *ExecConfig

+ HTTPConfig *HTTPConfig

+ InputSchema json.RawMessage

+ Labels map[string]string

+ MockParts []types.ContentPart

+ MockResult json.RawMessage

+ MockResultFile string

+ MockTemplate string

+ MockTemplateFile string

+ Mode string

+ Name string

+ Namespace string

+ OutputSchema json.RawMessage

+ TimeoutMs int

+ func (d ToolDescriptor) MarshalJSON() ([]byte, error)

+ type ToolErrorData struct

+ Message string

+ Type string

+ type ToolExecutionResult struct

+ Content json.RawMessage

+ Error string

+ Parts []types.ContentPart

+ PendingInfo *PendingToolInfo

+ Status ToolExecutionStatus

+ type ToolExecutionStatus string

+ const ToolStatusComplete

+ const ToolStatusFailed

+ const ToolStatusPending

+ type ToolRepository interface

+ ListTools func() ([]string, error)

+ LoadTool func(name string) (*ToolDescriptor, error)

+ SaveTool func(descriptor *ToolDescriptor) error

+ type ToolResponseData struct

+ Error *ToolErrorData

+ Result any

+ type ToolResponseRepository interface

+ GetToolResponse func(toolName string, args map[string]any, contextKey string) (*ToolResponseData, error)

+ type ToolResult struct

+ Error string

+ ID string

+ LatencyMs int64

+ Name string

+ Parts []types.ContentPart

+ Result json.RawMessage

+ func (r ToolResult) MarshalJSON() ([]byte, error)

+ type ValidationError struct

+ Detail string

+ Path string

+ Tool string

+ Type string

+ func (e *ValidationError) Error() string

Other modules containing this package

github.com/AltairaLabs/PromptKit/runtime

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