firestorequerycollection package - github.com/googleapis/mcp-toolbox/internal/tools/firestore/firestorequerycollection - Go Packages

firestorequerycollection

package
v1.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

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"`
}

Config represents the configuration for the Firestore query collection tool

func (Config) Initialize

func (cfg Config) Initialize(context.Context) (tools.Tool, error)

Initialize creates a new Tool instance from the configuration

func (Config) ToolConfigType

func (cfg Config) ToolConfigType() string

ToolConfigType returns the type of tool configuration

type FilterConfig

type FilterConfig struct {
	Field string      `json:"field"`
	Op    string      `json:"op"`
	Value interface{} `json:"value"`
}

FilterConfig represents a filter for the query

func (*FilterConfig) Validate

func (f *FilterConfig) Validate() error

Validate checks if the filter configuration is valid

type OrderByConfig

type OrderByConfig struct {
	Field     string `json:"field"`
	Direction string `json:"direction"`
}

OrderByConfig represents ordering configuration

func (*OrderByConfig) GetDirection

func (o *OrderByConfig) GetDirection() firestoreapi.Direction

GetDirection returns the Firestore direction constant

type Tool

type Tool struct {
	tools.BaseTool[Config]
}

Tool represents the Firestore query collection tool

func (Tool) GetSourceName added in v1.8.0

func (t Tool) GetSourceName() string

func (Tool) Invoke

func (t Tool) Invoke(ctx context.Context, s sources.Source, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError)

Invoke executes the Firestore query based on the provided parameters

func (Tool) ToConfig

func (t Tool) ToConfig() tools.ToolConfig

func (Tool) ValidateSource added in v1.8.0

func (t Tool) ValidateSource(source sources.Source) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL