Pocketbase MCP

🚀 PocketBase MCP 服務器

PocketBase MCP 服務器提供了一套強大的數據庫遷移系統，可高效管理 PocketBase 數據庫的模式變更，為數據庫模式管理提供了靈活且強大的工具。

🚀 快速開始

要在 PocketBase 中使用 MCP 服務器，請按照以下步驟配置：

1. 在 pocketbase.migrations 配置中啟用 MCP：

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

2. 啟動 MCP 服務器：

   在控制檯運行：

   node mcp-server.js
   

✨ 主要特性

PocketBase MCP 服務器的數據庫遷移系統支持以下功能：

1. 創建帶有時間戳前綴和描述性名稱的遷移文件
2. 自動生成常見操作（創建集合、添加字段）的遷移文件
3. 單個或批量應用和回滾遷移
4. 跟蹤已應用的遷移

📦 安裝指南

依賴項

• @pocketbase/migration-engine - PocketBase 遷移引擎
• @pocketbase/core - PocketBase 核心模塊
• node >=14.0.0 - Node.js 版本要求

💻 使用示例

基礎用法

功能命令

以下是在 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);

高級用法

遷移文件格式

遷移文件是 JavaScript 文件，帶有時間戳前綴和描述性名稱：

// 1744005374_update_transactions_add_debt_link.js
/// <reference path="../pb_data/types.d.ts" />
migrate((app) => {
  // 上行遷移代碼在這裡
  return app.save();
}, (app) => {
  // 下行遷移代碼在這裡
  return app.save();
});