Firebase MCP

🚀 Firebase MCP 協議指南

Firebase MCP（Model Context Protocol）為開發者提供了通過模型上下文協議與 Firebase 服務進行交互的能力，涵蓋身份驗證、Firestore 數據庫和雲存儲等功能。本指南將詳細介紹其安裝、配置、使用方法以及相關開發信息。

🚀 快速開始

安裝

若要開始使用 Firebase MCP，請按以下步驟操作：

1. 下載並安裝 Node.js：請確保安裝的是 LTS 版本的 Node.js。
2. 安裝 Firebase 工具：

npm install -g firebase-tools

3. 初始化 Firebase 項目：

firebase init

配置

環境變量

在 src/index.ts 文件中，添加如下環境變量：

import { config } from 'dotenv';

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

✨ 主要特性

• 支持通過模型上下文協議與 Firebase 服務進行交互。
• 涵蓋身份驗證、Firestore 數據庫和雲存儲等核心功能。

💻 使用示例

身份驗證

基礎用法

• 創建用戶：使用 auth.createUser 工具創建新用戶。

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

• 登錄用戶：使用 auth.signInUser 工具讓用戶登錄。

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

Firestore 數據庫

基礎用法

• 添加文檔：在指定集合中添加新文檔。

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

• 查詢數據：根據條件查詢集合中的文檔。

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

雲存儲

基礎用法

• 上傳文件：將文件上傳到指定目錄。

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

• 獲取文件信息：獲取特定文件的元數據和下載鏈接。

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

🔧 技術細節

開發信息

模塊導出

在 src/index.ts 文件中，導出以下模塊：

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 AuthConfig {
  serviceAccountKeyPath: string;
  projectId: string;
}

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

• Firestore 接口

interface FirestoreConfig extends AuthConfig {
  storageBucket: string;
}

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

測試說明

初始化測試環境

在項目根目錄中創建 testing.json 文件：

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

運行測試

使用以下命令運行測試：

npm test

架構

核心模塊

• Auth Module：處理身份驗證相關操作。
• Firestore Module：管理數據庫交互。
• Storage Module：負責雲存儲操作。

接口設計

• Auth Interface：

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

• Firestore Interface：

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

🤝 貢獻指南

提交代碼

使用以下命令提交更改：

git add .
git commit -m "添加新功能"
git push origin main

📄 許可證

本項目遵循 MIT 許可證。請查看 LICENSE 文件以獲取詳細信息。

❓ 故障排除

常見問題

1. Firebase 初始化失敗

• 原因：服務賬戶密鑰路徑不正確。
• 解決方法：檢查 serviceAccountKeyPath 是否指向正確的 JSON 文件。

2. 數據庫查詢無結果

• 原因：集合路徑或過濾條件錯誤。
• 解決方法：確認集合路徑和過濾條件是否正確。

聯繫方式

有問題請聯繫支持團隊：

firebase support contact

感謝使用 Firebase MCP 協議！如需更多幫助，請參考 Firebase 官方文檔。