chore: import upstream snapshot with attribution
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,194 @@
|
||||
// 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 cloudstoragereadobject
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
yaml "github.com/goccy/go-yaml"
|
||||
"github.com/googleapis/mcp-toolbox/internal/tools"
|
||||
"github.com/googleapis/mcp-toolbox/internal/tools/cloudstorage/cloudstoragecommon"
|
||||
"github.com/googleapis/mcp-toolbox/internal/util"
|
||||
"github.com/googleapis/mcp-toolbox/internal/util/parameters"
|
||||
)
|
||||
|
||||
const resourceType string = "cloud-storage-read-object"
|
||||
|
||||
const (
|
||||
bucketKey = "bucket"
|
||||
objectKey = "object"
|
||||
rangeKey = "range"
|
||||
)
|
||||
|
||||
func init() {
|
||||
if !tools.Register(resourceType, newConfig) {
|
||||
panic(fmt.Sprintf("tool type %q already registered", resourceType))
|
||||
}
|
||||
}
|
||||
|
||||
func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (tools.ToolConfig, error) {
|
||||
actual := Config{ConfigBase: tools.ConfigBase{Name: name}}
|
||||
if err := decoder.DecodeContext(ctx, &actual); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return actual, nil
|
||||
}
|
||||
|
||||
type compatibleSource interface {
|
||||
ReadObject(ctx context.Context, bucket, object string, offset, length int64) (map[string]any, error)
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
tools.ConfigBase `yaml:",inline"`
|
||||
Type string `yaml:"type" validate:"required"`
|
||||
Source string `yaml:"source" validate:"required"`
|
||||
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`
|
||||
Bucket *string `yaml:"bucket,omitempty"`
|
||||
}
|
||||
|
||||
// validate interface
|
||||
var _ tools.ToolConfig = Config{}
|
||||
|
||||
func (cfg Config) ToolConfigType() string {
|
||||
return resourceType
|
||||
}
|
||||
|
||||
func (cfg Config) Initialize(context.Context) (tools.Tool, error) {
|
||||
if cfg.Description == "" {
|
||||
return nil, fmt.Errorf("description is required for tool %q", cfg.Name)
|
||||
}
|
||||
if cfg.Bucket != nil && *cfg.Bucket == "" {
|
||||
return nil, fmt.Errorf("bucket cannot be empty for tool %q", cfg.Name)
|
||||
}
|
||||
|
||||
objectParam := parameters.NewStringParameter(objectKey, "Full object name (path) within the bucket, e.g. 'path/to/file.txt'.")
|
||||
rangeParam := parameters.NewStringParameter(rangeKey, "Optional HTTP byte range, e.g. 'bytes=0-999' (first 1000 bytes), 'bytes=-500' (last 500 bytes), or 'bytes=500-' (from byte 500 to end). Empty reads the full object.", parameters.WithStringDefault(""))
|
||||
allParameters := parameters.Parameters{}
|
||||
if cfg.Bucket == nil {
|
||||
allParameters = append(allParameters, parameters.NewStringParameter(bucketKey, "Name of the Cloud Storage bucket containing the object."))
|
||||
}
|
||||
allParameters = append(allParameters, objectParam, rangeParam)
|
||||
|
||||
return Tool{
|
||||
BaseTool: tools.NewBaseTool(
|
||||
cfg,
|
||||
tools.GetAnnotationsOrDefault(cfg.Annotations, tools.NewReadOnlyAnnotations),
|
||||
tools.Manifest{Description: cfg.Description, Parameters: allParameters.Manifest(), AuthRequired: cfg.AuthRequired},
|
||||
allParameters,
|
||||
),
|
||||
}, nil
|
||||
}
|
||||
|
||||
// validate interface
|
||||
var _ tools.Tool = Tool{}
|
||||
|
||||
type Tool struct {
|
||||
tools.BaseTool[Config]
|
||||
}
|
||||
|
||||
func (t Tool) ToConfig() tools.ToolConfig {
|
||||
return t.Cfg
|
||||
}
|
||||
|
||||
func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError) {
|
||||
source, err := tools.GetCompatibleSource[compatibleSource](resourceMgr, t.Cfg.Source, t.Cfg.Name, t.Cfg.Type)
|
||||
if err != nil {
|
||||
return nil, util.NewClientServerError("source used is not compatible with the tool", http.StatusInternalServerError, err)
|
||||
}
|
||||
|
||||
mapParams := params.AsMap()
|
||||
bucket := cloudstoragecommon.ResolveString(t.Cfg.Bucket, mapParams, bucketKey)
|
||||
if bucket == "" {
|
||||
return nil, util.NewAgentError(fmt.Sprintf("invalid or missing '%s' parameter; expected a non-empty string", bucketKey), nil)
|
||||
}
|
||||
object, ok := mapParams[objectKey].(string)
|
||||
if !ok || object == "" {
|
||||
return nil, util.NewAgentError(fmt.Sprintf("invalid or missing '%s' parameter; expected a non-empty string", objectKey), nil)
|
||||
}
|
||||
rangeSpec, _ := mapParams[rangeKey].(string)
|
||||
|
||||
offset, length, err := parseRange(rangeSpec)
|
||||
if err != nil {
|
||||
return nil, util.NewAgentError(fmt.Sprintf("invalid '%s' parameter: %v", rangeKey, err), err)
|
||||
}
|
||||
|
||||
resp, err := source.ReadObject(ctx, bucket, object, offset, length)
|
||||
if err != nil {
|
||||
return nil, cloudstoragecommon.ProcessGCSError(err)
|
||||
}
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
// parseRange converts an HTTP Range header value into (offset, length) args for
|
||||
// storage.ObjectHandle.NewRangeReader, where length == -1 means "read to end".
|
||||
// Supported forms:
|
||||
//
|
||||
// "" → (0, -1) // full object
|
||||
// "bytes=0-9" → (0, 10) // first 10 bytes
|
||||
// "bytes=10-" → (10, -1) // from byte 10 to end
|
||||
// "bytes=-N" → (-N, -1) // last N bytes
|
||||
func parseRange(rangeSpec string) (offset int64, length int64, err error) {
|
||||
if rangeSpec == "" {
|
||||
return 0, -1, nil
|
||||
}
|
||||
|
||||
spec := strings.TrimSpace(rangeSpec)
|
||||
if !strings.HasPrefix(spec, "bytes=") {
|
||||
return 0, 0, fmt.Errorf("range %q must start with 'bytes='", rangeSpec)
|
||||
}
|
||||
spec = strings.TrimPrefix(spec, "bytes=")
|
||||
|
||||
dash := strings.IndexByte(spec, '-')
|
||||
if dash < 0 {
|
||||
return 0, 0, fmt.Errorf("range %q is missing '-'", rangeSpec)
|
||||
}
|
||||
|
||||
startStr := spec[:dash]
|
||||
endStr := spec[dash+1:]
|
||||
|
||||
switch {
|
||||
case startStr == "" && endStr == "":
|
||||
return 0, 0, fmt.Errorf("range %q requires at least one bound", rangeSpec)
|
||||
|
||||
case startStr == "":
|
||||
n, parseErr := strconv.ParseInt(endStr, 10, 64)
|
||||
if parseErr != nil || n <= 0 {
|
||||
return 0, 0, fmt.Errorf("range %q has a bad suffix length", rangeSpec)
|
||||
}
|
||||
return -n, -1, nil
|
||||
|
||||
case endStr == "":
|
||||
start, parseErr := strconv.ParseInt(startStr, 10, 64)
|
||||
if parseErr != nil || start < 0 {
|
||||
return 0, 0, fmt.Errorf("range %q has a bad start", rangeSpec)
|
||||
}
|
||||
return start, -1, nil
|
||||
|
||||
default:
|
||||
start, parseErr := strconv.ParseInt(startStr, 10, 64)
|
||||
if parseErr != nil || start < 0 {
|
||||
return 0, 0, fmt.Errorf("range %q has a bad start", rangeSpec)
|
||||
}
|
||||
end, parseErr := strconv.ParseInt(endStr, 10, 64)
|
||||
if parseErr != nil || end < start {
|
||||
return 0, 0, fmt.Errorf("range %q has a bad end", rangeSpec)
|
||||
}
|
||||
return start, end - start + 1, nil
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,267 @@
|
||||
// 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 cloudstoragereadobject
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/googleapis/mcp-toolbox/internal/server"
|
||||
"github.com/googleapis/mcp-toolbox/internal/sources"
|
||||
"github.com/googleapis/mcp-toolbox/internal/testutils"
|
||||
"github.com/googleapis/mcp-toolbox/internal/tools"
|
||||
"github.com/googleapis/mcp-toolbox/internal/util/parameters"
|
||||
)
|
||||
|
||||
func TestParseFromYamlCloudStorageReadObject(t *testing.T) {
|
||||
ctx, err := testutils.ContextWithNewLogger()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %s", err)
|
||||
}
|
||||
tcs := []struct {
|
||||
desc string
|
||||
in string
|
||||
want server.ToolConfigs
|
||||
}{
|
||||
{
|
||||
desc: "basic example",
|
||||
in: `
|
||||
kind: tool
|
||||
name: read_object_tool
|
||||
type: cloud-storage-read-object
|
||||
source: my-gcs
|
||||
description: Read a Cloud Storage object
|
||||
`,
|
||||
want: server.ToolConfigs{
|
||||
"read_object_tool": Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "read_object_tool",
|
||||
Description: "Read a Cloud Storage object",
|
||||
AuthRequired: []string{},
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "my-gcs",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "with auth requirements",
|
||||
in: `
|
||||
kind: tool
|
||||
name: secure_read_object
|
||||
type: cloud-storage-read-object
|
||||
source: prod-gcs
|
||||
description: Read object with authentication
|
||||
authRequired:
|
||||
- google-auth-service
|
||||
`,
|
||||
want: server.ToolConfigs{
|
||||
"secure_read_object": Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "secure_read_object",
|
||||
Description: "Read object with authentication",
|
||||
AuthRequired: []string{"google-auth-service"},
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "prod-gcs",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "with configurable bucket",
|
||||
in: `
|
||||
kind: tool
|
||||
name: configured_read_object
|
||||
type: cloud-storage-read-object
|
||||
source: prod-gcs
|
||||
description: Read configured object
|
||||
bucket: baked-bucket
|
||||
`,
|
||||
want: server.ToolConfigs{
|
||||
"configured_read_object": Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "configured_read_object",
|
||||
Description: "Read configured object",
|
||||
AuthRequired: []string{},
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "prod-gcs",
|
||||
Bucket: strPtr("baked-bucket"),
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tc := range tcs {
|
||||
t.Run(tc.desc, func(t *testing.T) {
|
||||
_, _, _, got, _, _, err := server.UnmarshalResourceConfig(ctx, testutils.FormatYaml(tc.in))
|
||||
if err != nil {
|
||||
t.Fatalf("unable to unmarshal: %s", err)
|
||||
}
|
||||
if diff := cmp.Diff(tc.want, got); diff != "" {
|
||||
t.Fatalf("incorrect parse: diff %v", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func strPtr(s string) *string {
|
||||
return &s
|
||||
}
|
||||
|
||||
type mockSource struct {
|
||||
sources.Source
|
||||
called bool
|
||||
gotBucket string
|
||||
gotObject string
|
||||
gotOffset int64
|
||||
gotLength int64
|
||||
}
|
||||
|
||||
func (m *mockSource) ReadObject(ctx context.Context, bucket, object string, offset, length int64) (map[string]any, error) {
|
||||
m.called = true
|
||||
m.gotBucket = bucket
|
||||
m.gotObject = object
|
||||
m.gotOffset = offset
|
||||
m.gotLength = length
|
||||
return map[string]any{"content": "hello", "contentType": "text/plain", "size": 5}, nil
|
||||
}
|
||||
|
||||
type mockSourceProvider struct {
|
||||
tools.SourceProvider
|
||||
source *mockSource
|
||||
}
|
||||
|
||||
func (m *mockSourceProvider) GetSource(name string) (sources.Source, bool) {
|
||||
return m.source, true
|
||||
}
|
||||
|
||||
func TestConfiguredBucketHiddenAndForwarded(t *testing.T) {
|
||||
cfg := Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "read_object_tool",
|
||||
Description: "Read object",
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "my-gcs",
|
||||
Bucket: strPtr("baked-bucket"),
|
||||
}
|
||||
tool, err := cfg.Initialize(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize tool: %v", err)
|
||||
}
|
||||
gotNames := manifestParamNames(tool.StaticManifest().Parameters)
|
||||
wantNames := []string{"object", "range"}
|
||||
if diff := cmp.Diff(wantNames, gotNames); diff != "" {
|
||||
t.Fatalf("manifest parameters mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
|
||||
src := &mockSource{}
|
||||
params := parameters.ParamValues{
|
||||
{Name: "object", Value: "o"},
|
||||
{Name: "range", Value: "bytes=5-9"},
|
||||
}
|
||||
if _, err := tool.Invoke(context.Background(), &mockSourceProvider{source: src}, params, ""); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if src.gotBucket != "baked-bucket" || src.gotObject != "o" || src.gotOffset != 5 || src.gotLength != 5 {
|
||||
t.Fatalf("forwarded bucket/object/range = %q/%q/%d/%d, want baked-bucket/o/5/5", src.gotBucket, src.gotObject, src.gotOffset, src.gotLength)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnsetBucketRemainsVisible(t *testing.T) {
|
||||
cfg := Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "read_object_tool",
|
||||
Description: "Read object",
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "my-gcs",
|
||||
}
|
||||
tool, err := cfg.Initialize(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize tool: %v", err)
|
||||
}
|
||||
gotNames := manifestParamNames(tool.StaticManifest().Parameters)
|
||||
wantNames := []string{"bucket", "object", "range"}
|
||||
if diff := cmp.Diff(wantNames, gotNames); diff != "" {
|
||||
t.Fatalf("manifest parameters mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestEmptyConfiguredBucketRejected(t *testing.T) {
|
||||
cfg := Config{
|
||||
ConfigBase: tools.ConfigBase{
|
||||
Name: "read_object_tool",
|
||||
Description: "Read object",
|
||||
},
|
||||
Type: "cloud-storage-read-object",
|
||||
Source: "my-gcs",
|
||||
Bucket: strPtr(""),
|
||||
}
|
||||
if _, err := cfg.Initialize(context.Background()); err == nil || !strings.Contains(err.Error(), "bucket") {
|
||||
t.Fatalf("Initialize() error = %v, want bucket error", err)
|
||||
}
|
||||
}
|
||||
|
||||
func manifestParamNames(params []parameters.ParameterManifest) []string {
|
||||
names := make([]string, 0, len(params))
|
||||
for _, p := range params {
|
||||
names = append(names, p.Name)
|
||||
}
|
||||
return names
|
||||
}
|
||||
|
||||
func TestParseRange(t *testing.T) {
|
||||
tcs := []struct {
|
||||
in string
|
||||
wantOffset int64
|
||||
wantLength int64
|
||||
wantErr bool
|
||||
}{
|
||||
{in: "", wantOffset: 0, wantLength: -1},
|
||||
{in: "bytes=0-9", wantOffset: 0, wantLength: 10},
|
||||
{in: "bytes=10-19", wantOffset: 10, wantLength: 10},
|
||||
{in: "bytes=10-", wantOffset: 10, wantLength: -1},
|
||||
{in: "bytes=-5", wantOffset: -5, wantLength: -1},
|
||||
{in: "bytes=0-0", wantOffset: 0, wantLength: 1},
|
||||
|
||||
{in: "garbage", wantErr: true},
|
||||
{in: "bytes=", wantErr: true},
|
||||
{in: "bytes=a-b", wantErr: true},
|
||||
{in: "bytes=-", wantErr: true},
|
||||
{in: "bytes=-0", wantErr: true},
|
||||
{in: "bytes=5-2", wantErr: true},
|
||||
{in: "bytes=-1-2", wantErr: true},
|
||||
}
|
||||
for _, tc := range tcs {
|
||||
t.Run(tc.in, func(t *testing.T) {
|
||||
offset, length, err := parseRange(tc.in)
|
||||
if tc.wantErr {
|
||||
if err == nil {
|
||||
t.Fatalf("expected error, got offset=%d length=%d", offset, length)
|
||||
}
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if offset != tc.wantOffset || length != tc.wantLength {
|
||||
t.Fatalf("got (%d, %d), want (%d, %d)", offset, length, tc.wantOffset, tc.wantLength)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user