Documentation
¶
Overview ¶
Package s3 provides an S3 toolkit adapter for the MCP data platform.
Index ¶
- Constants
- Variables
- type AnnotationConfig
- type Config
- type MultiConfig
- type Toolkit
- func (t *Toolkit) AddConnection(name string, config map[string]any) error
- func (t *Toolkit) Client() *s3client.Client
- func (t *Toolkit) Close() error
- func (t *Toolkit) Config() Config
- func (t *Toolkit) Connection() string
- func (t *Toolkit) HasConnection(name string) bool
- func (*Toolkit) Kind() string
- func (t *Toolkit) ListConnections() []toolkit.ConnectionDetail
- func (t *Toolkit) Name() string
- func (t *Toolkit) ProbeConnection(ctx context.Context, name string) connprobe.Result
- func (t *Toolkit) RegisterTools(s *mcp.Server)
- func (t *Toolkit) RemoveConnection(name string) error
- func (t *Toolkit) SetMetrics(m *observability.Metrics)
- func (t *Toolkit) SetQueryProvider(provider query.Provider)
- func (t *Toolkit) SetSemanticProvider(provider semantic.Provider)
- func (*Toolkit) Tools() []string
Constants ¶
const ( // DefaultTimeout is the default HTTP client timeout for S3 operations. DefaultTimeout = 30 * time.Second // DefaultMaxGetSize is the default maximum size for S3 GET operations (10MB). DefaultMaxGetSize = 10 * 1024 * 1024 // DefaultMaxPutSize is the default maximum size for S3 PUT operations (100MB). DefaultMaxPutSize = 100 * 1024 * 1024 )
const ConfigSchemaJSON = `` /* 2124-byte string literal not displayed */
ConfigSchemaJSON declares what an s3 connection's config takes. See the same constant on the trino kind for why a kind declares this at all (#1805).
Variables ¶
var SecretKeys = []string{"access_key_id", "secret_access_key", "session_token"}
SecretKeys are the configuration keys an s3 connection may name a stored secret in as {{secret:<name>}} (#1806). The value is read as the connection's client is built.
Functions ¶
This section is empty.
Types ¶
type AnnotationConfig ¶ added in v0.20.0
type AnnotationConfig = toolkit.AnnotationConfig
AnnotationConfig holds tool annotation overrides from configuration.
type Config ¶
type Config struct {
Region string `yaml:"region"`
Endpoint string `yaml:"endpoint"`
PublicEndpoint string `yaml:"public_endpoint"`
AccessKeyID string `yaml:"access_key_id"`
SecretAccessKey string `yaml:"secret_access_key"`
SessionToken string `yaml:"session_token"` // #nosec G117 -- S3 session token from admin YAML config
Profile string `yaml:"profile"`
UsePathStyle bool `yaml:"use_path_style"`
Timeout time.Duration `yaml:"timeout"`
DisableSSL bool `yaml:"disable_ssl"`
ReadOnly bool `yaml:"read_only"`
MaxGetSize int64 `yaml:"max_get_size"`
MaxPutSize int64 `yaml:"max_put_size"`
ConnectionName string `yaml:"connection_name"`
Description string `yaml:"description"`
BucketPrefix string `yaml:"bucket_prefix"`
Titles map[string]string `yaml:"titles"`
Descriptions map[string]string `yaml:"descriptions"`
Annotations map[string]AnnotationConfig `yaml:"annotations"`
}
Config holds S3 toolkit configuration.
type MultiConfig ¶ added in v1.129.0
MultiConfig is every S3 instance a deployment declares, and which of them a call that names no connection means.
func ParseMultiConfig ¶ added in v1.129.0
ParseMultiConfig parses every instance of the s3 kind. An instance whose config does not parse is logged and skipped rather than blocking startup.
type Toolkit ¶
type Toolkit struct {
// contains filtered or unexported fields
}
Toolkit is the one S3 toolkit of a deployment: every instance is a connection of it, routed by the `connection` argument, so two instances never register the same tool name twice (the SDK keeps the last registration, which left every earlier instance unreachable).
func NewMulti ¶ added in v1.129.0
func NewMulti(cfg MultiConfig) (*Toolkit, error)
NewMulti creates the toolkit over every instance. Each instance is bound by its connection_name (its instance name when it sets none), which is the name a call's `connection` argument carries, an audit row records, and a persona's connection rules match. The default instance serves a call naming none; with no default declared the alphabetically first instance is it.
func (*Toolkit) AddConnection ¶ added in v1.48.0
AddConnection adds a named S3 connection at runtime.
func (*Toolkit) Connection ¶ added in v0.12.1
Connection returns the name a call that names no connection binds: the default connection's bound name.
func (*Toolkit) HasConnection ¶ added in v1.48.0
HasConnection returns true if a connection with the given name exists.
func (*Toolkit) ListConnections ¶ added in v1.129.0
func (t *Toolkit) ListConnections() []toolkit.ConnectionDetail
ListConnections reports every connection this toolkit serves, by bound name, for list_connections and the connection resolver.
func (*Toolkit) ProbeConnection ¶ added in v1.133.4
ProbeConnection opens the named connection and lists its buckets, which is the smallest request that proves the endpoint is reachable and the credential is accepted (#1805).
A connection carrying a bucket prefix lists what the prefix admits, so the count reported is the buckets this connection can actually see rather than the account's.
Implements connprobe.Prober.
func (*Toolkit) RegisterTools ¶
RegisterTools registers s3_list and s3_object with the MCP server. The platform's unified list_connections stands in for upstream's s3_list_connections, so nothing else from mcp-s3 is registered.
func (*Toolkit) RemoveConnection ¶ added in v1.48.0
RemoveConnection removes a named S3 connection at runtime.
func (*Toolkit) SetMetrics ¶ added in v1.70.0
func (t *Toolkit) SetMetrics(m *observability.Metrics)
SetMetrics installs the recorder the S3 handlers report to. The platform calls this before RegisterTools, when metrics OR tracing is enabled; the handlers record nil-safely (no-op when m is disabled) and emit spans only inside an active trace, which is what makes a tracing-only deployment (m nil) still produce S3 spans.
func (*Toolkit) SetQueryProvider ¶
SetQueryProvider sets the query execution provider for enrichment.
func (*Toolkit) SetSemanticProvider ¶
SetSemanticProvider sets the semantic metadata provider for enrichment.
Source Files