Firestore Advanced MCP

🚀 Firestore Advanced MCP

Firestore Advanced MCP is a powerful tool that offers enhanced operations and optimization features for Firestore databases, ensuring efficient data management and real - time synchronization.

🚀 Quick Start

Firestore Advanced MCP provides a series of functions to operate on Firestore databases. Before using it, make sure you meet the prerequisites and complete the installation and configuration steps.

✨ Features

• 🔥 Supports create, read, update, and delete (CRUD) operations on documents.
• 🛡️ Provides automatic indexing and query optimization features.
• 🔄 Supports real - time data synchronization to ensure data consistency.

📦 Installation

Method 1: Install via npm

npm install firebase @types/firebase firebase-admin

Method 2: Install from source code

git clone https://github.com/FirebaseExtended/firestore-mcp.git
cd firestore-mcp
npm install

💻 Usage Examples

Basic Usage

Run via npm

node index.js

Run via npx

npx firebase-mcp

Run the script directly

const { initializeApp } = require('firebase-admin/app');
const { getFirestore } = require('firebase-admin/firestore');

const app = initializeApp();
const db = getFirestore(app);

Advanced Usage

Configure in Claude

Add the following content to the claude-config.json file:

{
  "firestore": {
    "apiKey": "your-api-key",
    "authDomain": "your-project-id.firebaseapp.com",
    "projectId": "your-project-id"
  }
}

Multiple - condition query

{
  "collection": "products",
  "filters": [
    {
      "field": "category",
      "operator": "==",
      "value": "electronics"
    },
    {
      "field": "price",
      "operator": "<",
      "value": 1000
    }
  ],
  "orderBy": {
    "field": "price",
    "direction": "asc"
  },
  "limit": 10
}

Get a user

{
  "collection": "users",
  "id": "user123"
}

Create an order

{
  "collection": "orders",
  "data": {
    "product": "Laptop",
    "price": 999.99,
    "fields": [
      {
        "fieldPath": "user",
        "type": "reference",
        "value": "users/user123"
      }
    ]
  }
}

Set TTL

{
  "collection": "temporaryData",
  "id": "session123",
  "expiresIn": 86400000,
  "fieldName": "expires_at"
}

📚 Documentation

For more information, please refer to:

• Firestore Documentation
• MCP Protocol Documentation

🔧 Technical Details

Prerequisites

1. Install Node.js v14 or higher.
2. Create a Firebase project and obtain a Firestore database.
3. Download and configure the Firebase service account key.

Configuration

Create a config.js file in the project root directory:

const firebaseConfig = {
  apiKey: 'your-api-key',
  authDomain: 'your-project-id.firebaseapp.com',
  projectId: 'your-project-id',
  storageBucket: 'your-storage-bucket.appspot.com',
  messagingSenderId: 'your-messaging-sender-id',
  appId: 'your-app-id'
};

initializeApp(firebaseConfig);

Environment Variables

Set the following environment variables:

• FIREBASE_API_KEY
• FIREBASE_AUTH_DOMAIN
• FIREBASE_PROJECT_ID
• FIREBASE_STORAGE_BUCKET
• FIREBASE_MESSAGING_SENDER_ID
• FIREBASE_APP_ID

📄 License

This project is licensed under the MIT license. See the LICENSE file for details.

👨‍💻 Author

• Diez7lm

🙏 Acknowledgments

Thanks to the following organizations and projects for their contributions:

• Anthropic for providing Claude and the MCP protocol.
• Firebase for providing Firestore and development tools.

🤝 Contribution

Any contributions are welcome! Please feel free to submit pull requests or issues via GitHub to improve this project.