mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-27 00:08:44 -05:00
## Description This commit allows a tool to pull an alternate authorization token from the header of the http request. This is initially being built for the Looker integration. Looker uses its own OAuth token. When deploying MCP Toolbox to Cloud Run, the default token in the "Authorization" header is for authentication with Cloud Run. An alternate token can be put into another header by a client such as ADK or any other client that can programatically set http headers. This token will be used to authenticate with Looker. If needed, other sources can use this by setting the header name in the source config, passing it into the tool config, and returning the header name in the Tool GetAuthTokenHeaderName() function. ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #1540
210 lines
7.0 KiB
Go
210 lines
7.0 KiB
Go
// 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 cloudsqlpgcreateinstances
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
yaml "github.com/goccy/go-yaml"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/sources/cloudsqladmin"
|
|
"github.com/googleapis/genai-toolbox/internal/tools"
|
|
"github.com/googleapis/genai-toolbox/internal/util/parameters"
|
|
sqladmin "google.golang.org/api/sqladmin/v1"
|
|
)
|
|
|
|
const kind string = "cloud-sql-postgres-create-instance"
|
|
|
|
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
|
|
}
|
|
|
|
// Config defines the configuration for the create-instances tool.
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Kind string `yaml:"kind" validate:"required"`
|
|
Description string `yaml:"description"`
|
|
Source string `yaml:"source" validate:"required"`
|
|
AuthRequired []string `yaml:"authRequired"`
|
|
}
|
|
|
|
// validate interface
|
|
var _ tools.ToolConfig = Config{}
|
|
|
|
// ToolConfigKind returns the kind of the tool.
|
|
func (cfg Config) ToolConfigKind() string {
|
|
return kind
|
|
}
|
|
|
|
// Initialize initializes the tool from the configuration.
|
|
func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error) {
|
|
rawS, ok := srcs[cfg.Source]
|
|
if !ok {
|
|
return nil, fmt.Errorf("no source named %q configured", cfg.Source)
|
|
}
|
|
s, ok := rawS.(*cloudsqladmin.Source)
|
|
if !ok {
|
|
return nil, fmt.Errorf("invalid source for %q tool: source kind must be `cloud-sql-admin`", kind)
|
|
}
|
|
|
|
project := s.DefaultProject
|
|
var projectParam parameters.Parameter
|
|
if project != "" {
|
|
projectParam = parameters.NewStringParameterWithDefault("project", project, "The GCP project ID. This is pre-configured; do not ask for it unless the user explicitly provides a different one.")
|
|
} else {
|
|
projectParam = parameters.NewStringParameter("project", "The project ID")
|
|
}
|
|
|
|
allParameters := parameters.Parameters{
|
|
projectParam,
|
|
parameters.NewStringParameter("name", "The name of the instance"),
|
|
parameters.NewStringParameterWithDefault("databaseVersion", "POSTGRES_17", "The database version for Postgres. If not specified, defaults to the latest available version (e.g., POSTGRES_17)."),
|
|
parameters.NewStringParameter("rootPassword", "The root password for the instance"),
|
|
parameters.NewStringParameterWithDefault("editionPreset", "Development", "The edition of the instance. Can be `Production` or `Development`. This determines the default machine type and availability. Defaults to `Development`."),
|
|
}
|
|
paramManifest := allParameters.Manifest()
|
|
|
|
description := cfg.Description
|
|
if description == "" {
|
|
description = "Creates a Postgres instance using `Production` and `Development` presets. For the `Development` template, it chooses a 2 vCPU, 16 GiB RAM, 100 GiB SSD configuration with Non-HA/zonal availability. For the `Production` template, it chooses an 8 vCPU, 64 GiB RAM, 250 GiB SSD configuration with HA/regional availability. The Enterprise Plus edition is used in both cases. The default database version is `POSTGRES_17`. The agent should ask the user if they want to use a different version."
|
|
}
|
|
mcpManifest := tools.GetMcpManifest(cfg.Name, description, cfg.AuthRequired, allParameters)
|
|
|
|
return Tool{
|
|
Config: cfg,
|
|
Source: s,
|
|
AllParams: allParameters,
|
|
manifest: tools.Manifest{Description: cfg.Description, Parameters: paramManifest, AuthRequired: cfg.AuthRequired},
|
|
mcpManifest: mcpManifest,
|
|
}, nil
|
|
}
|
|
|
|
// Tool represents the create-instances tool.
|
|
type Tool struct {
|
|
Config
|
|
Source *cloudsqladmin.Source
|
|
AllParams parameters.Parameters `yaml:"allParams"`
|
|
manifest tools.Manifest
|
|
mcpManifest tools.McpManifest
|
|
}
|
|
|
|
func (t Tool) ToConfig() tools.ToolConfig {
|
|
return t.Config
|
|
}
|
|
|
|
// Invoke executes the tool's logic.
|
|
func (t Tool) Invoke(ctx context.Context, params parameters.ParamValues, accessToken tools.AccessToken) (any, error) {
|
|
paramsMap := params.AsMap()
|
|
|
|
project, ok := paramsMap["project"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing 'project' parameter")
|
|
}
|
|
name, ok := paramsMap["name"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing 'name' parameter")
|
|
}
|
|
dbVersion, ok := paramsMap["databaseVersion"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing 'databaseVersion' parameter")
|
|
}
|
|
rootPassword, ok := paramsMap["rootPassword"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing 'rootPassword' parameter")
|
|
}
|
|
editionPreset, ok := paramsMap["editionPreset"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing 'editionPreset' parameter")
|
|
}
|
|
|
|
settings := sqladmin.Settings{}
|
|
switch strings.ToLower(editionPreset) {
|
|
case "production":
|
|
settings.AvailabilityType = "REGIONAL"
|
|
settings.Edition = "ENTERPRISE_PLUS"
|
|
settings.Tier = "db-perf-optimized-N-8"
|
|
settings.DataDiskSizeGb = 250
|
|
settings.DataDiskType = "PD_SSD"
|
|
case "development":
|
|
settings.AvailabilityType = "ZONAL"
|
|
settings.Edition = "ENTERPRISE_PLUS"
|
|
settings.Tier = "db-perf-optimized-N-2"
|
|
settings.DataDiskSizeGb = 100
|
|
settings.DataDiskType = "PD_SSD"
|
|
default:
|
|
return nil, fmt.Errorf("invalid 'editionPreset': %q. Must be either 'Production' or 'Development'", editionPreset)
|
|
}
|
|
|
|
instance := sqladmin.DatabaseInstance{
|
|
Name: name,
|
|
DatabaseVersion: dbVersion,
|
|
RootPassword: rootPassword,
|
|
Settings: &settings,
|
|
Project: project,
|
|
}
|
|
|
|
service, err := t.Source.GetService(ctx, string(accessToken))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
resp, err := service.Instances.Insert(project, &instance).Do()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error creating instance: %w", err)
|
|
}
|
|
|
|
return resp, nil
|
|
}
|
|
|
|
// ParseParams parses the parameters for the tool.
|
|
func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error) {
|
|
return parameters.ParseParams(t.AllParams, data, claims)
|
|
}
|
|
|
|
// Manifest returns the tool's manifest.
|
|
func (t Tool) Manifest() tools.Manifest {
|
|
return t.manifest
|
|
}
|
|
|
|
// McpManifest returns the tool's MCP manifest.
|
|
func (t Tool) McpManifest() tools.McpManifest {
|
|
return t.mcpManifest
|
|
}
|
|
|
|
// Authorized checks if the tool is authorized.
|
|
func (t Tool) Authorized(verifiedAuthServices []string) bool {
|
|
return true
|
|
}
|
|
|
|
func (t Tool) RequiresClientAuthorization() bool {
|
|
return t.Source.UseClientAuthorization()
|
|
}
|
|
|
|
func (t Tool) GetAuthTokenHeaderName() string {
|
|
return "Authorization"
|
|
}
|