Firestore Index Sync

Compare Firestore index documentation with firestore.indexes.json and generate a minimal patch to align them.

Updated Jan 2, 2026
One-click install
npx skills add https://github.com/baskarajati/undangan --skill firestore-index-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Firestore Index Sync
Source: https://github.com/baskarajati/undangan/tree/main/.agent/skills/firestore-index-sync
Command: npx skills add https://github.com/baskarajati/undangan --skill firestore-index-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detect and fix drift between documented Firestore indexes and the actual index definitions in firestore.indexes.json, preventing query failures due to mismatched indexes.

Core Features & Use Cases

  • Drift detection: Compare FIRESTORE_INDEXES.md with firestore.indexes.json to identify mismatches across collections, fields, and index order.
  • Auto-generated patching: Produce a minimal patch to align documentation with the true index definitions.
  • Validation & verification: Verify that all documented indexes exist in JSON and that the JSON reflects the current query patterns.

Quick Start

Follow the drift check by comparing FIRESTORE_INDEXES.md and firestore.indexes.json and apply the generated minimal patch to synchronize the documentation.

Frequently Asked Questions about Firestore Index Sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect drift between Firestore indexes documentation and the actual JSON definitions?

Compare FIRESTORE_INDEXES.md with firestore.indexes.json to identify mismatches across collections, fields, and index order. The JSON file is treated as authoritative, and a structured drift report highlights all discrepancies for review.

What causes Firestore query failures due to mismatched index definitions?

Firestore query failures occur when documented indexes in FIRESTORE_INDEXES.md drift from the actual index definitions in firestore.indexes.json. Synchronizing the documentation with the live definitions prevents these mismatched index errors.

How do I generate a patch to sync firestore.indexes.json with FIRESTORE_INDEXES.md?

Generate a minimal patch to sync Firestore indexes by analyzing the drift between the documentation and the JSON file. The patch aligns FIRESTORE_INDEXES.md with the live definitions across collections and fields for review.

Does Firestore index validation check both the JSON file and the markdown documentation?

Firestore index validation verifies that all documented indexes exist in firestore.indexes.json and that the JSON reflects current query patterns. It requires both files to exist before running the drift check.

When should I run a Firestore index drift check?

Run a Firestore index drift check during index changes or documentation updates. This ensures that any modifications to live definitions are captured and documentation is aligned before deployment.

What is the authoritative source for Firestore index definitions when resolving drift?

The firestore.indexes.json file is treated as the authoritative source for Firestore index definitions. The generated patch updates FIRESTORE_INDEXES.md to match the live JSON definitions exactly.