Firebase MCP

🚀 Firebase MCP Protocol Guide

Firebase MCP (Model Context Protocol) allows developers to interact with Firebase services through the model context protocol, including authentication, Firestore database, and cloud storage. This document details how to install, configure, and use Firebase MCP.

🚀 Quick Start

📦 Installation

To start using Firebase MCP, follow these steps:

1. Download and Install Node.js: Ensure you have the LTS version of Node.js installed.
2. Install Firebase Tools:

   npm install -g firebase-tools
   

3. Initialize a Firebase Project:

   firebase init
   

⚙️ Configuration

Environment Variables

In the src/index.ts file, add the following environment variables:

import { config } from 'dotenv';

config({
  serviceAccountKeyPath: './path/to/service-account.json',
  projectId: 'your-project-id',
  storageBucket: 'your-storage-bucket.appspot.com'
});

💻 Usage Examples

Authentication

Create a User

Use the auth.createUser tool to create a new user:

{
  "tool": "auth.createUser",
  "params": {
    "email": "user@example.com",
    "password": "secure-password"
  }
}

Sign In a User

Use the auth.signInUser tool to let a user sign in:

{
  "tool": "auth.signInUser",
  "params": {
    "email": "user@example.com",
    "password": "secure-password"
  }
}

Firestore Database

Add a Document

Add a new document to a specified collection:

{
  "tool": "firestore.addDoc",
  "params": {
    "collectionPath": "users",
    "data": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}

Query Data

Query documents in a collection based on conditions:

{
  "tool": "firestore.queryCollection",
  "params": {
    "collectionPath": "users",
    "filters": [
      {
        "field": "name",
        "operator": "==",
        "value": "John Doe"
      }
    ]
  }
}

Cloud Storage

Upload a File

Upload a file to a specified directory:

{
  "tool": "storage.uploadFile",
  "params": {
    "filePath": "uploads/profile.jpg",
    "data": "base64-encoded-string"
  }
}

Get File Information

Get the metadata and download link of a specific file:

{
  "tool": "storage.getFileInfo",
  "params": {
    "filePath": "uploads/profile.jpg"
  }
}

📚 Documentation

Module Exports

In the src/index.ts file, export the following modules:

export const config = require('dotenv').config();
export { default as auth } from './auth';
export { default as firestore } from './firestore';
export { default as storage } from './storage';

Interface Definitions

Authentication Interface

interface AuthConfig {
  serviceAccountKeyPath: string;
  projectId: string;
}

interface CreateUserParams {
  email: string;
  password: string;
}

Firestore Interface

interface FirestoreConfig extends AuthConfig {
  storageBucket: string;
}

interface FirestoreDoc<T> {
  id?: string;
  data: T;
}

🔧 Testing Instructions

Initialize the Testing Environment

Create a testing.json file in the project root directory:

{
  "serviceAccountKeyPath": "./test/service-account.json",
  "projectId": "test-project-id",
  "storageBucket": "test-storage-bucket.appspot.com"
}

Run Tests

Run tests using the following command:

npm test

🏗️ Architecture

Core Modules

• Auth Module: Handles authentication-related operations.
• Firestore Module: Manages database interactions.
• Storage Module: Responsible for cloud storage operations.

Interface Design

• Auth Interface:

  • createUser(params: CreateUserParams)
  • signInUser(params: SignInUserParams)

• Firestore Interface:

  • addDoc(collectionPath: string, doc: FirestoreDoc<any>)
  • queryCollection(collectionPath: string, filters: Filter[])

🤝 Contribution Guidelines

Submit Code

Submit changes using the following commands:

git add .
git commit -m "Add new feature"
git push origin main

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

⚠️ Troubleshooting

Common Issues

1. Firebase Initialization Failure

• Cause: Incorrect service account key path.
• Solution: Check if the serviceAccountKeyPath points to the correct JSON file.

2. No Database Query Results

• Cause: Incorrect collection path or filter conditions.
• Solution: Confirm that the collection path and filter conditions are correct.

Contact Information

If you have any questions, contact the support team:

firebase support contact

Thank you for using the Firebase MCP Protocol! For more help, please refer to the Firebase Official Documentation.