Firebase MCP Server

Introduction

Firebase MCP is a Model Context Protocol server that enables AI assistants to interact directly with Firebase services. This integration allows AI systems to perform operations on Firestore databases, manage files in Firebase Storage, and handle user authentication, all while maintaining proper security controls.

Installation

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• A Firebase project with appropriate services enabled
• Firebase configuration details (API keys, project IDs, etc.)

Installation Steps

1. Install the Firebase MCP package:

npm install @gannonh/firebase-mcp

2. Create a configuration file for your Firebase project. You'll need to include your Firebase credentials:

// firebase-config.js
export const firebaseConfig = {
  apiKey: "your-api-key",
  authDomain: "your-project-id.firebaseapp.com",
  projectId: "your-project-id",
  storageBucket: "your-project-id.appspot.com",
  messagingSenderId: "your-messaging-sender-id",
  appId: "your-app-id"
};

3. Create a server file to initialize and run the Firebase MCP server:

// server.js
import { startServer } from '@gannonh/firebase-mcp';
import { firebaseConfig } from './firebase-config.js';

startServer({
  port: 3000,
  firebaseConfig
});

4. Run your server:

node server.js

Docker Installation

Alternatively, you can use Docker:

1. Create a Dockerfile:

FROM node:16
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
EXPOSE 3000
CMD ["node", "server.js"]

2. Build and run the Docker container:

docker build -t firebase-mcp .
docker run -p 3000:3000 firebase-mcp

Configuration

Security Rules

Ensure your Firebase security rules are properly configured to control access to your data. The MCP server will respect these rules when performing operations.

For Firestore:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

For Storage:

rules_version = '2';
service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

Environment Variables

You can also use environment variables for configuration:

FIREBASE_API_KEY=your-api-key
FIREBASE_AUTH_DOMAIN=your-project-id.firebaseapp.com
FIREBASE_PROJECT_ID=your-project-id
FIREBASE_STORAGE_BUCKET=your-project-id.appspot.com
FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id
FIREBASE_APP_ID=your-app-id
MCP_SERVER_PORT=3000

Usage

Once your server is running, AI assistants can interact with your Firebase services through the MCP protocol. The server provides tools for:

1. Firestore Operations: Create, read, update, and delete documents, query collections, and manage subcollections.

2. Storage Operations: Upload, download, list, and delete files in Firebase Storage.

3. Authentication: Manage user authentication, including sign-in, sign-up, and user profile management.

Known Issues

• When using the firestore_list_collections tool, Firebase SDK may output console logs to stdio during the operation. This is a known behavior of the Firebase SDK.

Troubleshooting

• Connection Issues: Ensure your server is running and accessible at the specified port.
• Authentication Errors: Verify your Firebase configuration details are correct.
• Permission Denied: Check your Firebase security rules to ensure they allow the operations you're attempting.
• Rate Limiting: Be aware of Firebase's rate limits for various operations.

Updating

To update to the latest version:

npm update @gannonh/firebase-mcp

Check the CHANGELOG.md file for details on new features, bug fixes, and breaking changes in each release.