mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 12:45:11 -05:00
This PR update the linking mechanism between Source and Tool.
Tools are directly linked to their Source, either by pointing to the
Source's functions or by assigning values from the source during Tool's
initialization. However, the existing approach means that any
modification to the Source after Tool's initialization might not be
reflected. To address this limitation, each tool should only store a
name reference to the Source, rather than direct link or assigned
values.
Tools will provide interface for `compatibleSource`. This will be used
to determine if a Source is compatible with the Tool.
```
type compatibleSource interface{
Client() http.Client
ProjectID() string
}
```
During `Invoke()`, the tool will run the following operations:
* retrieve Source from the `resourceManager` with source's named defined
in Tool's config
* validate Source via `compatibleSource interface{}`
* run the remaining `Invoke()` function. Fields that are needed is
retrieved directly from the source.
With this update, resource manager is also added as input to other
Tool's function that require access to source (e.g.
`RequiresClientAuthorization()`).
188 lines
5.4 KiB
Go
188 lines
5.4 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 serverlesssparkgetbatch
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
|
|
dataproc "cloud.google.com/go/dataproc/v2/apiv1"
|
|
"cloud.google.com/go/dataproc/v2/apiv1/dataprocpb"
|
|
"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/serverlessspark/common"
|
|
"github.com/googleapis/genai-toolbox/internal/util/parameters"
|
|
"google.golang.org/protobuf/encoding/protojson"
|
|
)
|
|
|
|
const kind = "serverless-spark-get-batch"
|
|
|
|
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 {
|
|
GetBatchControllerClient() *dataproc.BatchControllerClient
|
|
GetProject() string
|
|
GetLocation() string
|
|
}
|
|
|
|
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"`
|
|
AuthRequired []string `yaml:"authRequired"`
|
|
}
|
|
|
|
// validate interface
|
|
var _ tools.ToolConfig = Config{}
|
|
|
|
// ToolConfigKind returns the unique name for this tool.
|
|
func (cfg Config) ToolConfigKind() string {
|
|
return kind
|
|
}
|
|
|
|
// Initialize creates a new Tool instance.
|
|
func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error) {
|
|
desc := cfg.Description
|
|
if desc == "" {
|
|
desc = "Gets a Serverless Spark (aka Dataproc Serverless) batch"
|
|
}
|
|
|
|
allParameters := parameters.Parameters{
|
|
parameters.NewStringParameter("name", "The short name of the batch, e.g. for \"projects/my-project/locations/us-central1/batches/my-batch\", pass \"my-batch\" (the project and location are inherited from the source)"),
|
|
}
|
|
inputSchema, _ := allParameters.McpManifest()
|
|
|
|
mcpManifest := tools.McpManifest{
|
|
Name: cfg.Name,
|
|
Description: desc,
|
|
InputSchema: inputSchema,
|
|
}
|
|
|
|
return Tool{
|
|
Config: cfg,
|
|
manifest: tools.Manifest{Description: desc, Parameters: allParameters.Manifest()},
|
|
mcpManifest: mcpManifest,
|
|
Parameters: allParameters,
|
|
}, nil
|
|
}
|
|
|
|
// Tool is the implementation of the tool.
|
|
type Tool struct {
|
|
Config
|
|
manifest tools.Manifest
|
|
mcpManifest tools.McpManifest
|
|
Parameters parameters.Parameters
|
|
}
|
|
|
|
// Invoke executes the tool's operation.
|
|
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
|
|
}
|
|
|
|
client := source.GetBatchControllerClient()
|
|
|
|
paramMap := params.AsMap()
|
|
name, ok := paramMap["name"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("missing required parameter: name")
|
|
}
|
|
|
|
if strings.Contains(name, "/") {
|
|
return nil, fmt.Errorf("name must be a short batch name without '/': %s", name)
|
|
}
|
|
|
|
req := &dataprocpb.GetBatchRequest{
|
|
Name: fmt.Sprintf("projects/%s/locations/%s/batches/%s", source.GetProject(), source.GetLocation(), name),
|
|
}
|
|
|
|
batchPb, err := client.GetBatch(ctx, req)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to get batch: %w", err)
|
|
}
|
|
|
|
jsonBytes, err := protojson.Marshal(batchPb)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to marshal batch to JSON: %w", err)
|
|
}
|
|
|
|
var result map[string]any
|
|
if err := json.Unmarshal(jsonBytes, &result); err != nil {
|
|
return nil, fmt.Errorf("failed to unmarshal batch JSON: %w", err)
|
|
}
|
|
|
|
consoleUrl, err := common.BatchConsoleURLFromProto(batchPb)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error generating console url: %v", err)
|
|
}
|
|
logsUrl, err := common.BatchLogsURLFromProto(batchPb)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error generating logs url: %v", err)
|
|
}
|
|
|
|
wrappedResult := map[string]any{
|
|
"consoleUrl": consoleUrl,
|
|
"logsUrl": logsUrl,
|
|
"batch": result,
|
|
}
|
|
|
|
return wrappedResult, 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(services []string) bool {
|
|
return tools.IsAuthorized(t.AuthRequired, services)
|
|
}
|
|
|
|
func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error) {
|
|
// Client OAuth not supported, rely on ADCs.
|
|
return false, nil
|
|
}
|
|
|
|
func (t Tool) ToConfig() tools.ToolConfig {
|
|
return t.Config
|
|
}
|
|
|
|
func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error) {
|
|
return "Authorization", nil
|
|
}
|