使用说明

项目简介

Firebase MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 应用提供与 Google Firebase 服务交互的能力。该服务器充当 LLM 客户端与 Firebase Authentication、Firestore 和 Storage 之间的桥梁,通过标准化的 MCP 协议,使得 LLM 能够安全、便捷地访问和操作 Firebase 中的数据和功能。

主要功能点

  • Firebase 服务集成: 将 Firebase Authentication、Firestore 和 Storage 的常用操作封装为 MCP 工具,方便 LLM 调用。
  • Firestore 数据库操作: 提供工具用于在 Firestore 中进行文档的增、删、改、查以及集合的列表查询。
  • 用户身份验证: 支持通过用户ID或邮箱从 Firebase Authentication 获取用户信息。
  • 云存储文件管理: 允许 LLM 列出 Firebase Storage 目录中的文件,并获取文件的元数据和下载链接。
  • 标准 MCP 协议: 采用 JSON-RPC over Stdio 与 MCP 客户端通信,遵循 MCP 规范。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/gemini-dk/mcp-server-firebase
    cd mcp-server-firebase
  2. 安装依赖:

    npm install
  3. 构建项目:

    npm run build
  4. 获取 Firebase 服务账户密钥:

    • 访问 Firebase 控制台,进入您的项目。
    • 导航到 "项目设置" -> "服务账号" 选项卡。
    • 点击 "生成新的私钥" 按钮,下载 JSON 格式的密钥文件。
    • 将下载的密钥文件保存到您的项目目录中,例如命名为 'serviceAccountKey.json'。

服务器配置 (mcp_settings.json)

MCP 客户端需要配置以下 JSON 对象以连接到 Firebase MCP 服务器。请根据实际路径修改 'command'、'args' 和 'env' 中的路径信息。

{
  "firebase-mcp": {
    "command": "node",  // 启动服务器的命令,这里使用 Node.js
    "args": [
      "/path/to/mcp-server-firebase/dist/index.js"  // 服务器入口文件路径,请替换为实际路径
    ],
    "env": {
      "SERVICE_ACCOUNT_KEY_PATH": "/path/to/serviceAccountKey.json"  // Firebase 服务账户密钥文件路径,请替换为实际路径
    }
  }
}

注意:

  • '/path/to/mcp-server-firebase' 需要替换为您克隆仓库后 'mcp-server-firebase' 文件夹在您系统中的绝对路径
  • '/path/to/serviceAccountKey.json' 需要替换为您下载的 Firebase 服务账户密钥文件 'serviceAccountKey.json' 在您项目目录中的绝对路径

基本使用方法

  1. 确保已完成安装步骤并正确配置 'mcp_settings.json' 文件。
  2. 启动 Firebase MCP 服务器 (通常由 MCP 客户端自动启动,或根据 MCP 客户端的文档手动启动)。
  3. 在您的 MCP 客户端应用中,可以通过发送符合 MCP 协议的 JSON-RPC 请求来调用服务器提供的工具,例如:
    • 使用 'ListToolsRequest' 获取可用工具列表。
    • 使用 'CallToolRequest' 调用特定的工具,例如 'firestore_get_document' 或 'auth_get_user',并传递相应的参数。
  4. 服务器会将 Firebase 的数据或操作结果封装在 MCP 响应中返回给客户端。

请参考仓库代码和 MCP 协议文档,了解更多关于可用工具、请求格式和响应结构的详细信息。

信息

分类

数据库与文件