tools

Documentation

Index

• func IsToolEnabled(toolName string) bool
• type ExtendedHelp
• type ExtendedHelpProvider
• type Tool
• type ToolExample
• type TroubleshootingTip

Functions

func IsToolEnabled

func IsToolEnabled(toolName string) bool

Types

type ExtendedHelp

type ExtendedHelp struct {
	Examples         []ToolExample        `json:"examples,omitempty"`
	CommonPatterns   []string             `json:"common_patterns,omitempty"`
	Troubleshooting  []TroubleshootingTip `json:"troubleshooting,omitempty"`
	ParameterDetails map[string]string    `json:"parameter_details,omitempty"`
	WhenToUse        string               `json:"when_to_use,omitempty"`
	WhenNotToUse     string               `json:"when_not_to_use,omitempty"`
}

ExtendedHelp contains detailed information about a tool's usage

type ExtendedHelpProvider

type ExtendedHelpProvider interface {
	ProvideExtendedInfo() *ExtendedHelp
}

ExtendedHelpProvider is an optional interface that tools can implement to provide detailed usage information, examples, and troubleshooting help

type Tool

type Tool interface {
	// Definition returns the tool's definition for MCP registration
	Definition() mcp.Tool

	// Execute executes the tool's logic using shared resources (logger, cache) and parsed arguments
	Execute(ctx context.Context, logger *logrus.Logger, cache *sync.Map, args map[string]any) (*mcp.CallToolResult, error)
}

Tool is the interface that all MCP tool implementations must satisfy

type ToolExample

type ToolExample struct {
	Description    string         `json:"description"`
	Arguments      map[string]any `json:"arguments"`
	ExpectedResult string         `json:"expected_result,omitempty"`
}

ToolExample represents a usage example for a tool

type TroubleshootingTip

type TroubleshootingTip struct {
	Problem  string `json:"problem"`
	Solution string `json:"solution"`
}

TroubleshootingTip represents a troubleshooting tip for a tool