feat: Add initial set of firestore tools (#864)

This PR adds the following tools for firestore source: 1. Firestore get documents 2. Firestore delete documents 3. Firestore list collections Please note : the integration tests would be added in the coming PRs, this PR is being merged to the feature branch.
googleapis · trehanshakuntG · Jul 18, 2025 · Jul 3, 2025 · Jul 3, 2025 · Jul 3, 2025
commit 356197769e8e8216ad132cd668a521859204e151
@@ -425,6 +425,26 @@ steps:
           "Valkey" \
           valkey \
           valkey
+
+  - id: "firestore"
+    name: golang:1
+    waitFor: ["compile-test-binary"]
+    entrypoint: /bin/bash
+    env:
+      - "GOPATH=/gopath"
+      - "FIRESTORE_PROJECT=$PROJECT_ID"
+      - "SERVICE_ACCOUNT_EMAIL=$SERVICE_ACCOUNT_EMAIL"
+    secretEnv: ["CLIENT_ID"]
+    volumes:
+      - name: "go"
+        path: "/gopath"
+    args:
+      - -c
+      - |
+        .ci/test_with_coverage.sh \
+          "Firestore" \
+          firestore \
+          firestore
 
 
 availableSecrets:

@@ -52,6 +52,12 @@ import (
 	_ "github.com/googleapis/genai-toolbox/internal/tools/bigtable"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/couchbase"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/dgraph"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestoredeletedocuments"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestoregetdocuments"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestoregetrules"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestorelistcollections"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestorequerycollection"
+	_ "github.com/googleapis/genai-toolbox/internal/tools/firestore/firestorevalidaterules"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/http"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/mssql/mssqlexecutesql"
 	_ "github.com/googleapis/genai-toolbox/internal/tools/mssql/mssqlsql"

@@ -1166,6 +1166,7 @@ func TestPrebuiltTools(t *testing.T) {
 	cloudsqlpg_config, _ := prebuiltconfigs.Get("cloud-sql-postgres")
 	cloudsqlmysql_config, _ := prebuiltconfigs.Get("cloud-sql-mysql")
 	cloudsqlmssql_config, _ := prebuiltconfigs.Get("cloud-sql-mssql")
+	firestoreconfig, _ := prebuiltconfigs.Get("firestore")
 	postgresconfig, _ := prebuiltconfigs.Get("postgres")
 	spanner_config, _ := prebuiltconfigs.Get("spanner")
 	spannerpg_config, _ := prebuiltconfigs.Get("spanner-postgres")
@@ -1228,6 +1229,16 @@ func TestPrebuiltTools(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "firestore prebuilt tools",
+			in:   firestoreconfig,
+			wantToolset: server.ToolsetConfigs{
+				"firestore-database-tools": tools.ToolsetConfig{
+					Name:      "firestore-database-tools",
+					ToolNames: []string{"firestore-get-documents", "firestore-list-collections", "firestore-delete-documents", "firestore-query-collection", "firestore-get-rules", "firestore-validate-rules"},
+				},
+			},
+		},
 		{
 			name: "postgres prebuilt tools",
 			in:   postgresconfig,

@@ -0,0 +1,7 @@
+---
+title: "Firestore"
+type: docs
+weight: 1
+description: > 
+  Tools that work with Firestore Sources.
+---
@@ -0,0 +1,38 @@
+---
+title: "firestore-delete-documents"
+type: docs
+weight: 1
+description: > 
+  A "firestore-delete-documents" tool deletes multiple documents from Firestore by their paths.
+aliases:
+- /resources/tools/firestore-delete-documents
+---
+
+## About
+
+A `firestore-delete-documents` tool deletes multiple documents from Firestore by their paths.
+It's compatible with the following sources:
+
+- [firestore](../sources/firestore.md)
+
+`firestore-delete-documents` takes one input parameter `documentPaths` which is an array of 
+document paths to delete. The tool uses Firestore's BulkWriter for efficient batch deletion
+and returns the success status for each document.
+
+## Example
+
+```yaml
+tools:
+  delete_user_documents:
+    kind: firestore-delete-documents
+    source: my-firestore-source
+    description: Use this tool to delete multiple documents from Firestore.
+```
+
+## Reference
+
+| **field**   |                  **type**                  | **required** | **description**                                                                                  |
+|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
+| kind        |                   string                   |     true     | Must be "firestore-delete-documents".                                                            |
+| source      |                   string                   |     true     | Name of the Firestore source to delete documents from.                                           |
+| description |                   string                   |     true     | Description of the tool that is passed to the LLM.                                               |
@@ -0,0 +1,38 @@
+---
+title: "firestore-get-documents"
+type: docs
+weight: 1
+description: > 
+  A "firestore-get-documents" tool retrieves multiple documents from Firestore by their paths.
+aliases:
+- /resources/tools/firestore-get-documents
+---
+
+## About
+
+A `firestore-get-documents` tool retrieves multiple documents from Firestore by their paths.
+It's compatible with the following sources:
+
+- [firestore](../sources/firestore.md)
+
+`firestore-get-documents` takes one input parameter `documentPaths` which is an array of 
+document paths, and returns the documents' data along with metadata such as existence status,
+creation time, update time, and read time.
+
+## Example
+
+```yaml
+tools:
+  get_user_documents:
+    kind: firestore-get-documents
+    source: my-firestore-source
+    description: Use this tool to retrieve multiple documents from Firestore.
+```
+
+## Reference
+
+| **field**   |                  **type**                  | **required** | **description**                                                                                  |
+|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
+| kind        |                   string                   |     true     | Must be "firestore-get-documents".                                                               |
+| source      |                   string                   |     true     | Name of the Firestore source to retrieve documents from.                                         |
+| description |                   string                   |     true     | Description of the tool that is passed to the LLM.                                               |
@@ -0,0 +1,37 @@
+---
+title: "firestore-get-rules"
+type: docs
+weight: 1
+description: > 
+  A "firestore-get-rules" tool retrieves the active Firestore security rules for the current project.
+aliases:
+- /resources/tools/firestore-get-rules
+---
+
+## About
+
+A `firestore-get-rules` tool retrieves the active [Firestore security rules](https://firebase.google.com/docs/firestore/security/get-started) for the current project.
+It's compatible with the following sources:
+
+- [firestore](../sources/firestore.md)
+
+`firestore-get-rules` takes no input parameters and returns the security rules content along with metadata 
+such as the ruleset name, and timestamps.
+
+## Example
+
+```yaml
+tools:
+  get_firestore_rules:
+    kind: firestore-get-rules
+    source: my-firestore-source
+    description: Use this tool to retrieve the active Firestore security rules.
+```
+
+## Reference
+
+| **field**   |                  **type**                  | **required** | **description**                                                                                  |
+|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
+| kind        |                   string                   |     true     | Must be "firestore-get-rules".                                                                  |
+| source      |                   string                   |     true     | Name of the Firestore source to retrieve rules from.                                            |
+| description |                   string                   |     true     | Description of the tool that is passed to the LLM.                                              |
@@ -0,0 +1,38 @@
+---
+title: "firestore-list-collections"
+type: docs
+weight: 1
+description: > 
+  A "firestore-list-collections" tool lists collections in Firestore, either at the root level or as subcollections of a document.
+aliases:
+- /resources/tools/firestore-list-collections
+---
+
+## About
+
+A `firestore-list-collections` tool lists [collections](https://firebase.google.com/docs/firestore/data-model#collections) in Firestore, either at the root level or as [subcollections](https://firebase.google.com/docs/firestore/data-model#subcollections) of a specific document.
+It's compatible with the following sources:
+
+- [firestore](../sources/firestore.md)
+
+`firestore-list-collections` takes an optional `parentPath` parameter to specify a document
+path. If provided, it lists all subcollections of that document. If not provided, it lists
+all root-level collections in the database.
+
+## Example
+
+```yaml
+tools:
+  list_firestore_collections:
+    kind: firestore-list-collections
+    source: my-firestore-source
+    description: Use this tool to list collections in Firestore.
+```
+
+## Reference
+
+| **field**   |                  **type**                  | **required** | **description**                                                                                  |
+|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
+| kind        |                   string                   |     true     | Must be "firestore-list-collections".                                                            |
+| source      |                   string                   |     true     | Name of the Firestore source to list collections from.                                           |
+| description |                   string                   |     true     | Description of the tool that is passed to the LLM.                                               |