tools

Documentation

Overview

Package tool defines built-in coding-agent tools as a publishable library.

Layout:

catalog/   — tool names, categories, and the built-in catalog
exposure/  — name resolution and runtime executability
schema/    — provider API JSON schemas and exposure filter
websearch/ — reusable multi-engine web search
todolist/  — TodoList tool state and argument handling

Tool execution and approval UI live in internal/ (coding-agent).

Index

• Constants
• func FilterProviderTools(tools []protocol.ToolDefinition) []protocol.ToolDefinition
• func IsExecutable(name string) bool
• func IsProviderExposed(name string) bool
• func Names() []string
• func ProviderDefinitions() []protocol.ToolDefinition
• func RequiresApproval(name string) bool
• func ResolveName(raw string) (canonical string, known bool)
• type Approval
• type Category
• type Definition
  • func All() []Definition
  • func ByCategory(category Category) []Definition
  • func Get(name string) (Definition, bool)

Constants

const (
	CategoryFile            = catalog.CategoryFile
	CategoryShell           = catalog.CategoryShell
	CategoryWeb             = catalog.CategoryWeb
	CategoryPlanMode        = catalog.CategoryPlanMode
	CategoryStateManagement = catalog.CategoryStateManagement
	CategoryCollaboration   = catalog.CategoryCollaboration
	CategoryGoal            = catalog.CategoryGoal

	ApprovalAutoAllow        = catalog.ApprovalAutoAllow
	ApprovalRequiresApproval = catalog.ApprovalRequiresApproval
	ApprovalAlwaysApprove    = catalog.ApprovalAlwaysApprove

	Read          = catalog.Read
	Write         = catalog.Write
	Edit          = catalog.Edit
	Grep          = catalog.Grep
	Glob          = catalog.Glob
	ReadMediaFile = catalog.ReadMediaFile
	Bash          = catalog.Bash
	FetchURL      = catalog.FetchURL
	WebSearch     = catalog.WebSearch
	CodeSearch    = catalog.CodeSearch
	EnterPlanMode = catalog.EnterPlanMode
	ExitPlanMode  = catalog.ExitPlanMode
	AskUser       = catalog.AskUser
	Skill         = catalog.Skill
	TodoList      = catalog.TodoList
	CreateGoal    = catalog.CreateGoal
	GetGoal       = catalog.GetGoal
	UpdateGoal    = catalog.UpdateGoal
	SetGoalBudget = catalog.SetGoalBudget
)

Functions

func FilterProviderTools

func FilterProviderTools(tools []protocol.ToolDefinition) []protocol.ToolDefinition

func IsExecutable

func IsExecutable(name string) bool

func IsProviderExposed

func IsProviderExposed(name string) bool

func Names

func Names() []string

func ProviderDefinitions

func ProviderDefinitions() []protocol.ToolDefinition

func RequiresApproval

func RequiresApproval(name string) bool

func ResolveName

func ResolveName(raw string) (canonical string, known bool)

Types

type Approval

type Approval = catalog.Approval

type Category

type Category = catalog.Category

type Definition

type Definition = catalog.Definition

func All

func All() []Definition

func ByCategory

func ByCategory(category Category) []Definition

func Get

func Get(name string) (Definition, bool)