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 mongodbfind import ( "context" "encoding/json" "fmt" "slices" "github.com/goccy/go-yaml" "github.com/googleapis/genai-toolbox/internal/util" "github.com/googleapis/genai-toolbox/internal/util/parameters" "go.mongodb.org/mongo-driver/bson" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/options" "github.com/googleapis/genai-toolbox/internal/sources" "github.com/googleapis/genai-toolbox/internal/tools" ) const kind string = "mongodb-find" 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 { MongoClient() *mongo.Client } type Config struct { Name string `yaml:"name" validate:"required"` Kind string `yaml:"kind" validate:"required"` Source string `yaml:"source" validate:"required"` AuthRequired []string `yaml:"authRequired" validate:"required"` Description string `yaml:"description" validate:"required"` Database string `yaml:"database" validate:"required"` Collection string `yaml:"collection" validate:"required"` FilterPayload string `yaml:"filterPayload" validate:"required"` FilterParams parameters.Parameters `yaml:"filterParams"` ProjectPayload string `yaml:"projectPayload"` ProjectParams parameters.Parameters `yaml:"projectParams"` SortPayload string `yaml:"sortPayload"` SortParams parameters.Parameters `yaml:"sortParams"` Limit int64 `yaml:"limit"` } // 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) { // Create a slice for all parameters allParameters := slices.Concat(cfg.FilterParams, cfg.ProjectParams, cfg.SortParams) // Verify no duplicate parameter names err := parameters.CheckDuplicateParameters(allParameters) if err != nil { return nil, err } // Verify 'limit' value if cfg.Limit <= 0 { return nil, fmt.Errorf("limit must be a positive number, but got %d", cfg.Limit) } // Create Toolbox manifest paramManifest := allParameters.Manifest() if paramManifest == nil { paramManifest = make([]parameters.ParameterManifest, 0) } // Create MCP manifest mcpManifest := tools.GetMcpManifest(cfg.Name, cfg.Description, cfg.AuthRequired, allParameters, nil) // finish tool setup return Tool{ Config: cfg, AllParams: allParameters, manifest: tools.Manifest{Description: cfg.Description, Parameters: paramManifest, AuthRequired: cfg.AuthRequired}, mcpManifest: mcpManifest, }, nil } // validate interface var _ tools.Tool = Tool{} type Tool struct { Config AllParams parameters.Parameters `yaml:"allParams"` manifest tools.Manifest mcpManifest tools.McpManifest } func getOptions(ctx context.Context, sortParameters parameters.Parameters, projectPayload string, limit int64, paramsMap map[string]any) (*options.FindOptions, error) { logger, err := util.LoggerFromContext(ctx) if err != nil { panic(err) } opts := options.Find() sort := bson.M{} for _, p := range sortParameters { sort[p.GetName()] = paramsMap[p.GetName()] } opts = opts.SetSort(sort) if len(projectPayload) > 0 { result, err := parameters.PopulateTemplateWithJSON("MongoDBFindProjectString", projectPayload, paramsMap) if err != nil { return nil, fmt.Errorf("error populating project payload: %s", err) } var projection any err = bson.UnmarshalExtJSON([]byte(result), false, &projection) if err != nil { return nil, fmt.Errorf("error unmarshalling projection: %s", err) } opts = opts.SetProjection(projection) logger.DebugContext(ctx, fmt.Sprintf("Projection is set to %v", projection)) } if limit > 0 { opts = opts.SetLimit(limit) logger.DebugContext(ctx, fmt.Sprintf("Limit is being set to %d", limit)) } return opts, 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() filterString, err := parameters.PopulateTemplateWithJSON("MongoDBFindFilterString", t.FilterPayload, paramsMap) if err != nil { return nil, fmt.Errorf("error populating filter: %s", err) } opts, err := getOptions(ctx, t.SortParams, t.ProjectPayload, t.Limit, paramsMap) if err != nil { return nil, fmt.Errorf("error populating options: %s", err) } var filter = bson.D{} err = bson.UnmarshalExtJSON([]byte(filterString), false, &filter) if err != nil { return nil, err } cur, err := source.MongoClient().Database(t.Database).Collection(t.Collection).Find(ctx, filter, opts) if err != nil { return nil, err } defer cur.Close(ctx) var data = []any{} err = cur.All(context.TODO(), &data) if err != nil { return nil, err } var final []any for _, item := range data { tmp, _ := bson.MarshalExtJSON(item, false, false) var tmp2 any err = json.Unmarshal(tmp, &tmp2) if err != nil { return nil, err } final = append(final, tmp2) } return final, err } 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) ToConfig() tools.ToolConfig { return t.Config } func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error) { return "Authorization", nil }