toolhelp

package
v0.44.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExtendedHelpData

type ExtendedHelpData struct {
	Examples         []ToolExampleData     `json:"examples,omitempty"`
	CommonPatterns   []string              `json:"common_patterns,omitempty"`
	Troubleshooting  []TroubleshootingData `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"`
}

ExtendedHelpData represents the extended information about a tool

type ToolExampleData

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

ToolExampleData represents a usage example for a tool

type ToolHelpRequest

type ToolHelpRequest struct {
	ToolName string `json:"tool_name"`
}

ToolHelpRequest represents the input parameters for the get_tool_help tool

type ToolHelpResponse

type ToolHelpResponse struct {
	ToolName        string            `json:"tool_name"`
	BasicInfo       map[string]any    `json:"basic_info"`
	ExtendedInfo    *ExtendedHelpData `json:"extended_info,omitempty"`
	HasExtendedInfo bool              `json:"has_extended_info"`
	Message         string            `json:"message,omitempty"`
}

ToolHelpResponse represents the output of the get_tool_help tool

type ToolHelpTool

type ToolHelpTool struct{}

ToolHelpTool implements a tool that provides extended information about MCP DevTools server tools

func (*ToolHelpTool) Definition

func (t *ToolHelpTool) Definition() mcp.Tool

Definition returns the tool's definition for MCP registration

func (*ToolHelpTool) Execute

func (t *ToolHelpTool) Execute(ctx context.Context, logger *logrus.Logger, cache *sync.Map, args map[string]any) (*mcp.CallToolResult, error)

Execute executes the get_tool_help tool

type TroubleshootingData

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

TroubleshootingData represents a troubleshooting tip for a tool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL