Firebase MCP Server 使用说明
项目简介
Firebase MCP Server 是一个 MCP (Model Context Protocol) 服务器的实现,旨在为 LLM (大型语言模型) 客户端提供与 Firebase 服务交互的桥梁。通过此服务器,支持 MCP 协议的 LLM 应用(如 Claude Desktop、Cursor、Roo Code、Cline 等)可以利用 Firebase 的强大后端能力,包括数据存储、文件管理和用户认证,从而扩展 LLM 应用的功能边界。
主要功能点
- Firebase 服务集成: 通过 MCP 协议将 Firebase Authentication, Firestore, 和 Storage 服务暴露给 LLM 客户端。
- 工具化访问: 将 Firebase 服务操作封装成易于 LLM 调用的工具 (Tools),例如:
- Authentication: 获取用户信息
- Firestore: 文档的增、删、改、查以及集合的列表
- Storage: 文件列表和文件信息获取
- 标准化接口: 遵循 MCP 协议,提供标准化的 JSON-RPC 接口,确保与各种 MCP 客户端的兼容性。
- 灵活部署: 支持通过 npx 运行时安装或本地安装,配置简单,易于集成到现有 LLM 工作流中。
- 安全认证: 通过 Firebase Service Account Key 安全地管理和验证对 Firebase 服务的访问。
安装步骤
-
Firebase 配置
- 访问 Firebase 控制台。
- 进入你的 Firebase 项目,导航至 "项目设置" -> "服务账号"。
- 点击 "生成新的私钥",下载并安全保存 JSON 密钥文件。
-
设置环境变量
- 配置以下环境变量:
- 'SERVICE_ACCOUNT_KEY_PATH': Firebase 服务账号密钥 JSON 文件的绝对路径 (必需)。
- 'FIREBASE_STORAGE_BUCKET': Firebase Storage 存储桶名称 (可选)。如果未提供,默认为 '[projectId].appspot.com'。
- 配置以下环境变量:
-
安装 MCP 服务器
-
将服务器配置添加到你的 MCP 客户端设置文件。不同客户端的配置文件路径可能不同,例如:
- Claude Desktop: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Cursor: '[project root]/.cursor/mcp.json'
- Roo Code (VS Code Extension): '~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json'
- Cline (VS Code Extension): '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'
-
推荐使用 npx 运行时安装,配置示例如下 (将 '/absolute/path/to/serviceAccountKey.json' 替换为你的密钥文件路径,'your-project-id.firebasestorage.app' 替换为你的存储桶名称):
{ "firebase-mcp": { "command": "npx", "args": [ "-y", "@gannonh/firebase-mcp" ], "env": { "SERVICE_ACCOUNT_KEY_PATH": "/absolute/path/to/serviceAccountKey.json", "FIREBASE_STORAGE_BUCKET": "your-project-id.firebasestorage.app" } } }- 本地安装 也是一种选择,首先需要手动克隆仓库、安装依赖和构建项目,然后配置客户端,配置示例如下 (将 '/absolute/path/to/firebase-mcp/dist/index.js' 替换为你的本地仓库路径,密钥文件和存储桶名称同上):
{ "firebase-mcp": { "command": "node", "args": [ "/absolute/path/to/firebase-mcp/dist/index.js" ], "env": { "SERVICE_ACCOUNT_KEY_PATH": "/absolute/path/to/serviceAccountKey.json", "FIREBASE_STORAGE_BUCKET": "your-project-id.firebasestorage.app" } } } -
基本使用方法
- 安装并配置 Firebase MCP Server 后,在你的 LLM 客户端中,你可以通过自然语言指令来调用 Firebase 服务提供的工具。
- 例如,你可以提示 LLM 客户端执行以下操作来测试安装是否成功:
Please run through and test all of your Firebase MCP tools. - 具体可用的工具包括:
- 'auth_get_user': 获取用户信息
- 'firestore_add_document', 'firestore_list_collections', 'firestore_list_documents', 'firestore_get_document', 'firestore_update_document', 'firestore_delete_document': Firestore 数据库操作
- 'storage_list_files', 'storage_get_file_info': Storage 文件存储操作
- 你可以参考仓库 README 文件中 "Features" 部分了解每个工具的具体参数和使用方法。
信息
分类
数据库与文件