write

Documentation

Index

• func Register(registry *tool.Registry, opts ...Option) error
• type Option
  • func WithAllowedDirs(dirs ...string) Option
  • func WithMaxWriteBytes(n int) Option
  • func WithPathGuard(g *toolkit.PathGuard) Option
• type WriteTool
  • func New(opts ...Option) *WriteTool
  • func (wt *WriteTool) Handler() tool.ToolHandler
  • func (wt *WriteTool) ToolDef() schema.ToolDef

Functions

func Register

func Register(registry *tool.Registry, opts ...Option) error

Register creates a WriteTool and registers it in the given registry.

Types

type Option

type Option func(*WriteTool)

Option is a functional option for configuring a WriteTool.

func WithAllowedDirs

func WithAllowedDirs(dirs ...string) Option

WithAllowedDirs sets the allowed base directories for the write tool. Uses ValidatePath semantics; for TOCTOU-safe enforcement prefer WithPathGuard.

func WithMaxWriteBytes

func WithMaxWriteBytes(n int) Option

WithMaxWriteBytes sets the maximum number of bytes that can be written.

func WithPathGuard

func WithPathGuard(g *toolkit.PathGuard) Option

WithPathGuard installs a PathGuard which bounds writes to its roots.

type WriteTool

type WriteTool struct {
	// contains filtered or unexported fields
}

WriteTool holds configuration for the built-in file write tool.

func New

func New(opts ...Option) *WriteTool

New creates a WriteTool with the given options.

func (*WriteTool) Handler

func (wt *WriteTool) Handler() tool.ToolHandler

Handler returns the ToolHandler closure for this write tool.

func (*WriteTool) ToolDef

func (wt *WriteTool) ToolDef() schema.ToolDef

ToolDef returns the schema.ToolDef for registration.