@gannonh/firebase-mcp

中文文档
1.4.9发布于 2025/05/11MITTypeScriptES Module近 30 天下载 6476

Firebase MCP server for interacting with Firebase services through the Model Context Protocol

原始使用文档
文档目录29 节
  1. Overview
  2. ⚡ Quick Start
  3. Prerequisites
  4. 1. Install MCP Server
  5. 2. Test the Installation
  6. 🛠️ Setup & Configuration
  7. 1. Firebase Configuration
  8. 2. Environment Variables
  9. 3. Client Integration
  10. 📚 API Reference
  11. Firestore Tools
  12. Storage Tools
  13. Authentication Tools
  14. 💻 Developer Guide
  15. Installation & Building
  16. Running Tests
  17. Project Structure
  18. 🌐 HTTP Transport
  19. Running with HTTP Transport
  20. Client Configuration for HTTP
  21. Session Management
  22. 🔍 Troubleshooting
  23. Common Issues
  24. Debugging
  25. 📋 Response Formatting
  26. Storage Upload Response Example
  27. 🤝 Contributing
  28. 📄 License
  29. 🔗 Related Resources

Firebase MCP

Project Logo

Firebase MCP server

Firebase Tests CI

Overview

Firebase MCP enables AI assistants to work directly with Firebase services, including:

  • Firestore: Document database operations
  • Storage: File management with robust upload capabilities
  • Authentication: User management and verification

The server works with MCP client applicatios such as Claude Desktop, Augment Code, VS Code, and Cursor.

⚠️ Known Issue: The firestore_list_collections tool may return a Zod validation error in the client logs. This is an erroneous validation error in the MCP SDK, as our investigation confirmed no boolean values are present in the response. Despite the error message, the query still works correctly and returns the proper collection data. This is a log-level error that doesn't affect functionality.

⚡ Quick Start

Prerequisites

  • Firebase project with service account credentials
  • Node.js environment

1. Install MCP Server

Add the server configuration to your MCP settings file:

  • Claude Desktop: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Augment: ~/Library/Application Support/Code/User/settings.json
  • Cursor: [project root]/.cursor/mcp.json

MCP Servers can be installed manually or at runtime via npx (recommended). How you install determines your configuration:

{
  "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"
    }
  }
}

Configure for local installation

{
  "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"
    }
  }
}

2. Test the Installation

Ask your AI client: "Please test all Firebase MCP tools."

🛠️ Setup & Configuration

1. Firebase Configuration

  1. Go to Firebase Console → Project Settings → Service Accounts
  2. Click "Generate new private key"
  3. Save the JSON file securely

2. Environment Variables

Required

  • SERVICE_ACCOUNT_KEY_PATH: Path to your Firebase service account key JSON (required)

Optional

  • FIREBASE_STORAGE_BUCKET: Bucket name for Firebase Storage (defaults to [projectId].appspot.com)
  • MCP_TRANSPORT: Transport type to use (stdio or http) (defaults to stdio)
  • MCP_HTTP_PORT: Port for HTTP transport (defaults to 3000)
  • MCP_HTTP_HOST: Host for HTTP transport (defaults to localhost)
  • MCP_HTTP_PATH: Path for HTTP transport (defaults to /mcp)
  • DEBUG_LOG_FILE: Enable file logging:
    • Set to true to log to ~/.firebase-mcp/debug.log
    • Set to a file path to log to a custom location

3. Client Integration

Claude Desktop

Edit: ~/Library/Application Support/Claude/claude_desktop_config.json

VS Code / Augment

Edit: ~/Library/Application Support/Code/User/settings.json

Cursor

Edit: [project root]/.cursor/mcp.json

📚 API Reference

Firestore Tools

ToolDescriptionRequired Parameters
firestore_add_documentAdd a document to a collectioncollection, data
firestore_list_documentsList documents with filteringcollection
firestore_get_documentGet a specific documentcollection, id
firestore_update_documentUpdate an existing documentcollection, id, data
firestore_delete_documentDelete a documentcollection, id
firestore_list_collectionsList root collectionsNone
firestore_query_collection_groupQuery across subcollectionscollectionId

Storage Tools

ToolDescriptionRequired Parameters
storage_list_filesList files in a directoryNone (optional: directoryPath)
storage_get_file_infoGet file metadata and URLfilePath
storage_uploadUpload file from contentfilePath, content
storage_upload_from_urlUpload file from URLfilePath, url

Authentication Tools

ToolDescriptionRequired Parameters
auth_get_userGet user by ID or emailidentifier

💻 Developer Guide

Installation & Building

git clone https://github.com/gannonh/firebase-mcp
cd firebase-mcp
npm install
npm run build

Running Tests

First, install and start Firebase emulators:

npm install -g firebase-tools
firebase init emulators
firebase emulators:start

Then run tests:

# Run tests with emulator
npm run test:emulator

# Run tests with coverage
npm run test:coverage:emulator

Project Structure

src/
├── index.ts                  # Server entry point
├── utils/                    # Utility functions
└── lib/
    └── firebase/              # Firebase service clients
        ├── authClient.ts     # Authentication operations
        ├── firebaseConfig.ts   # Firebase configuration
        ├── firestoreClient.ts # Firestore operations
        └── storageClient.ts  # Storage operations

🌐 HTTP Transport

