tools

package

Go to main page

Versions in this module

v0

v0.3.1

Aug 2, 2026

Changes in this version

+ const PersistedPathLabel

+ const ToolOutputsSubdir

+ func PersistedOutputPath(text string) string

+ type OutputLimiter struct

+ func NewOutputLimiter() *OutputLimiter

+ func (l *OutputLimiter) Middleware() agentcore.ToolMiddleware

+ func (l *OutputLimiter) SetOutputDir(dirFn func() string)

v0.3.0

Jul 31, 2026

Changes in this version

+ func InjectAskUserResponse(args json.RawMessage, resp *AskUserResponse) (json.RawMessage, error)

+ func SanitizeAskUserArgs(args json.RawMessage) json.RawMessage

+ type EnterWorktreeTool struct

+ func NewEnterWorktree() *EnterWorktreeTool

+ func (t *EnterWorktreeTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *EnterWorktreeTool) Description() string

+ func (t *EnterWorktreeTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *EnterWorktreeTool) Label() string

+ func (t *EnterWorktreeTool) Name() string

+ func (t *EnterWorktreeTool) PermissionMetadata() permission.Metadata

+ func (t *EnterWorktreeTool) Schema() map[string]any

+ func (t *EnterWorktreeTool) SetEnter(fn func(string) (string, error))

+ type ExitWorktreeTool struct

+ func NewExitWorktree() *ExitWorktreeTool

+ func (t *ExitWorktreeTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *ExitWorktreeTool) Description() string

+ func (t *ExitWorktreeTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *ExitWorktreeTool) Label() string

+ func (t *ExitWorktreeTool) Name() string

+ func (t *ExitWorktreeTool) PermissionMetadata() permission.Metadata

+ func (t *ExitWorktreeTool) Schema() map[string]any

+ func (t *ExitWorktreeTool) SetExit(fn func(bool) (string, error))

type Question

+ func ParseAskUserQuestions(args json.RawMessage) ([]Question, error)

v0.2.2

Jun 14, 2026

Changes in this version

+ type GoalCreateTool struct

+ func NewGoalCreate() *GoalCreateTool

+ func (t *GoalCreateTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *GoalCreateTool) Description() string

+ func (t *GoalCreateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *GoalCreateTool) Label() string

+ func (t *GoalCreateTool) Name() string

+ func (t *GoalCreateTool) PermissionMetadata() permission.Metadata

+ func (t *GoalCreateTool) Schema() map[string]any

+ func (t *GoalCreateTool) SetCreator(fn func(string, int) (goal.State, error))

+ type GoalGetTool struct

+ func NewGoalGet() *GoalGetTool

+ func (t *GoalGetTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *GoalGetTool) Description() string

+ func (t *GoalGetTool) Execute(_ context.Context, _ json.RawMessage) (json.RawMessage, error)

+ func (t *GoalGetTool) Label() string

+ func (t *GoalGetTool) Name() string

+ func (t *GoalGetTool) PermissionMetadata() permission.Metadata

+ func (t *GoalGetTool) ReadOnly(_ json.RawMessage) bool

+ func (t *GoalGetTool) Schema() map[string]any

+ func (t *GoalGetTool) SetSnapshotter(fn func() goal.State)

+ type GoalUpdateTool struct

+ func NewGoalUpdate() *GoalUpdateTool

+ func (t *GoalUpdateTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *GoalUpdateTool) Description() string

+ func (t *GoalUpdateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *GoalUpdateTool) Label() string

+ func (t *GoalUpdateTool) Name() string

+ func (t *GoalUpdateTool) PermissionMetadata() permission.Metadata

+ func (t *GoalUpdateTool) Schema() map[string]any

+ func (t *GoalUpdateTool) SetHandlers(complete, block func(string) (goal.State, error))

v0.2.0

Jun 5, 2026

Changes in this version

+ func NewTeamTools(reg *team.Registry, rt *task.Runtime, leaderID string) []agentcore.Tool

+ type AssignmentNotifier func(ctx context.Context, toAgent string, p AssignmentPayload)

+ type AssignmentPayload struct

+ Description string

+ Subject string

+ TaskID string

+ type SendMessageTool struct

+ func NewSendMessageTool(rt *task.Runtime, reg *team.Registry) *SendMessageTool

+ func (t *SendMessageTool) Description() string

+ func (t *SendMessageTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *SendMessageTool) Label() string

+ func (t *SendMessageTool) Name() string

+ func (t *SendMessageTool) Schema() map[string]any

+ func (t *SendMessageTool) SetWaker(w TeammateWaker)

