Pocketbase MCP

🚀 PocketBase MCP Server

PocketBase MCP Server offers a powerful database migration system for managing schema changes in PocketBase databases.

🚀 Quick Start

PocketBase MCP Server provides a robust database migration system to handle schema changes in PocketBase databases. The system supports the following features:

1. Create migration files with timestamp prefixes and descriptive names.
2. Automatically generate migration files for common operations (e.g., creating collections, adding fields).
3. Apply and revert migrations individually or in batches.
4. Track applied migrations.

Configuration Commands

The following are the configuration commands required to use the PocketBase migration system in the MCP server:

Functional Commands

• setMigrationsDirectory(directory: string) - Set a custom migration directory.
• createNewMigration(name: string) - Create a new blank migration file.
• createCollectionMigration(collectionSchema: CollectionSchema) - Generate a migration file to create a new collection based on the collection schema.
• createAddFieldMigration(collectionId: string, field: Field) - Generate a migration file to add a field to a specified collection.
• applyMigration(filePath: string, pocketbase: PocketBase) - Apply a specific migration file.
• applyAllMigrations(pocketbase: PocketBase) - Apply all unapplied migration files.
• revertMigration(filePath: string, pocketbase: PocketBase) - Revert a specified migration file.
• revertToMigration(targetPathOrId: string | number, pocketbase: PocketBase) - Revert to a specific point (excluding that point).
• runCronJob(id: string) - Run a scheduled task with a specified ID.
• listCronJobs() - List all scheduled tasks.

Usage Examples

Set a custom migration directory:

await setMigrationsDirectory("./my_migrations");

Create a basic migration:

await createNewMigration("add_user_email_index");

Create a collection migration:

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

Add a field to a collection:

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

Apply migrations:

// Apply a specific migration
await applyMigration("1744005374_update_transactions_add_debt_link.js", pocketbaseInstance);

// Apply all pending migrations
await applyAllMigrations(pocketbaseInstance);

Revert migrations:

// Revert a specific migration
await revertMigration("1744005374_update_transactions_add_debt_link.js", pocketbaseInstance);

// Revert to a specific point (excluding that point)
await revertToMigration("1743958155_update_transactions_add_relation_to_itself.js", pocketbaseInstance);

// Revert all migrations
await revertToMigration("", pocketbaseInstance);

✨ Features

Migration System

The PocketBase MCP Server includes a comprehensive migration system for managing database schema changes. This system allows you to:

1. Create migration files with timestamp prefixes and descriptive names.
2. Generate migration files for common operations (e.g., creating collections, adding fields).
3. Apply and revert migrations individually or in batches.
4. Track applied migrations.

Migration File Format

Migration files are JavaScript files with timestamp prefixes and descriptive names:

// 1744005374_update_transactions_add_debt_link.js
/// <reference path="../pb_data/types.d.ts" />
migrate((app) => {
  // Upward migration code goes here
  return app.save();
}, (app) => {
  // Downward migration code goes here
  return app.save();
});

MCP Server Installation

To use the MCP server in PocketBase, follow these configuration steps:

1. Enable MCP in the pocketbase.migrations configuration:

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

2. Start the MCP server:

   Run the following command in the console:

   node mcp-server.js
   

📦 Installation

Dependencies

• @pocketbase/migration-engine - PocketBase migration engine
• @pocketbase/core - PocketBase core module
• node >=14.0.0 - Node.js version requirement

With these features, the PocketBase MCP Server provides a powerful and flexible tool for database schema management.