// Copyright 2024 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 spanner import ( "context" "fmt" "strings" "cloud.google.com/go/spanner" "github.com/googleapis/genai-toolbox/internal/sources" spannerdb "github.com/googleapis/genai-toolbox/internal/sources/spanner" "github.com/googleapis/genai-toolbox/internal/tools" "google.golang.org/api/iterator" ) const ToolKind string = "spanner-sql" type compatibleSource interface { SpannerClient() *spanner.Client DatabaseDialect() string } // validate compatible sources are still compatible var _ compatibleSource = &spannerdb.Source{} var compatibleSources = [...]string{spannerdb.SourceKind} 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"` } // validate interface var _ tools.ToolConfig = Config{} func (cfg Config) ToolConfigKind() string { return ToolKind } func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error) { // verify source exists rawS, ok := srcs[cfg.Source] if !ok { return nil, fmt.Errorf("no source named %q configured", cfg.Source) } // verify the source is compatible s, ok := rawS.(compatibleSource) if !ok { return nil, fmt.Errorf("invalid source for %q tool: source kind must be one of %q", ToolKind, compatibleSources) } mcpManifest := tools.McpManifest{ Name: cfg.Name, Description: cfg.Description, InputSchema: cfg.Parameters.McpManifest(), } // finish tool setup t := Tool{ Name: cfg.Name, Kind: ToolKind, Parameters: cfg.Parameters, Statement: cfg.Statement, AuthRequired: cfg.AuthRequired, Client: s.SpannerClient(), dialect: s.DatabaseDialect(), manifest: tools.Manifest{Description: cfg.Description, Parameters: cfg.Parameters.Manifest()}, mcpManifest: mcpManifest, } return t, nil } // validate interface var _ tools.Tool = Tool{} type Tool struct { Name string `yaml:"name"` Kind string `yaml:"kind"` AuthRequired []string `yaml:"authRequired"` Parameters tools.Parameters `yaml:"parameters"` Client *spanner.Client dialect string Statement string manifest tools.Manifest mcpManifest tools.McpManifest } func getMapParams(params tools.ParamValues, dialect string) (map[string]interface{}, error) { switch strings.ToLower(dialect) { case "googlesql": return params.AsMap(), nil case "postgresql": return params.AsMapByOrderedKeys(), nil default: return nil, fmt.Errorf("invalid dialect %s", dialect) } } func (t Tool) Invoke(params tools.ParamValues) ([]any, error) { mapParams, err := getMapParams(params, t.dialect) if err != nil { return nil, fmt.Errorf("fail to get map params: %w", err) } var out []any _, err = t.Client.ReadWriteTransaction(context.Background(), func(ctx context.Context, txn *spanner.ReadWriteTransaction) error { stmt := spanner.Statement{ SQL: t.Statement, Params: mapParams, } iter := txn.Query(ctx, stmt) defer iter.Stop() for { row, err := iter.Next() if err == iterator.Done { return nil } if err != nil { return fmt.Errorf("unable to parse row: %w", err) } vMap := make(map[string]any) cols := row.ColumnNames() for i, c := range cols { vMap[c] = row.ColumnValue(i) } out = append(out, vMap) } }) 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) (tools.ParamValues, error) { return tools.ParseParams(t.Parameters, 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) }