MCP Toolbox for Databases

// Copyright 2025 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bigtable import ( "context" "fmt" "cloud.google.com/go/bigtable" yaml "github.com/goccy/go-yaml" "github.com/googleapis/genai-toolbox/internal/sources" "github.com/googleapis/genai-toolbox/internal/tools" "github.com/googleapis/genai-toolbox/internal/util/parameters" ) const kind string = "bigtable-sql" func init() { if !tools.Register(kind, newConfig) { panic(fmt.Sprintf("tool kind %q already registered", kind)) } } func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (tools.ToolConfig, error) { actual := Config{Name: name} if err := decoder.DecodeContext(ctx, &actual); err != nil { return nil, err } return actual, nil } type compatibleSource interface { BigtableClient() *bigtable.Client } 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 parameters.Parameters `yaml:"parameters"` TemplateParameters parameters.Parameters `yaml:"templateParameters"` } // validate interface var _ tools.ToolConfig = Config{} func (cfg Config) ToolConfigKind() string { return kind } func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error) { allParameters, paramManifest, err := parameters.ProcessParameters(cfg.TemplateParameters, cfg.Parameters) if err != nil { return nil, err } mcpManifest := tools.GetMcpManifest(cfg.Name, cfg.Description, cfg.AuthRequired, allParameters, nil) // finish tool setup t := Tool{ Config: cfg, AllParams: allParameters, manifest: tools.Manifest{Description: cfg.Description, Parameters: paramManifest, AuthRequired: cfg.AuthRequired}, mcpManifest: mcpManifest, } return t, nil } // validate interface var _ tools.Tool = Tool{} type Tool struct { Config AllParams parameters.Parameters `yaml:"allParams"` manifest tools.Manifest mcpManifest tools.McpManifest } func (t Tool) ToConfig() tools.ToolConfig { return t.Config } func getBigtableType(paramType string) (bigtable.SQLType, error) { switch paramType { case "boolean": return bigtable.BoolSQLType{}, nil case "string": return bigtable.StringSQLType{}, nil case "integer": return bigtable.Int64SQLType{}, nil case "float": return bigtable.Float64SQLType{}, nil case "array": return bigtable.ArraySQLType{}, nil default: return nil, fmt.Errorf("unknow param type %s", paramType) } } func getMapParamsType(tparams parameters.Parameters, params parameters.ParamValues) (map[string]bigtable.SQLType, error) { btParamTypes := make(map[string]bigtable.SQLType) for _, p := range tparams { if p.GetType() == "array" { itemType, err := getBigtableType(p.Manifest().Items.Type) if err != nil { return nil, err } btParamTypes[p.GetName()] = bigtable.ArraySQLType{ ElemType: itemType, } continue } paramType, err := getBigtableType(p.GetType()) if err != nil { return nil, err } btParamTypes[p.GetName()] = paramType } return btParamTypes, nil } func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, error) { source, err := tools.GetCompatibleSource[compatibleSource](resourceMgr, t.Source, t.Name, t.Kind) if err != nil { return nil, err } paramsMap := params.AsMap() newStatement, err := parameters.ResolveTemplateParams(t.TemplateParameters, t.Statement, paramsMap) if err != nil { return nil, fmt.Errorf("unable to extract template params %w", err) } newParams, err := parameters.GetParams(t.Parameters, paramsMap) if err != nil { return nil, fmt.Errorf("unable to extract standard params %w", err) } mapParamsType, err := getMapParamsType(t.Parameters, newParams) if err != nil { return nil, fmt.Errorf("fail to get map params: %w", err) } ps, err := source.BigtableClient().PrepareStatement( ctx, newStatement, mapParamsType, ) if err != nil { return nil, fmt.Errorf("unable to prepare statement: %w", err) } bs, err := ps.Bind(newParams.AsMap()) if err != nil { return nil, fmt.Errorf("unable to bind: %w", err) } var out []any err = bs.Execute(ctx, func(resultRow bigtable.ResultRow) bool { vMap := make(map[string]any) cols := resultRow.Metadata.Columns for _, c := range cols { var columValue any err = resultRow.GetByName(c.Name, &columValue) vMap[c.Name] = columValue } out = append(out, vMap) return true }) if err != nil { return nil, fmt.Errorf("unable to execute client: %w", err) } return out, nil } func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error) { return parameters.ParseParams(t.AllParams, data, claims) } func (t Tool) Manifest() tools.Manifest { return t.manifest } func (t Tool) McpManifest() tools.McpManifest { return t.mcpManifest } func (t Tool) Authorized(verifiedAuthServices []string) bool { return tools.IsAuthorized(t.AuthRequired, verifiedAuthServices) } func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error) { return false, nil } func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error) { return "Authorization", nil }