关键词

FirebaseRealtime Database数据查询AI工具数据库集成

项目简介

该项目是一个基于Model Context Protocol (MCP) 标准构建的服务器端应用，专门用于集成 Firebase Realtime Database。它使得支持MCP协议的AI客户端（如某些代码编辑器或AI助手）能够通过标准化的工具（Tools）与您的Firebase Realtime Database进行交互，从而实现数据读取等功能。

主要功能点

  • 数据访问: 允许AI通过调用预定义的工具，根据特定条件（如字段和值）查询并获取Firebase Realtime Database中的数据。
  • 集合浏览: 提供工具让AI列出Firebase Realtime Database根目录下的顶级路径或“集合”名称，帮助AI了解数据库结构。
  • 与AI集成: 作为AI客户端和Firebase Realtime Database之间的桥梁，将AI的请求转换为数据库操作，并将结果返回给AI。

安装步骤

该服务器需要Node.js环境来运行。

  1. 准备Firebase服务账号: 前往Firebase控制台，项目的“项目设置”→“服务账号”，生成新的私钥，并下载JSON文件。请妥善保管此文件。
  2. 获取服务器代码: 从GitHub仓库克隆或下载服务器代码到您的本地环境。
  3. 安装依赖: 在服务器代码的根目录执行 'npm install' 或 'yarn install' 来安装项目所需的依赖包。

服务器配置

MCP服务器需要通过MCP客户端进行配置和启动。您需要在您使用的MCP客户端（如Claude Desktop, Augment, Cursor等）的MCP设置文件中添加该服务器的配置信息。

配置信息通常是一个JSON对象，指定服务器的启动方式。以下是配置的主要组成部分及说明：

// 示例配置结构 (请勿直接复制，仅供参考理解)
{
  "your-server-name": { // 给您的MCP服务器实例起一个名字，例如 "firebase-realtimeDB-mcp"
      "command": "node", // 启动服务器的命令，这里是执行Node.js
      "args": ["/绝对/路径/到/firebase-realtimeDB-mcp/dist/index.js"], // 传递给command的参数，指定要运行的服务器入口文件路径
      "env": { // 环境变量，用于配置服务器的运行时参数
        "SERVICE_ACCOUNT_KEY_PATH": "/绝对/路径/到/您的/serviceAccountKey.json", // **必填**: 您的Firebase服务账号密钥JSON文件的绝对路径
        "FIREBASE_DATABASE_URL": "您的-项目ID.firebaseio.com" // **必填**: 您的Firebase Realtime Database的URL (通常是 https://您的-项目ID.firebaseio.com)
      }
   }
}

请根据您实际下载的代码路径、服务账号文件路径和数据库URL，在您的MCP客户端设置中填写对应的 'command'、'args' 和 'env' 值。

基本使用方法

配置完成后，当您的AI客户端连接到该MCP服务器时，AI将能够发现并使用该服务器提供的工具。例如：

  • AI可以通过调用名为 'list_collections' 的工具来获取数据库根目录下的顶级路径列表。
  • AI可以通过调用名为 'get_documents_by_filter' 的工具，并提供 'collectionName' (集合路径)、'field' (字段名) 和 'value' (字段值) 参数，来获取满足条件的数据记录。

AI会根据需要自动判断何时调用这些工具来辅助完成任务（如回答关于数据库内容的问题）。

信息

分类

数据库与文件

访问项目