Firebase MCP now supports HTTP transport in addition to the default stdio transport. This allows you to run the server as a standalone HTTP service that can be accessed by multiple clients.

Running with HTTP Transport

To run the server with HTTP transport:

# Using environment variables
MCP_TRANSPORT=http MCP_HTTP_PORT=3000 node dist/index.js

# Or with npx
MCP_TRANSPORT=http MCP_HTTP_PORT=3000 npx @gannonh/firebase-mcp

Client Configuration for HTTP

When using HTTP transport, configure your MCP client to connect to the HTTP endpoint:

{
  "firebase-mcp": {
    "url": "http://localhost:3000/mcp"
  }
}

Session Management

The HTTP transport supports session management, allowing multiple clients to connect to the same server instance. Each client receives a unique session ID that is used to maintain state between requests.

🔍 Troubleshooting

Common Issues

Storage Bucket Not Found

If you see "The specified bucket does not exist" error:

  1. Verify your bucket name in Firebase Console → Storage
  2. Set the correct bucket name in FIREBASE_STORAGE_BUCKET environment variable

Firebase Initialization Failed

If you see "Firebase is not initialized" error:

  1. Check that your service account key path is correct and absolute
  2. Ensure the service account has proper permissions for Firebase services

Composite Index Required

If you receive "This query requires a composite index" error:

  1. Look for the provided URL in the error message
  2. Follow the link to create the required index in Firebase Console
  3. Retry your query after the index is created (may take a few minutes)

Zod Validation Error with firestore_list_collections

If you see a Zod validation error with message "Expected object, received boolean" when using the firestore_list_collections tool:

⚠️ Known Issue: The firestore_list_collections tool may return a Zod validation error in the client logs. This is an erroneous validation error in the MCP SDK, as our investigation confirmed no boolean values are present in the response. Despite the error message, the query still works correctly and returns the proper collection data. This is a log-level error that doesn't affect functionality.

Debugging

Enable File Logging

To help diagnose issues, you can enable file logging:

# Log to default location (~/.firebase-mcp/debug.log)
DEBUG_LOG_FILE=true npx @gannonh/firebase-mcp

# Log to a custom location
DEBUG_LOG_FILE=/path/to/custom/debug.log npx @gannonh/firebase-mcp

You can also enable logging in your MCP client configuration:

{
  "firebase-mcp": {
    "command": "npx",
    "args": ["-y", "@gannonh/firebase-mcp"],
    "env": {
      "SERVICE_ACCOUNT_KEY_PATH": "/path/to/serviceAccountKey.json",
      "FIREBASE_STORAGE_BUCKET": "your-project-id.firebasestorage.app",
      "DEBUG_LOG_FILE": "true"
    }
  }
}

Real-time Log Viewing

To view logs in real-time:

# Using tail to follow the log file
tail -f ~/.firebase-mcp/debug.log

# Using a split terminal to capture stderr
npm start 2>&1 | tee logs.txt

Using MCP Inspector

The MCP Inspector provides interactive debugging:

# Install MCP Inspector
npm install -g @mcp/inspector

# Connect to your MCP server
mcp-inspector --connect stdio --command "node ./dist/index.js"

📋 Response Formatting

Storage Upload Response Example

{
  "name": "reports/quarterly.pdf",
  "size": "1024000",
  "contentType": "application/pdf",
  "updated": "2025-04-11T15:37:10.290Z",
  "downloadUrl": "https://storage.googleapis.com/bucket/reports/quarterly.pdf?alt=media",
  "bucket": "your-project.appspot.com"
}

Displayed to the user as:

## File Successfully Uploaded! 📁

Your file has been uploaded to Firebase Storage:

**File Details:**
- **Name:** reports/quarterly.pdf
- **Size:** 1024000 bytes
- **Type:** application/pdf
- **Last Updated:** April 11, 2025 at 15:37:10 UTC

**[Click here to download your file](https://storage.googleapis.com/bucket/reports/quarterly.pdf?alt=media)**

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Implement changes with tests (80%+ coverage required)
  4. Submit a pull request

📄 License

MIT License - see LICENSE file for details

版本与发布记录

@gannonh/firebase-mcp 共发布 18 个版本,首次发布于 2025/03/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.4.9latest2025/05/111.5 年前
1.4.82025/05/101.5 年前
1.4.72025/05/101.5 年前
1.4.62025/05/091.5 年前
1.4.52025/05/091.5 年前
1.4.42025/05/091.5 年前

关于 @gannonh/firebase-mcp 的常见问题

@gannonh/firebase-mcp 是什么?

Firebase MCP server for interacting with Firebase services through the Model Context Protocol

如何安装 @gannonh/firebase-mcp?

在项目目录运行 npm install @gannonh/firebase-mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 firebase-mcp,可以用 npx firebase-mcp 直接运行。

@gannonh/firebase-mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gannonh/firebase-mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gannonh/firebase-mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gannonh/firebase-mcp 可以商用吗?

@gannonh/firebase-mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gannonh/firebase-mcp 的下载量有多少?

根据 npm 官方下载统计,@gannonh/firebase-mcp 在 2026/10/16 – 2026/11/14 这 30 天内被下载 6,476 次,日均约 216 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gannonh/firebase-mcp 还在维护吗?

最新版本 1.4.9 发布于 2025/05/11(1.5 年前);至今共发布 18 个版本,其中过去 12 个月发布了 0 个;首次发布于 2025/03/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。