Pocketbase MCP

🚀 PocketBase MCP サーバー

PocketBase MCP サーバーは、PocketBase データベースのスキーマ変更を管理するための強力なデータベース移行システムを提供します。このシステムは以下の機能をサポートしています。

1. タイムスタンプの接頭辞と説明的な名前を持つ移行ファイルを作成する
2. 一般的な操作（コレクションの作成、フィールドの追加）の移行ファイルを自動生成する
3. 単一または一括で移行を適用およびロールバックする
4. 適用済みの移行を追跡する

✨ 主な機能

設定コマンド

MCP サーバーで PocketBase 移行システムを使用するために必要な設定コマンドは以下の通りです。

機能コマンド

• setMigrationsDirectory(directory: string) - カスタム移行ディレクトリを設定する
• createNewMigration(name: string) - 新しい空白の移行ファイルを作成する
• createCollectionMigration(collectionSchema: CollectionSchema) - コレクションスキーマに基づいて新しいコレクションを作成する移行ファイルを生成する
• createAddFieldMigration(collectionId: string, field: Field) - 指定されたコレクションにフィールドを追加する移行ファイルを作成する
• applyMigration(filePath: string, pocketbase: PocketBase) - 特定の移行ファイルを適用する
• applyAllMigrations(pocketbase: PocketBase) - すべての未適用の移行ファイルを適用する
• revertMigration(filePath: string, pocketbase: PocketBase) - 指定された移行ファイルをロールバックする
• revertToMigration(targetPathOrId: string | number, pocketbase: PocketBase) - 特定のポイントまで（そのポイントを含まない）ロールバックする
• runCronJob(id: string) - 指定された ID の定期ジョブを実行する
• listCronJobs() - すべての定期ジョブをリストする

使用例

カスタム移行ディレクトリを設定する：

await setMigrationsDirectory("./my_migrations");

基本的な移行を作成する：

await createNewMigration("add_user_email_index");

コレクション移行を作成する：

await createCollectionMigration({
  id: "users",
  name: "users", 
  fields: [
    { name: "email", type: "email", required: true }
  ]
});

コレクションにフィールドを追加する：

await createAddFieldMigration("users", {
  name: "address",
  type: "text"
});

移行を適用する：

// 特定の移行を適用する
await applyMigration("1744005374_update_transactions_add_debt_link.js", pocketbaseInstance);

// すべての未適用の移行を適用する
await applyAllMigrations(pocketbaseInstance);

移行をロールバックする：

// 特定の移行をロールバックする
await revertMigration("1744005374_update_transactions_add_debt_link.js", pocketbaseInstance);

// 特定のポイントまで（そのポイントを含まない）ロールバックする
await revertToMigration("1743958155_update_transactions_add_relation_to_itself.js", pocketbaseInstance);

// すべての移行をロールバックする
await revertToMigration("", pocketbaseInstance);

🔧 技術詳細

移行システム

PocketBase MCP サーバーには、データベーススキーマの変更を管理するための包括的な移行システムが含まれています。このシステムにより、以下のことが可能です。

1. タイムスタンプの接頭辞と説明的な名前を持つ移行ファイルを作成する
2. 一般的な操作（コレクションの作成、フィールドの追加）の移行ファイルを生成する
3. 単一または一括で移行を適用およびロールバックする
4. 適用済みの移行を追跡する

移行ファイルの形式

移行ファイルは、タイムスタンプの接頭辞と説明的な名前を持つ JavaScript ファイルです。

// 1744005374_update_transactions_add_debt_link.js
/// <reference path="../pb_data/types.d.ts" />
migrate((app) => {
  // アップマイグレーションコードはここに記述
  return app.save();
}, (app) => {
  // ダウンマイグレーションコードはここに記述
  return app.save();
});

MCP サーバーのインストール

PocketBase で MCP サーバーを使用するには、以下の手順で設定してください。

1. pocketbase.migrations 設定で MCP を有効にする：

{
  "mcp": {
    "enabled": true,
    "host": "localhost",
    "port": 9001,
    "tls": false,
    "cert": "",
    "key": ""
  }
}

2. MCP サーバーを起動する： コンソールで以下のコマンドを実行します。

node mcp-server.js

📦 依存関係

• @pocketbase/migration-engine - PocketBase 移行エンジン
• @pocketbase/core - PocketBase コアモジュール
• node >=14.0.0 - Node.js のバージョン要件

これらの機能により、PocketBase MCP サーバーはデータベーススキーマ管理に強力で柔軟なツールを提供します。