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 firestoredeletedocuments import ( "context" "fmt" firestoreapi "cloud.google.com/go/firestore" 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/tools/firestore/util" "github.com/googleapis/genai-toolbox/internal/util/parameters" ) const kind string = "firestore-delete-documents" const documentPathsKey string = "documentPaths" 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 { FirestoreClient() *firestoreapi.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"` AuthRequired []string `yaml:"authRequired"` } // 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) { documentPathsParameter := parameters.NewArrayParameter(documentPathsKey, "Array of relative document paths to delete from Firestore (e.g., 'users/userId' or 'users/userId/posts/postId'). Note: These are relative paths, NOT absolute paths like 'projects/{project_id}/databases/{database_id}/documents/...'", parameters.NewStringParameter("item", "Relative document path")) params := parameters.Parameters{documentPathsParameter} mcpManifest := tools.GetMcpManifest(cfg.Name, cfg.Description, cfg.AuthRequired, params, nil) // finish tool setup t := Tool{ Config: cfg, Parameters: params, manifest: tools.Manifest{Description: cfg.Description, Parameters: params.Manifest(), AuthRequired: cfg.AuthRequired}, mcpManifest: mcpManifest, } return t, nil } // validate interface var _ tools.Tool = Tool{} type Tool struct { Config Parameters parameters.Parameters `yaml:"parameters"` manifest tools.Manifest mcpManifest tools.McpManifest } func (t Tool) ToConfig() tools.ToolConfig { return t.Config } 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 } mapParams := params.AsMap() documentPathsRaw, ok := mapParams[documentPathsKey].([]any) if !ok { return nil, fmt.Errorf("invalid or missing '%s' parameter; expected an array", documentPathsKey) } if len(documentPathsRaw) == 0 { return nil, fmt.Errorf("'%s' parameter cannot be empty", documentPathsKey) } // Use ConvertAnySliceToTyped to convert the slice typedSlice, err := parameters.ConvertAnySliceToTyped(documentPathsRaw, "string") if err != nil { return nil, fmt.Errorf("failed to convert document paths: %w", err) } documentPaths, ok := typedSlice.([]string) if !ok { return nil, fmt.Errorf("unexpected type conversion error for document paths") } // Validate each document path for i, path := range documentPaths { if err := util.ValidateDocumentPath(path); err != nil { return nil, fmt.Errorf("invalid document path at index %d: %w", i, err) } } // Create a BulkWriter to handle multiple deletions efficiently bulkWriter := source.FirestoreClient().BulkWriter(ctx) // Keep track of jobs for each document jobs := make([]*firestoreapi.BulkWriterJob, len(documentPaths)) // Add all delete operations to the BulkWriter for i, path := range documentPaths { docRef := source.FirestoreClient().Doc(path) job, err := bulkWriter.Delete(docRef) if err != nil { return nil, fmt.Errorf("failed to add delete operation for document %q: %w", path, err) } jobs[i] = job } // End the BulkWriter to execute all operations bulkWriter.End() // Collect results results := make([]any, len(documentPaths)) for i, job := range jobs { docData := make(map[string]any) docData["path"] = documentPaths[i] // Wait for the job to complete and get the result _, err := job.Results() if err != nil { docData["success"] = false docData["error"] = err.Error() } else { docData["success"] = true } results[i] = docData } return results, nil } func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error) { return parameters.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) } func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error) { return false, nil } func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error) { return "Authorization", nil }