MCP Firebase

🚀 Firebase MCP Server

Firebase MCP (Model-Controller-Provider) Server is a powerful tool for managing data and logic in Firebase applications. It simplifies the application development process by providing a series of predefined tools, while enhancing the maintainability and scalability of the code.

🚀 Quick Start

Prerequisites

1. Firebase Account: You need a valid Firebase account and create a new project.
2. Node.js: Install Node.js and npm (version 8 or higher).
3. MCP Server Dependencies: Ensure that the dependencies required by the MCP server are installed.

Installation

Use the following command to download and install the MCP server:

npm install firebase-mcp-server --save

Configuration

Create a mcp-config.json file in the project root directory and add the following content:

{
  "firebase": {
    "apiKey": "your_api_key",
    "authDomain": "your_auth_domain",
    "projectId": "your_project_id",
    "storageBucket": "your_storage_bucket",
    "messagingSenderId": "your_messaging_sender_id"
  }
}

Starting the Server

Use the following command to start the MCP server:

node index.js

Stopping the Server

Press Ctrl+C to stop the server.

✨ Features

Data Models

The MCP server allows developers to create custom data models, supporting various data types, including strings, numbers, booleans, dates, and arrays. These models can represent entities in the application, such as users, products, and orders.

Control Logic

MCP offers a rich set of control logic features, including data validation, business rule execution, and event handling. Developers can define rules to ensure data integrity and consistency and use event listeners to respond to specific operations.

Data Provision

The MCP server integrates Firebase's Realtime Database and Cloud Storage services, providing efficient data synchronization and storage solutions. It supports large-scale data access and operations, suitable for applications of all sizes.

📦 Installation

Installing the MCP Server

npm install firebase-mcp-server --save

Configuration

Create a mcp-config.json file in the project root directory and add the following configuration:

{
  "firebase": {
    "apiKey": "your_api_key",
    "authDomain": "your_auth_domain",
    "projectId": "your_project_id",
    "storageBucket": "your_storage_bucket",
    "messagingSenderId": "your_messaging_sender_id"
  }
}

💻 Usage Examples

Creating a User

await createUser(email: "user@example.com", password: "securepassword123");

Updating User Information

await updateUser(
    userId: "user123",
    email: "newemail@example.com",
    displayName: "New Name"
);

Verifying an Email

await verifyEmail(
    userId: "user123",
    actionUrl: "https://yourapp.com/verified"
);

Resetting a Password

await resetPassword(
    email: "user@example.com",
    actionUrl: "https://yourapp.com/reset-complete"
);

📚 Documentation

Response Format

All tools return responses in a consistent format:

Successful Response

{
  "success": true,
  "data": { ... }, // or relevant success data
  "message": "Operation completed"
}

Error Response

{
  "success": false,
  "error": "Error message"
}

Debugging

Logging

The MCP server provides detailed logging capabilities to help developers debug and optimize the application. Log information includes requests, responses, and error details.

Lifecycle Management

By defining lifecycle hooks (beforeCreate, afterCreate, etc.), developers can execute custom logic before and after data operations.

Tool Testing

Use the tool testing functionality provided by MCP to verify the behavior of each functional module.

🔧 Technical Details

Security Precautions

Service Account Keys

• Never commit the service-account-key.json file to the version control system.
• Add it to the .gitignore file.
• Manage keys using environment variables in the production environment.

Authentication

• Always validate user input.
• Implement appropriate error handling.
• Follow Firebase's security best practices.

Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a pull request.

📄 License

The MCP server is licensed under the MIT License. Please refer to the LICENSE file for details.