firestore-data

Usage

All scripts can be executed using Node.js. Replace <param_name> and <param_value> with actual values.

Bash: node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'

PowerShell: node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\": \"<param_value>\"}'

Note: The scripts automatically load the environment variables from various .env files. Do not ask the user to set vars unless skill executions fails due to env var absence.

Scripts

add_documents

Adds a new document to a Firestore collection. Please follow the best practices :

1. Always use typed values in the documentData: Every field must be wrapped with its appropriate type indicator (e.g., {"stringValue": "text"})
2. Integer values can be strings in the documentData: The tool accepts integer values as strings (e.g., {"integerValue": "1500"})
3. Use returnData sparingly: Only set to true when you need to verify the exact data that was written
4. Validate data before sending: Ensure your data matches Firestore's native JSON format
5. Handle timestamps properly: Use RFC3339 format for timestamp strings
6. Base64 encode binary data: Binary data must be base64 encoded in the bytesValue field
7. Consider security rules: Ensure your Firestore security rules allow document creation in the target collection

Parameters

Name	Type	Description	Required	Default
collectionPath	string	The relative path of the collection where the document will be added to (e.g., 'users' or 'users/userId/posts'). Note: This is a relative path, NOT an absolute path like 'projects/{project_id}/databases/{database_id}/documents/...'	Yes
documentData	object	The document data in Firestore's native JSON format. Each field must be wrapped with a type indicator:

• Strings: {"stringValue": "text"}
• Integers: {"integerValue": "123"} or {"integerValue": 123}
• Doubles: {"doubleValue": 123.45}
• Booleans: {"booleanValue": true}
• Timestamps: {"timestampValue": "2025-01-07T10:00:00Z"}
• GeoPoints: {"geoPointValue": {"latitude": 34.05, "longitude": -118.24}}
• Arrays: {"arrayValue": {"values": [{"stringValue": "item1"}, {"integerValue": "2"}]}}
• Maps: {"mapValue": {"fields": {"key1": {"stringValue": "value1"}, "key2": {"booleanValue": true}}}}
• Null: {"nullValue": null}
• Bytes: {"bytesValue": "base64EncodedString"}
• References: {"referenceValue": "collection/document"} | Yes | | | returnData | boolean | If set to true the output will have the data of the created document. This flag if set to false will help avoid overloading the context of the agent. | No | false |