search

Documentation

Index

• func DefaultTools() []agentsdk.Tool
• type GlobTool
  • func (t *GlobTool) Description() string
  • func (t *GlobTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)
  • func (t *GlobTool) InputSchema() json.RawMessage
  • func (t *GlobTool) IsEnabled(_ *agentsdk.RunContext) bool
  • func (t *GlobTool) IsReadOnly() bool
  • func (t *GlobTool) Name() string
  • func (t *GlobTool) NeedsApproval() bool
  • func (t *GlobTool) TimeoutSeconds() int
• type GrepTool
  • func (t *GrepTool) Description() string
  • func (t *GrepTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)
  • func (t *GrepTool) InputSchema() json.RawMessage
  • func (t *GrepTool) IsEnabled(_ *agentsdk.RunContext) bool
  • func (t *GrepTool) IsReadOnly() bool
  • func (t *GrepTool) Name() string
  • func (t *GrepTool) NeedsApproval() bool
  • func (t *GrepTool) TimeoutSeconds() int
• type ListFilesTool
  • func (t *ListFilesTool) Description() string
  • func (t *ListFilesTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)
  • func (t *ListFilesTool) InputSchema() json.RawMessage
  • func (t *ListFilesTool) IsEnabled(_ *agentsdk.RunContext) bool
  • func (t *ListFilesTool) IsReadOnly() bool
  • func (t *ListFilesTool) Name() string
  • func (t *ListFilesTool) NeedsApproval() bool
  • func (t *ListFilesTool) TimeoutSeconds() int
• type ReadFileTool
  • func (t *ReadFileTool) Description() string
  • func (t *ReadFileTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)
  • func (t *ReadFileTool) InputSchema() json.RawMessage
  • func (t *ReadFileTool) IsEnabled(_ *agentsdk.RunContext) bool
  • func (t *ReadFileTool) IsReadOnly() bool
  • func (t *ReadFileTool) Name() string
  • func (t *ReadFileTool) NeedsApproval() bool
  • func (t *ReadFileTool) TimeoutSeconds() int

Functions

func DefaultTools

func DefaultTools() []agentsdk.Tool

DefaultTools returns the SDK's generic read-only workspace discovery tools.

Types

type GlobTool

type GlobTool struct{}

GlobTool finds files whose relative path matches a glob pattern.

func (*GlobTool) Description

func (t *GlobTool) Description() string

func (*GlobTool) Execute

func (t *GlobTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)

func (*GlobTool) InputSchema

func (t *GlobTool) InputSchema() json.RawMessage

func (*GlobTool) IsEnabled

func (t *GlobTool) IsEnabled(_ *agentsdk.RunContext) bool

func (*GlobTool) IsReadOnly

func (t *GlobTool) IsReadOnly() bool

func (*GlobTool) Name

func (t *GlobTool) Name() string

func (*GlobTool) NeedsApproval

func (t *GlobTool) NeedsApproval() bool

func (*GlobTool) TimeoutSeconds

func (t *GlobTool) TimeoutSeconds() int

type GrepTool

type GrepTool struct{}

GrepTool searches file contents with a regular expression.

func (*GrepTool) Description

func (t *GrepTool) Description() string

func (*GrepTool) Execute

func (t *GrepTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)

func (*GrepTool) InputSchema

func (t *GrepTool) InputSchema() json.RawMessage

func (*GrepTool) IsEnabled

func (t *GrepTool) IsEnabled(_ *agentsdk.RunContext) bool

func (*GrepTool) IsReadOnly

func (t *GrepTool) IsReadOnly() bool

func (*GrepTool) Name

func (t *GrepTool) Name() string

func (*GrepTool) NeedsApproval

func (t *GrepTool) NeedsApproval() bool

func (*GrepTool) TimeoutSeconds

func (t *GrepTool) TimeoutSeconds() int

type ListFilesTool

type ListFilesTool struct{}

ListFilesTool lists files and directories under a workspace-relative path.

func (*ListFilesTool) Description

func (t *ListFilesTool) Description() string

func (*ListFilesTool) Execute

func (t *ListFilesTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)

func (*ListFilesTool) InputSchema

func (t *ListFilesTool) InputSchema() json.RawMessage

func (*ListFilesTool) IsEnabled

func (t *ListFilesTool) IsEnabled(_ *agentsdk.RunContext) bool

func (*ListFilesTool) IsReadOnly

func (t *ListFilesTool) IsReadOnly() bool

func (*ListFilesTool) Name

func (t *ListFilesTool) Name() string

func (*ListFilesTool) NeedsApproval

func (t *ListFilesTool) NeedsApproval() bool

func (*ListFilesTool) TimeoutSeconds

func (t *ListFilesTool) TimeoutSeconds() int

type ReadFileTool

type ReadFileTool struct{}

ReadFileTool reads a UTF-8 text file under the workspace.

func (*ReadFileTool) Description

func (t *ReadFileTool) Description() string

func (*ReadFileTool) Execute

func (t *ReadFileTool) Execute(_ context.Context, input json.RawMessage, workDir string) (agentsdk.ToolResult, error)

func (*ReadFileTool) InputSchema

func (t *ReadFileTool) InputSchema() json.RawMessage

func (*ReadFileTool) IsEnabled

func (t *ReadFileTool) IsEnabled(_ *agentsdk.RunContext) bool

func (*ReadFileTool) IsReadOnly

func (t *ReadFileTool) IsReadOnly() bool

func (*ReadFileTool) Name

func (t *ReadFileTool) Name() string

func (*ReadFileTool) NeedsApproval

func (t *ReadFileTool) NeedsApproval() bool

func (*ReadFileTool) TimeoutSeconds

func (t *ReadFileTool) TimeoutSeconds() int