Firebase MCP 服务器

一个 Firebase Admin SDK MCP (模型-控制器-提供者) 服务器，提供一套用于管理 Firebase Authentication 和 Firestore 操作的工具。 此服务器可以与 Cursor IDE 或 Claude Desktop 一起使用，以实现与 AI 助手的无缝集成。

功能

身份验证工具

• create_user: 创建新的 Firebase 用户
• get_users: 列出 Firebase Auth 中的所有用户
• get_user: 获取特定用户详细信息
• update_user: 更新用户属性（电子邮件、显示名称、密码）
• delete_user: 从 Firebase Auth 中删除用户
• verify_email: 生成电子邮件验证链接
• reset_password: 生成密码重置链接

Firestore 工具

• get_collections: 列出所有 Firestore 集合
• get_documents: 列出一个集合中的所有文档
• get_document: 获取特定文档数据
• create_document: 创建新文档
• update_document: 更新现有文档
• delete_document: 从 Firestore 中删除文档
• batch_write: 原子性地执行多个写入操作

前提条件

• Python 3.7 或更高版本
• 启用了 Admin SDK 的 Firebase 项目
• Firebase 服务帐户密钥
• Cursor IDE 或 Claude Desktop（用于 AI 助手集成）

设置

1. 创建 Firebase 项目

   • 前往 Firebase 控制台
   • 创建一个新项目或选择一个现有项目
   • 启用 Authentication 和 Firestore 服务

2. 获取 Firebase Admin SDK 凭据

   • 在 Firebase 控制台中，转到“项目设置”>“服务帐户”
   • 点击“生成新的私钥”
   • 将 JSON 文件另存为项目根目录中的 service-account-key.json

3. 安装依赖项

   pip install firebase-admin fastmcp
   

4. 配置服务器

   • 更新 firebase.py 中的服务帐户密钥路径：

     cred = credentials.Certificate("path/to/your/service-account-key.json")
     

运行服务器

1. 启动 MCP 服务器

   您可以通过多种方式运行服务器：

   # 使用 MCP CLI（推荐）
   mcp dev firebase.py
   
   # 使用环境变量
   mcp dev firebase.py -v FIREBASE_KEY=path/to/key.json
   
   # 使用自定义名称
   mcp dev firebase.py --name "Firebase Tools Server"
   
   # 从文件加载环境变量
   mcp dev firebase.py -f .env
   

2. 在 Claude Desktop 中安装

   # 基本安装
   mcp install firebase.py
   
   # 使用自定义名称安装
   mcp install firebase.py --name "Firebase Tools"
   
   # 使用环境变量安装
   mcp install firebase.py -v FIREBASE_KEY=path/to/key.json -v OTHER_VAR=value
   mcp install firebase.py -f .env
   

3. 直接执行

   对于高级场景，您可以直接运行服务器：

   from mcp.server.fastmcp import FastMCP
   
   mcp = FastMCP("Firebase Tools")
   
   if __name__ == "__main__":
       mcp.run()
   

   然后运行：

   python firebase.py
   # 或
   mcp run firebase.py
   

调试

1. 服务器日志

   MCP 服务器提供详细的日志记录。 您可以通过设置环境变量来启用调试日志：

   mcp dev firebase.py -v MCP_LOG_LEVEL=debug
   

2. 生命周期管理

   为了调试初始化和清理，请实现生命周期 API：

   from contextlib import asynccontextmanager
   from collections.abc import AsyncIterator
   from mcp.server import Server
   
   @asynccontextmanager
   async def server_lifespan(server: Server) -> AsyncIterator[dict]:
       # 启动时初始化 Firebase
       firebase_app = initialize_firebase()
       try:
           yield {"firebase": firebase_app}
       finally:
           # 关闭时清理
           await firebase_app.delete()
   
   # 将生命周期传递给服务器
   server = Server("firebase-tools", lifespan=server_lifespan)
   

3. 工具测试

   您可以使用 MCP CLI 测试单个工具：

   # 测试特定工具
   mcp test firebase.py --tool create_user
   
   # 使用特定参数进行测试
   mcp test firebase.py --tool create_user --args '{"email": "test@example.com"}'
   

4. 集成测试

   为了测试完整的服务器集成：

   # 在测试模式下启动服务器
   mcp dev firebase.py --test
   
   # 在另一个终端中，运行集成测试
   mcp test-integration firebase.py
   

使用示例

身份验证操作

# 创建一个新用户
await create_user(email="user@example.com", password="securepassword123")

# 更新用户属性
await update_user(
    user_id="user123",
    email="newemail@example.com",
    display_name="New Name"
)

# 发送电子邮件验证
await verify_email(
    user_id="user123",
    action_url="https://yourapp.com/verified"
)

# 生成密码重置链接
await reset_password(
    email="user@example.com",
    action_url="https://yourapp.com/reset-complete"
)

Firestore 操作

# 创建一个文档
await create_document(
    collection_id="users",
    document_id="user123",
    data={
        "name": "John Doe",
        "age": 30
    }
)

# 更新一个文档
await update_document(
    collection_id="users",
    document_id="user123",
    data={
        "age": 31
    }
)

# 获取文档数据
await get_document(
    collection_id="users",
    document_id="user123"
)

# 执行原子批量操作
await batch_write(operations=[
    {
        "type": "create",
        "collection_id": "users",
        "document_id": "user1",
        "data": {
            "name": "John Doe",
            "email": "john@example.com"
        }
    },
    {
        "type": "update",
        "collection_id": "profiles",
        "document_id": "profile1",
        "data": {
            "age": 30,
            "occupation": "Developer"
        }
    },
    {
        "type": "delete",
        "collection_id": "temp",
        "document_id": "temp1"
    }
])

响应格式

所有工具都以一致的格式返回响应：

# 成功响应
{
    "success": True,
    "data": {...}  # 或相关的成功数据
    "message": "操作已成功完成"
}

# 错误响应
{
    "success": False,
    "error": "错误消息详情"
}

安全注意事项

1. 服务帐户密钥

   • 永远不要将您的 service-account-key.json 提交到版本控制
   • 将其添加到 .gitignore
   • 在生产中使用环境变量

2. 身份验证

   • 始终验证用户输入
   • 实施适当的错误处理
   • 遵循 Firebase 安全最佳实践

贡献

1. Fork 存储库
2. 创建一个功能分支
3. 提交您的更改
4. 推送到分支
5. 创建一个 Pull Request

许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参见 LICENSE 文件。

支持

对于问题和功能请求，请在 GitHub 存储库中创建一个 issue。