imagetool

Documentation

Index

• type ImageTool
  • func NewImageTool(opts ...ImageToolOption) (*ImageTool, error)
  • func (it *ImageTool) ReadImage(ctx context.Context, args ReadImageArgs) (*ReadImageOut, error)
  • func (it *ImageTool) ReadImageTool() spec.Tool
• type ImageToolOption
  • func WithAllowedRoots(roots []string) ImageToolOption
  • func WithBlockSymlinks(block bool) ImageToolOption
  • func WithWorkBaseDir(base string) ImageToolOption
• type ReadImageArgs
• type ReadImageOut

Types

type ImageTool

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

ImageTool is an instance-owned image tool runner. It centralizes path resolution and sandbox policy:

• workBaseDir: base for resolving relative paths
• allowedRoots: optional restriction; if empty/nil, allow all
• blockSymlinks: blocks symlink traversal (if enforced downstream).

func NewImageTool

func NewImageTool(opts ...ImageToolOption) (*ImageTool, error)

func (*ImageTool) ReadImage

func (it *ImageTool) ReadImage(ctx context.Context, args ReadImageArgs) (*ReadImageOut, error)

func (*ImageTool) ReadImageTool

func (it *ImageTool) ReadImageTool() spec.Tool

type ImageToolOption

type ImageToolOption func(*ImageTool) error

func WithAllowedRoots

func WithAllowedRoots(roots []string) ImageToolOption

func WithBlockSymlinks

func WithBlockSymlinks(block bool) ImageToolOption

WithBlockSymlinks configures whether symlink traversal should be blocked (if supported downstream).

func WithWorkBaseDir

func WithWorkBaseDir(base string) ImageToolOption

type ReadImageArgs

type ReadImageArgs struct {
	Path              string `json:"path"`
	IncludeBase64Data bool   `json:"includeBase64Data"`
}

type ReadImageOut

type ReadImageOut struct {
	Path      string     `json:"path"`
	Name      string     `json:"name"`
	Exists    bool       `json:"exists"`
	SizeBytes int64      `json:"sizeBytes,omitempty"`
	ModTime   *time.Time `json:"modTime,omitempty"`

	Width    int    `json:"width,omitempty"`
	Height   int    `json:"height,omitempty"`
	Format   string `json:"format,omitempty"`   // "png", "jpeg", ...
	MIMEType string `json:"mimeType,omitempty"` // "image/png", ...

	// Optional content.
	Base64Data string `json:"base64Data,omitempty"`
}