genai-toolbox/docs/en/resources/tools/mongodb/mongodb-aggregate.md at d013badbdace895d9cbb5572b85d3fffa8917187

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

3.5 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

mongodb-aggregate

docs

A "mongodb-aggregate" tool executes a multi-stage aggregation pipeline against a MongoDB collection.

/resources/tools/mongodb-aggregate

About

The mongodb-aggregate tool is the most powerful query tool for MongoDB, allowing you to process data through a multi-stage pipeline. Each stage transforms the documents as they pass through, enabling complex operations like grouping, filtering, reshaping documents, and performing calculations.

The core of this tool is the pipelinePayload, which must be a string containing a JSON array of pipeline stage documents. The tool returns a JSON array of documents produced by the final stage of the pipeline.

A readOnly flag can be set to true as a safety measure to ensure the pipeline does not contain any write stages (like $out or $merge).

This tool is compatible with the following source type:

mongodb

Example

Here is an example that calculates the average price and total count of products for each category, but only for products with an "active" status.

kind: tools
name: get_category_stats
type: mongodb-aggregate
source: my-mongo-source
description: Calculates average price and count of products, grouped by category.
database: ecommerce
collection: products
readOnly: true
pipelinePayload: |
  [
    {
      "$match": {
        "status": {{json .status_filter}}
      }
    },
    {
      "$group": {
        "_id": "$category",
        "average_price": { "$avg": "$price" },
        "item_count": { "$sum": 1 }
      }
    },
    {
      "$sort": {
        "average_price": -1
      }
    }
  ]
pipelineParams:
  - name: status_filter
    type: string
    description: The product status to filter by (e.g., "active").

Reference

field	type	required	description
type	string	true	Must be `mongodb-aggregate`.
source	string	true	The name of the `mongodb` source to use.
description	string	true	A description of the tool that is passed to the LLM.
database	string	true	The name of the MongoDB database containing the collection.
collection	string	true	The name of the MongoDB collection to run the aggregation on.
pipelinePayload	string	true	A JSON array of aggregation stage documents, provided as a string. Uses `{{json .param_name}}` for templating.
pipelineParams	list	true	A list of parameter objects that define the variables used in the `pipelinePayload`.
canonical	bool	false	Determines if the pipeline string is parsed using MongoDB's Canonical or Relaxed Extended JSON format.
readOnly	bool	false	If `true`, the tool will fail if the pipeline contains write stages (`$out` or `$merge`). Defaults to `false`.

3.5 KiB Raw Blame History

About

Example

Reference

3.5 KiB

Raw Blame History