type TaskUpdateTool

+ func (t *TaskUpdateTool) SetAssignmentNotifier(fn AssignmentNotifier)

+ type TeamCreateTool struct

+ func NewTeamCreateTool(reg *team.Registry, leaderID string) *TeamCreateTool

+ func (t *TeamCreateTool) Description() string

+ func (t *TeamCreateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TeamCreateTool) Label() string

+ func (t *TeamCreateTool) Name() string

+ func (t *TeamCreateTool) Schema() map[string]any

+ type TeamDismissTool struct

+ func NewTeamDismissTool(reg *team.Registry) *TeamDismissTool

+ func (t *TeamDismissTool) Description() string

+ func (t *TeamDismissTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TeamDismissTool) Label() string

+ func (t *TeamDismissTool) Name() string

+ func (t *TeamDismissTool) Schema() map[string]any

+ func (t *TeamDismissTool) SetRosterRemover(fn func(name string))

+ type TeammateWaker interface

+ Wake func(ctx context.Context, name, prompt string) (bool, error)

v0.1.3

May 24, 2026

Changes in this version

+ var ErrPlanExitNotWired = errors.New("exit_plan_mode is not wired")

+ type AllowedPromptArg struct

+ Prompt string

+ Tool string

type AskUserResponse

+ Cancelled bool

type AskUserTool

+ func (t *AskUserTool) PermissionMetadata() permission.Metadata

type EnterPlanModeTool

+ func (t *EnterPlanModeTool) PermissionMetadata() permission.Metadata

+ func (t *EnterPlanModeTool) SetHandler(fn func() (string, error))

type ExitPlanModeTool

+ func (t *ExitPlanModeTool) PermissionMetadata() permission.Metadata

+ func (t *ExitPlanModeTool) SetExiter(fn func() (string, error))

type Question

+ Custom *bool

+ func (q Question) AllowsCustom() bool

+ type SendToSubAgentTool struct

+ func NewSendToSubAgentTool(rt *task.Runtime) *SendToSubAgentTool

+ func (t *SendToSubAgentTool) Description() string

+ func (t *SendToSubAgentTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *SendToSubAgentTool) Label() string

+ func (t *SendToSubAgentTool) Name() string

+ func (t *SendToSubAgentTool) Schema() map[string]any

type TaskGetTool

+ func (t *TaskGetTool) PermissionMetadata() permission.Metadata

type TaskListTool

+ func (t *TaskListTool) PermissionMetadata() permission.Metadata

v0.1.2

Apr 23, 2026

v0.1.1

Apr 17, 2026

Changes in this version

type TaskCreateTool

+ func (t *TaskCreateTool) ConcurrencySafe(_ json.RawMessage) bool

type TaskGetTool

+ func (t *TaskGetTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *TaskGetTool) ReadOnly(_ json.RawMessage) bool

type TaskListTool

+ func (t *TaskListTool) ConcurrencySafe(_ json.RawMessage) bool

+ func (t *TaskListTool) ReadOnly(_ json.RawMessage) bool

type TaskUpdateTool

+ func (t *TaskUpdateTool) ConcurrencySafe(_ json.RawMessage) bool

v0.1.0

Apr 8, 2026

Changes in this version

+ func BuildSkillForkArgs(result *skill.InvocationResult) (json.RawMessage, error)

+ func SetOutputDir(dir string)

+ type EnterPlanModeTool struct

+ func (t *EnterPlanModeTool) Description() string

+ func (t *EnterPlanModeTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *EnterPlanModeTool) Label() string

+ func (t *EnterPlanModeTool) Name() string

+ func (t *EnterPlanModeTool) Schema() map[string]any

+ func (t *EnterPlanModeTool) SetValidator(fn func() error)

+ type ExitPlanModeTool struct

+ func (t *ExitPlanModeTool) Description() string

+ func (t *ExitPlanModeTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *ExitPlanModeTool) Label() string

+ func (t *ExitPlanModeTool) Name() string

+ func (t *ExitPlanModeTool) Schema() map[string]any

+ func (t *ExitPlanModeTool) SetValidator(fn func() error)

+ type InvocationApplier func(result *skill.InvocationResult) error

+ type SkillExecutionResult struct

+ ForkOutput json.RawMessage

+ Forked bool

+ PromptText string

+ func ExecuteSkillInvocation(ctx context.Context, result *skill.InvocationResult, apply InvocationApplier, ...) (*SkillExecutionResult, error)

type SkillTool

+ func (t *SkillTool) SetCatalog(catalog *skill.Catalog)

