Documentation
¶
Overview ¶
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.
Index ¶
- type Config
- type Tool
- func (t Tool) Authorized(verifiedAuthServices []string) bool
- func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, ...) (parameters.ParamValues, error)
- func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
- func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, ...) (any, error)
- func (t Tool) Manifest() tools.Manifest
- func (t Tool) McpManifest() tools.McpManifest
- func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error)
- func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
- func (t Tool) ToConfig() tools.ToolConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
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" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Path string `yaml:"path" validate:"required"`
Method tools.HTTPMethod `yaml:"method" validate:"required"`
Headers map[string]string `yaml:"headers"`
RequestBody string `yaml:"requestBody"`
PathParams parameters.Parameters `yaml:"pathParams"`
QueryParams parameters.Parameters `yaml:"queryParams"`
BodyParams parameters.Parameters `yaml:"bodyParams"`
HeaderParams parameters.Parameters `yaml:"headerParams"`
}
func (Config) Initialize ¶
func (Config) ToolConfigKind ¶
type Tool ¶
type Tool struct {
Config
Headers map[string]string `yaml:"headers"`
AllParams parameters.Parameters `yaml:"allParams"`
// contains filtered or unexported fields
}
func (Tool) Authorized ¶
func (Tool) EmbedParams ¶ added in v0.25.0
func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, embeddingModelsMap map[string]embeddingmodels.EmbeddingModel) (parameters.ParamValues, error)
func (Tool) GetAuthTokenHeaderName ¶ added in v0.22.0
func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
func (Tool) Invoke ¶
func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, error)
func (Tool) McpManifest ¶
func (t Tool) McpManifest() tools.McpManifest
func (Tool) ParseParams ¶
func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error)
func (Tool) RequiresClientAuthorization ¶ added in v0.13.0
func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
func (Tool) ToConfig ¶ added in v0.20.0
func (t Tool) ToConfig() tools.ToolConfig
Source Files
Click to show internal directories.
Click to hide internal directories.