MCP Firebase

🚀 Firebase MCP 服務器

Firebase MCP（Model-Controller-Provider）服務器是一款功能強大的工具，可用於管理 Firebase 應用程序中的數據與邏輯。它藉助一系列預定義工具，簡化了應用開發流程，同時提升了代碼的可維護性與擴展性。

🚀 快速開始

若要使用 Firebase MCP 服務器，需滿足以下先決條件：

1. Firebase 賬戶：需要一個有效的 Firebase 賬戶，並創建一個新項目。
2. Node.js：安裝 Node.js 和 npm（版本 8 或更高）。
3. MCP 服務器依賴項：確保已安裝 MCP 服務器所需的依賴項。

✨ 主要特性

數據模型

MCP 服務器支持開發者創建自定義數據模型，涵蓋多種數據類型，如字符串、數字、布爾值、日期和數組等。這些模型可用於表示應用中的實體，像用戶、產品、訂單等。

控制邏輯

MCP 提供了豐富的控制邏輯功能，包括數據驗證、業務規則執行和事件處理。開發者可通過定義規則確保數據的完整性與一致性，並利用事件監聽器響應特定操作。

數據提供

MCP 服務器集成了 Firebase 的即時數據庫和雲存儲服務，提供高效的數據同步和存儲解決方案。它支持大規模數據訪問與操作，適用於各種規模的應用程序。

📦 安裝指南

安裝 MCP 服務器

使用以下命令下載並安裝 MCP 服務器：

npm install firebase-mcp-server --save

配置

在項目根目錄下創建一個 mcp-config.json 文件，並添加以下內容：

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

💻 使用示例

基礎用法

創建用戶

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

更新用戶信息

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

驗證郵箱

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

忘記密碼

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

📚 詳細文檔

運行服務器

啟動

使用以下命令啟動 MCP 服務器：

node index.js

停止

按 Ctrl+C 停止服務器。

調試

日誌記錄

MCP 服務器提供詳細的日誌記錄功能，幫助開發者調試和優化應用程序。日誌信息包括請求、響應和錯誤詳情。

生命週期管理

通過定義生命週期鉤子（beforeCreate, afterCreate 等），開發者可以在數據操作前後執行自定義邏輯。

工具測試

使用 MCP 提供的工具測試功能，驗證各個功能模塊的行為是否符合預期。

響應格式

所有工具返回的響應都採用一致的格式：

成功響應

{
  "success": true,
  "data": { ... }, // 或相關成功數據
  "message": "操作完成"
}

錯誤響應

{
  "success": false,
  "error": "錯誤信息"
}

安全注意事項

⚠️ 重要提示

1. 服務賬戶密鑰：絕對不要將 service-account-key.json 提交到版本控制系統，應將其添加到 .gitignore 文件中，並在生產環境中使用環境變量管理密鑰。
2. 身份驗證：總是驗證用戶輸入，實現適當的錯誤處理，並遵循 Firebase 的安全最佳實踐。

貢獻指南

1. 叉取倉庫
2. 創建功能分支
3. 提交更改
4. 推送到分支
5. 創建拉取請求

📄 許可證

MCP 服務器遵循 MIT 許可證。請參閱 LICENSE 文件以獲取詳細信息。

通過以上指南，您可以輕鬆地使用 Firebase MCP 服務器來構建高效、安全的應用程序。