+ func (t *SkillTool) SetInvocationApplier(fn InvocationApplier)

+ type TaskOutputTool struct

+ func (t *TaskOutputTool) Description() string

+ func (t *TaskOutputTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TaskOutputTool) Label() string

+ func (t *TaskOutputTool) Name() string

+ func (t *TaskOutputTool) Schema() map[string]any

type TaskSnapshot

+ Items []Task

+ type TaskStopTool struct

+ func (t *TaskStopTool) Description() string

+ func (t *TaskStopTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TaskStopTool) Label() string

+ func (t *TaskStopTool) Name() string

+ func (t *TaskStopTool) Schema() map[string]any

type TaskStore

+ func (s *TaskStore) Delete(id string) bool

+ func (s *TaskStore) Reset() error

+ type TaskUpdateOpts struct

+ ActiveForm *string

+ AddBlockedBy []string

+ AddBlocks []string

+ Description *string

+ Metadata map[string]any

+ Owner *string

+ Status *TaskStatus

+ Subject *string

v0.0.4

Mar 25, 2026

Changes in this version

+ func ExpandShellInjections(body string) string

+ func ExpandSkillArgs(body, rawArgs string) string

+ func ExpandSkillVars(body, skillDir, sessionID string) string

+ type AllowToolsSetter func(tools []string)

