mongodb-insert-one - Genai Toolbox

About

The mongodb-insert-one tool inserts a single new document into a specified MongoDB collection.

This tool takes one required parameter named data, which must be a string containing the JSON object you want to insert. Upon successful insertion, the tool returns the unique _id of the newly created document.

Compatible Sources

Example

Here is an example configuration for a tool that adds a new user to a users collection.

yaml

kind: tool
name: create_new_user
type: mongodb-insert-one
source: my-mongo-source
description: Creates a new user record in the database.
database: user_data
collection: users
canonical: false

An LLM would call this tool by providing the document as a JSON string in the data parameter, like this: tool_code: create_new_user(data='{"email": "[email protected]", "name": "Jane Doe", "status": "active"}')

Reference

field	type	required	description
type	string	true	Must be `mongodb-insert-one`.
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 into which the document will be inserted.
canonical	bool	false	Determines if the data string is parsed using MongoDB's Canonical or Relaxed Extended JSON format. Defaults to `false`.