Firebase MCP

🚀 Firebase MCP プロトコルガイド

Firebase MCP（Model Context Protocol）は、開発者がモデルコンテキストプロトコルを通じてFirebaseサービスとやり取りすることを可能にします。これには、認証、Firestoreデータベース、およびクラウドストレージが含まれます。このドキュメントでは、Firebase MCPのインストール、設定、および使用方法について詳しく説明します。

🚀 クイックスタート

📦 インストール

Firebase MCPを使用するには、以下の手順に従ってください。

1. Node.jsのダウンロードとインストール：LTSバージョンのNode.jsがインストールされていることを確認してください。
2. Firebaseツールのインストール：

   npm install -g firebase-tools
   

3. Firebaseプロジェクトの初期化：

   firebase init
   

🔧 設定

環境変数

src/index.ts ファイルに以下の環境変数を追加します。

import { config } from 'dotenv';

config({
  serviceAccountKeyPath: './path/to/service-account.json',
  projectId: 'your-project-id',
  storageBucket: 'your-storage-bucket.appspot.com'
});

💻 使用例

基本的な使用法

認証

ユーザーの作成

auth.createUser ツールを使用して新しいユーザーを作成します。

{
  "tool": "auth.createUser",
  "params": {
    "email": "user@example.com",
    "password": "secure-password"
  }
}

ユーザーのログイン

auth.signInUser ツールを使用してユーザーをログインさせます。

{
  "tool": "auth.signInUser",
  "params": {
    "email": "user@example.com",
    "password": "secure-password"
  }
}

Firestoreデータベース

ドキュメントの追加

指定されたコレクションに新しいドキュメントを追加します。

{
  "tool": "firestore.addDoc",
  "params": {
    "collectionPath": "users",
    "data": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}

データのクエリ

条件に基づいてコレクション内のドキュメントをクエリします。

{
  "tool": "firestore.queryCollection",
  "params": {
    "collectionPath": "users",
    "filters": [
      {
        "field": "name",
        "operator": "==",
        "value": "John Doe"
      }
    ]
  }
}

クラウドストレージ

ファイルのアップロード

指定されたディレクトリにファイルをアップロードします。

{
  "tool": "storage.uploadFile",
  "params": {
    "filePath": "uploads/profile.jpg",
    "data": "base64-encoded-string"
  }
}

ファイル情報の取得

特定のファイルのメタデータとダウンロードリンクを取得します。

{
  "tool": "storage.getFileInfo",
  "params": {
    "filePath": "uploads/profile.jpg"
  }
}

📚 ドキュメント

開発情報

モジュールエクスポート

src/index.ts ファイルで以下のモジュールをエクスポートします。

export const config = require('dotenv').config();
export { default as auth } from './auth';
export { default as firestore } from './firestore';
export { default as storage } from './storage';

インターフェース定義

認証インターフェース

interface AuthConfig {
  serviceAccountKeyPath: string;
  projectId: string;
}

interface CreateUserParams {
  email: string;
  password: string;
}

Firestoreインターフェース

interface FirestoreConfig extends AuthConfig {
  storageBucket: string;
}

interface FirestoreDoc<T> {
  id?: string;
  data: T;
}

テスト説明

テスト環境の初期化

プロジェクトのルートディレクトリに testing.json ファイルを作成します。

{
  "serviceAccountKeyPath": "./test/service-account.json",
  "projectId": "test-project-id",
  "storageBucket": "test-storage-bucket.appspot.com"
}

テストの実行

以下のコマンドを使用してテストを実行します。

npm test

アーキテクチャ

コアモジュール

• Auth Module：認証関連の操作を処理します。
• Firestore Module：データベースのやり取りを管理します。
• Storage Module：クラウドストレージの操作を担当します。

インターフェース設計

• Auth Interface：

  • createUser(params: CreateUserParams)
  • signInUser(params: SignInUserParams)

• Firestore Interface：

  • addDoc(collectionPath: string, doc: FirestoreDoc<any>)
  • queryCollection(collectionPath: string, filters: Filter[])

貢献ガイド

コードの提出

以下のコマンドを使用して変更を提出します。

git add .
git commit -m "添加新功能"
git push origin main

許可協定

このプロジェクトはMITライセンスに従います。詳細は LICENSE ファイルを参照してください。

トラブルシューティング

一般的な問題

1. Firebaseの初期化に失敗しました

• 原因：サービスアカウントキーのパスが正しくありません。
• 解決策：serviceAccountKeyPath が正しいJSONファイルを指していることを確認してください。

2. データベースクエリに結果がありません

• 原因：コレクションパスまたはフィルタ条件が間違っています。
• 解決策：コレクションパスとフィルタ条件が正しいことを確認してください。

連絡先

問題がある場合は、サポートチームに連絡してください。

firebase support contact

Firebase MCPプロトコルをご利用いただき、ありがとうございます！さらなる支援が必要な場合は、Firebase公式ドキュメント を参照してください。