Documentation
¶
Index ¶
- type Config
- type Tool
- func (t Tool) Authorized(verifiedAuthServices []string) bool
- func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, ...) (parameters.ParamValues, error)
- func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
- func (t Tool) GetParameters() parameters.Parameters
- func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, ...) (any, util.ToolboxError)
- func (t Tool) Manifest() tools.Manifest
- func (t Tool) McpManifest() tools.McpManifest
- func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
- func (t Tool) ToConfig() tools.ToolConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Name string `yaml:"name" validate:"required"`
Type string `yaml:"type" validate:"required"`
Source string `yaml:"source" validate:"required"`
Description string `yaml:"description"`
AuthRequired []string `yaml:"authRequired"`
}
Config defines the configuration for the list-instance tool.
func (Config) Initialize ¶
Initialize initializes the tool from the configuration.
func (Config) ToolConfigType ¶ added in v0.27.0
ToolConfigType returns the type of the tool.
type Tool ¶
type Tool struct {
Config
AllParams parameters.Parameters `yaml:"allParams"`
// contains filtered or unexported fields
}
Tool represents the list-instance tool.
func (Tool) Authorized ¶
Authorized checks if the tool is authorized.
func (Tool) EmbedParams ¶ added in v0.25.0
func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, embeddingModelsMap map[string]embeddingmodels.EmbeddingModel) (parameters.ParamValues, error)
func (Tool) GetAuthTokenHeaderName ¶ added in v0.22.0
func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
func (Tool) GetParameters ¶ added in v0.27.0
func (t Tool) GetParameters() parameters.Parameters
func (Tool) Invoke ¶
func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError)
Invoke executes the tool's logic.
func (Tool) McpManifest ¶
func (t Tool) McpManifest() tools.McpManifest
McpManifest returns the tool's MCP manifest.
func (Tool) RequiresClientAuthorization ¶
func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
func (Tool) ToConfig ¶ added in v0.20.0
func (t Tool) ToConfig() tools.ToolConfig
Source Files
Click to show internal directories.
Click to hide internal directories.