+ type ForkExecutor func(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ type SkillTool struct

+ func NewSkillTool(skills []config.Skill, sessionID string) *SkillTool

+ func (t *SkillTool) Description() string

+ func (t *SkillTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *SkillTool) Label() string

+ func (t *SkillTool) Name() string

+ func (t *SkillTool) Schema() map[string]any

+ func (t *SkillTool) SetAllowToolsSetter(fn AllowToolsSetter)

+ func (t *SkillTool) SetForkExecutor(fn ForkExecutor)

+ func (t *SkillTool) SetSkills(skills []config.Skill)

v0.0.3

Mar 17, 2026

Changes in this version

type OutputLimitedTool

+ func (t *OutputLimitedTool) Unwrap() agentcore.Tool

v0.0.2

Mar 14, 2026

Changes in this version

+ const DefaultOutputLimit

+ func CleanOldOutputs()

+ func NewCronTools() (*cron.Store, []agentcore.Tool)

+ func NewEnterPlanMode() *enterPlanModeTool

+ func NewExitPlanMode() *exitPlanModeTool

+ func WrapWithOutputLimit(tools []agentcore.Tool) []agentcore.Tool

+ type CronCreateTool struct

+ func (t *CronCreateTool) Description() string

+ func (t *CronCreateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *CronCreateTool) Label() string

+ func (t *CronCreateTool) Name() string

+ func (t *CronCreateTool) Schema() map[string]any

+ func (t *CronCreateTool) Store() *cron.Store

+ type CronDeleteTool struct

+ func (t *CronDeleteTool) Description() string

+ func (t *CronDeleteTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *CronDeleteTool) Label() string

+ func (t *CronDeleteTool) Name() string

+ func (t *CronDeleteTool) Schema() map[string]any

+ type CronListTool struct

+ func (t *CronListTool) Description() string

+ func (t *CronListTool) Execute(_ context.Context, _ json.RawMessage) (json.RawMessage, error)

+ func (t *CronListTool) Label() string

+ func (t *CronListTool) Name() string

+ func (t *CronListTool) Schema() map[string]any

type Option

+ Preview string

+ type OutputLimitedTool struct

+ func (t *OutputLimitedTool) Description() string

+ func (t *OutputLimitedTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *OutputLimitedTool) Label() string

+ func (t *OutputLimitedTool) Name() string

+ func (t *OutputLimitedTool) Schema() map[string]any

v0.0.1

Mar 5, 2026

Changes in this version

+ type AskUserHandler func(ctx context.Context, questions []Question) (*AskUserResponse, error)

+ type AskUserResponse struct

+ Answers map[string]string

+ Notes map[string]string

+ type AskUserTool struct

+ func NewAskUser() *AskUserTool

+ func (t *AskUserTool) Description() string

+ func (t *AskUserTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *AskUserTool) Label() string

+ func (t *AskUserTool) Name() string

+ func (t *AskUserTool) Schema() map[string]any

+ func (t *AskUserTool) SetHandler(h AskUserHandler)

+ type FetchProvider interface

+ Fetch func(ctx context.Context, targetURL string) (string, error)

+ type JinaFetchProvider struct

+ APIKey string

+ BaseURL string

+ Client *http.Client

+ func (p *JinaFetchProvider) Fetch(ctx context.Context, targetURL string) (string, error)

+ type JinaProvider struct

+ APIKey string

+ BaseURL string

+ Client *http.Client

+ func (p *JinaProvider) Search(ctx context.Context, query string, maxResults int) ([]SearchResult, error)

+ type Option struct

+ Description string

+ Label string

+ type Question struct

+ Header string

+ MultiSelect bool

+ Options []Option

+ Question string

+ type SearchProvider interface

+ Search func(ctx context.Context, query string, maxResults int) ([]SearchResult, error)

+ type SearchResult struct

+ Snippet string

+ Title string

+ URL string

+ type Task struct

+ ActiveForm string

+ BlockedBy []string

+ Blocks []string

+ Description string

+ ID string

+ Metadata map[string]any

+ Owner string

+ Status TaskStatus

+ Subject string

+ type TaskCreateTool struct

+ func (t *TaskCreateTool) Description() string

+ func (t *TaskCreateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TaskCreateTool) Label() string

+ func (t *TaskCreateTool) Name() string

+ func (t *TaskCreateTool) Schema() map[string]any

+ func (t *TaskCreateTool) SetNotifyFn(fn TaskNotifyFn)

+ func (t *TaskCreateTool) Store() *TaskStore

+ type TaskGetTool struct

+ func (t *TaskGetTool) Description() string

+ func (t *TaskGetTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TaskGetTool) Label() string

+ func (t *TaskGetTool) Name() string

+ func (t *TaskGetTool) Schema() map[string]any

+ type TaskListTool struct

+ func (t *TaskListTool) Description() string

+ func (t *TaskListTool) Execute(_ context.Context, _ json.RawMessage) (json.RawMessage, error)

+ func (t *TaskListTool) Label() string

+ func (t *TaskListTool) Name() string

+ func (t *TaskListTool) Schema() map[string]any

+ type TaskNotifyFn func(TaskSnapshot)

+ type TaskSnapshot struct

+ Completed int

+ InProgress int

+ Pending int

+ Tasks []Task

+ Total int

+ type TaskStatus string

+ const TaskCompleted

+ const TaskInProgress

+ const TaskPending

+ type TaskStore struct

+ func NewTaskStore() *TaskStore

+ func NewTaskTools() (*TaskStore, []agentcore.Tool)

+ func (s *TaskStore) Create(subject, description, activeForm string, metadata map[string]any) *Task

+ func (s *TaskStore) Get(id string) (*Task, bool)

+ func (s *TaskStore) List() []Task

+ func (s *TaskStore) SetDir(dir string) error

+ func (s *TaskStore) SetNotifyFn(fn TaskNotifyFn)

+ func (s *TaskStore) Snapshot() TaskSnapshot

+ func (s *TaskStore) Update(id string, opts UpdateOpts) (*Task, error)

+ type TaskUpdateTool struct

+ func (t *TaskUpdateTool) Description() string

+ func (t *TaskUpdateTool) Execute(_ context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *TaskUpdateTool) Label() string

+ func (t *TaskUpdateTool) Name() string

+ func (t *TaskUpdateTool) Schema() map[string]any

+ type TavilyFetchProvider struct

+ APIKey string

+ Client *http.Client

+ func (p *TavilyFetchProvider) Fetch(ctx context.Context, targetURL string) (string, error)

+ type TavilyProvider struct

+ APIKey string

+ Client *http.Client

+ func (p *TavilyProvider) Search(ctx context.Context, query string, maxResults int) ([]SearchResult, error)

+ type UpdateOpts struct

+ ActiveForm *string

+ AddBlockedBy []string

+ AddBlocks []string

+ Description *string

+ Metadata map[string]any

+ Owner *string

+ Status *TaskStatus

+ Subject *string

+ type WebFetchTool struct

+ func NewWebFetch(providerName, apiKey string) *WebFetchTool

+ func (t *WebFetchTool) Description() string

+ func (t *WebFetchTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *WebFetchTool) Label() string

+ func (t *WebFetchTool) Name() string

+ func (t *WebFetchTool) Schema() map[string]any

+ type WebSearchTool struct

+ func NewWebSearch(providerName, apiKey string) *WebSearchTool

+ func (t *WebSearchTool) Description() string

+ func (t *WebSearchTool) Execute(ctx context.Context, args json.RawMessage) (json.RawMessage, error)

+ func (t *WebSearchTool) Label() string

+ func (t *WebSearchTool) Name() string

+ func (t *WebSearchTool) Schema() map[string]any

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