tools

Documentation

Index

• func NewDefinition(name, title, description string, annotations publictypes.Annotations) publictypes.ToolDefinition
• type ConvertibleAnnotation
• type ConvertibleTool
• type ReadOnlyAnnotation
  • func NewReadOnlyAnnotations() ReadOnlyAnnotation
  • func (a ReadOnlyAnnotation) ToToolAnnotations() *mcp.ToolAnnotations
• type StructuredHandler
• type ToolCallRequestFactory
• type ToolWithStructuredContentOutput
  • func NewStructured[ToolInput, ToolOutput any](definition publictypes.ToolDefinition, ...) *ToolWithStructuredContentOutput[ToolInput, ToolOutput]
  • func (t *ToolWithStructuredContentOutput[ToolInput, ToolOutput]) ToInternal(toolCallRequestFactory ToolCallRequestFactory, ...) internaltools.Tool
• type ToolWithUnstructuredContentOutput
  • func NewUnstructured[ToolInput any](definition publictypes.ToolDefinition, handler UnstructuredHandler[ToolInput]) *ToolWithUnstructuredContentOutput[ToolInput]
  • func (t *ToolWithUnstructuredContentOutput[ToolInput]) ToInternal(toolCallRequestFactory ToolCallRequestFactory, ...) internaltools.Tool
• type UnstructuredHandler

Functions

func NewDefinition

func NewDefinition(name, title, description string, annotations publictypes.Annotations) publictypes.ToolDefinition

Types

type ConvertibleAnnotation

type ConvertibleAnnotation interface {
	publictypes.Annotations
	ToToolAnnotations() *mcp.ToolAnnotations
}

type ConvertibleTool

type ConvertibleTool interface {
	publictypes.Tool
	ToInternal(
		toolCallRequestFactory ToolCallRequestFactory,
		loggerFactory basetool.LoggerFactory,
		config internalconfig.GenericConfig,
		messageCatalog definition.MessageCatalog,
	) internaltools.Tool
}

type ReadOnlyAnnotation

type ReadOnlyAnnotation struct {
	publictypes.AnnotationSeal
}

func NewReadOnlyAnnotations

func NewReadOnlyAnnotations() ReadOnlyAnnotation

func (ReadOnlyAnnotation) ToToolAnnotations

func (a ReadOnlyAnnotation) ToToolAnnotations() *mcp.ToolAnnotations

type StructuredHandler

type StructuredHandler[ToolInput, ToolOutput any] func(ctx context.Context, request publictypes.ToolCallRequest, inputs ToolInput) (ToolOutput, publictypes.Error)

type ToolCallRequestFactory

type ToolCallRequestFactory interface {
	New(
		internalLogger entities.Logger,
		internalConfig internalconfig.GenericConfig,
		internalMessageCatalog definition.MessageCatalog,
	) publictypes.ToolCallRequest
}

type ToolWithStructuredContentOutput

type ToolWithStructuredContentOutput[ToolInput, ToolOutput any] struct {
	publictypes.ToolSeal
	// contains filtered or unexported fields
}

func NewStructured

func NewStructured[ToolInput, ToolOutput any](definition publictypes.ToolDefinition, handler StructuredHandler[ToolInput, ToolOutput]) *ToolWithStructuredContentOutput[ToolInput, ToolOutput]

func (*ToolWithStructuredContentOutput[ToolInput, ToolOutput]) ToInternal

func (t *ToolWithStructuredContentOutput[ToolInput, ToolOutput]) ToInternal(
	toolCallRequestFactory ToolCallRequestFactory,
	loggerFactoryInstance basetool.LoggerFactory,
	config internalconfig.GenericConfig,
	messageCatalog definition.MessageCatalog,
) internaltools.Tool

type ToolWithUnstructuredContentOutput

type ToolWithUnstructuredContentOutput[ToolInput any] struct {
	publictypes.ToolSeal
	// contains filtered or unexported fields
}

func NewUnstructured

func NewUnstructured[ToolInput any](definition publictypes.ToolDefinition, handler UnstructuredHandler[ToolInput]) *ToolWithUnstructuredContentOutput[ToolInput]

func (*ToolWithUnstructuredContentOutput[ToolInput]) ToInternal

func (t *ToolWithUnstructuredContentOutput[ToolInput]) ToInternal(
	toolCallRequestFactory ToolCallRequestFactory,
	loggerFactoryInstance basetool.LoggerFactory,
	config internalconfig.GenericConfig,
	messageCatalog definition.MessageCatalog,
) internaltools.Tool

type UnstructuredHandler

type UnstructuredHandler[ToolInput any] func(ctx context.Context, request publictypes.ToolCallRequest, inputs ToolInput) (publictypes.RichContent, publictypes.Error)