tools

Documentation

Index

• func ToOutputSchemaSchema(valueType reflect.Type) (*jsonschema.Schema, error)
• func ToOutputSchemaSchemaMust(valueType reflect.Type) *jsonschema.Schema
• type ElicitationHandler
• type ElicitationResult
• type FunctionCall
• type FunctionParameters
  • func (fp FunctionParameters) MarshalJSON() ([]byte, error)
• type Tool
  • func (t *Tool) DisplayName() string
• type ToolAnnotations
• type ToolCall
• type ToolCallResult
• type ToolHandler
• type ToolSet
• type ToolType

Functions

func ToOutputSchemaSchema

func ToOutputSchemaSchema(valueType reflect.Type) (*jsonschema.Schema, error)

func ToOutputSchemaSchemaMust

func ToOutputSchemaSchemaMust(valueType reflect.Type) *jsonschema.Schema

Types

type ElicitationHandler

type ElicitationHandler func(ctx context.Context, req *mcp.ElicitParams) (ElicitationResult, error)

ElicitationHandler is a function type that handles elicitation requests from the MCP server This allows the runtime to handle elicitation requests and propagate them to its own client

type ElicitationResult

type ElicitationResult struct {
	Action  string         `json:"action"` // "accept", "decline", or "cancel"
	Content map[string]any `json:"content,omitempty"`
}

type FunctionCall

type FunctionCall struct {
	Name      string `json:"name,omitempty"`
	Arguments string `json:"arguments,omitempty"`
}

type FunctionParameters

type FunctionParameters struct {
	Type       string         `json:"type"`
	Properties map[string]any `json:"properties"`
	Required   []string       `json:"required,omitempty"`
}

func (FunctionParameters) MarshalJSON

func (fp FunctionParameters) MarshalJSON() ([]byte, error)

type Tool

type Tool struct {
	Name         string             `json:"name"`
	Description  string             `json:"description,omitempty"`
	Parameters   FunctionParameters `json:"parameters"`
	Annotations  ToolAnnotations    `json:"annotations"`
	OutputSchema any                `json:"outputSchema"`
	Handler      ToolHandler        `json:"-"`
}

func (*Tool) DisplayName

func (t *Tool) DisplayName() string

type ToolAnnotations

type ToolAnnotations mcp.ToolAnnotations

type ToolCall

type ToolCall struct {
	ID       string       `json:"id,omitempty"`
	Type     ToolType     `json:"type"`
	Function FunctionCall `json:"function"`
}

type ToolCallResult

type ToolCallResult struct {
	Output string `json:"output"`
}

type ToolHandler

type ToolHandler = func(ctx context.Context, toolCall ToolCall) (*ToolCallResult, error)

type ToolSet

type ToolSet interface {
	Tools(ctx context.Context) ([]Tool, error)
	Instructions() string
	Start(ctx context.Context) error
	Stop() error
	SetElicitationHandler(handler ElicitationHandler)
	SetOAuthSuccessHandler(handler func())
}

type ToolType

type ToolType string