oceanbasesql

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

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"`
	Kind               string           `yaml:"kind" validate:"required"`
	Source             string           `yaml:"source" validate:"required"`
	Description        string           `yaml:"description" validate:"required"`
	Statement          string           `yaml:"statement" validate:"required"`
	AuthRequired       []string         `yaml:"authRequired"`
	Parameters         tools.Parameters `yaml:"parameters"`
	TemplateParameters tools.Parameters `yaml:"templateParameters"`
}

func (Config) Initialize

func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error)

func (Config) ToolConfigKind

func (cfg Config) ToolConfigKind() string

type Tool

type Tool struct {
	Name               string           `yaml:"name"`
	Kind               string           `yaml:"kind"`
	AuthRequired       []string         `yaml:"authRequired"`
	Parameters         tools.Parameters `yaml:"parameters"`
	TemplateParameters tools.Parameters `yaml:"templateParameters"`
	AllParams          tools.Parameters `yaml:"allParams"`

	Pool      *sql.DB
	Statement string
	// contains filtered or unexported fields
}

func (Tool) Authorized

func (t Tool) Authorized(verifiedAuthServices []string) bool

Authorized checks if the tool is authorized for the given auth services.

func (Tool) Invoke

func (t Tool) Invoke(ctx context.Context, params tools.ParamValues, accessToken tools.AccessToken) (any, error)

Invoke executes the SQL statement with the provided parameters.

func (Tool) Manifest

func (t Tool) Manifest() tools.Manifest

Manifest returns the tool manifest.

func (Tool) McpManifest

func (t Tool) McpManifest() tools.McpManifest

McpManifest returns the MCP manifest for the tool.

func (Tool) ParseParams

func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (tools.ParamValues, error)

ParseParams parses the input parameters for the tool.

func (Tool) RequiresClientAuthorization

func (t Tool) RequiresClientAuthorization() bool

Jump to

Keyboard shortcuts

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