mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-03 11:45:10 -05:00
## Description This PR introduces a new subcommand, invoke, to the toolbox CLI. This feature allows developers to execute tools defined in their configuration directly from the command line. - New Subcommand: Implemented invoke as subcommand, which handles tool lookup, parameter unmarshaling from JSON, and invocation. - Persistent Configuration Flags: Updated cmd/root.go to make flags like --tools-file, --tools-folder, and --prebuilt persistent, allowing them to be used with subcommands. - Testing: Added unit tests for various scenarios - Documentation: Created a new "how-to" guide for CLI tool testing and updated the CLI reference documentation.
162 lines
4.9 KiB
Go
162 lines
4.9 KiB
Go
// Copyright 2026 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 invoke
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/googleapis/genai-toolbox/internal/log"
|
|
"github.com/googleapis/genai-toolbox/internal/server"
|
|
"github.com/googleapis/genai-toolbox/internal/server/resources"
|
|
"github.com/googleapis/genai-toolbox/internal/util/parameters"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// RootCommand defines the interface for required by invoke subcommand.
|
|
// This allows subcommands to access shared resources and functionality without
|
|
// direct coupling to the root command's implementation.
|
|
type RootCommand interface {
|
|
// Config returns a copy of the current server configuration.
|
|
Config() server.ServerConfig
|
|
|
|
// Out returns the writer used for standard output.
|
|
Out() io.Writer
|
|
|
|
// LoadConfig loads and merges the configuration from files, folders, and prebuilts.
|
|
LoadConfig(ctx context.Context) error
|
|
|
|
// Setup initializes the runtime environment, including logging and telemetry.
|
|
// It returns the updated context and a shutdown function to be called when finished.
|
|
Setup(ctx context.Context) (context.Context, func(context.Context) error, error)
|
|
|
|
// Logger returns the logger instance.
|
|
Logger() log.Logger
|
|
}
|
|
|
|
func NewCommand(rootCmd RootCommand) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "invoke <tool-name> [params]",
|
|
Short: "Execute a tool directly",
|
|
Long: `Execute a tool directly with parameters.
|
|
Params must be a JSON string.
|
|
Example:
|
|
toolbox invoke my-tool '{"param1": "value1"}'`,
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
return runInvoke(c, args, rootCmd)
|
|
},
|
|
}
|
|
return cmd
|
|
}
|
|
|
|
func runInvoke(cmd *cobra.Command, args []string, rootCmd RootCommand) error {
|
|
ctx, cancel := context.WithCancel(cmd.Context())
|
|
defer cancel()
|
|
|
|
ctx, shutdown, err := rootCmd.Setup(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer func() {
|
|
_ = shutdown(ctx)
|
|
}()
|
|
|
|
// Load and merge tool configurations
|
|
if err := rootCmd.LoadConfig(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Initialize Resources
|
|
sourcesMap, authServicesMap, embeddingModelsMap, toolsMap, toolsetsMap, promptsMap, promptsetsMap, err := server.InitializeConfigs(ctx, rootCmd.Config())
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("failed to initialize resources: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
resourceMgr := resources.NewResourceManager(sourcesMap, authServicesMap, embeddingModelsMap, toolsMap, toolsetsMap, promptsMap, promptsetsMap)
|
|
|
|
// Execute Tool
|
|
toolName := args[0]
|
|
tool, ok := resourceMgr.GetTool(toolName)
|
|
if !ok {
|
|
errMsg := fmt.Errorf("tool %q not found", toolName)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
var paramsInput string
|
|
if len(args) > 1 {
|
|
paramsInput = args[1]
|
|
}
|
|
|
|
params := make(map[string]any)
|
|
if paramsInput != "" {
|
|
if err := json.Unmarshal([]byte(paramsInput), ¶ms); err != nil {
|
|
errMsg := fmt.Errorf("params must be a valid JSON string: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
}
|
|
|
|
parsedParams, err := parameters.ParseParams(tool.GetParameters(), params, nil)
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("invalid parameters: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
parsedParams, err = tool.EmbedParams(ctx, parsedParams, resourceMgr.GetEmbeddingModelMap())
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("error embedding parameters: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
// Client Auth not supported for ephemeral CLI call
|
|
requiresAuth, err := tool.RequiresClientAuthorization(resourceMgr)
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("failed to check auth requirements: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
if requiresAuth {
|
|
errMsg := fmt.Errorf("client authorization is not supported")
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
result, err := tool.Invoke(ctx, resourceMgr, parsedParams, "")
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("tool execution failed: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
|
|
// Print Result
|
|
output, err := json.MarshalIndent(result, "", " ")
|
|
if err != nil {
|
|
errMsg := fmt.Errorf("failed to marshal result: %w", err)
|
|
rootCmd.Logger().ErrorContext(ctx, errMsg.Error())
|
|
return errMsg
|
|
}
|
|
fmt.Fprintln(rootCmd.Out(), string(output))
|
|
|
|
return nil
|
|
}
|