Pocketbase MCP Server

🚀 Advanced PocketBase MCP Server Documentation

This guide details how to use the Advanced PocketBase MCP (Model Context Protocol) Server for database management and development. PocketBase is a powerful database solution that supports various data operations and management functions.

🚀 Quick Start

📦 Installation

Use the Smithery CLI to quickly install the PocketBase server:

npx -y @smithery/cli install pocketbase-server --client claude

Configuration

Install Dependencies

npm install @pocketbase/core

Initialize the Project

1. Create a pocketbase.config.js file:

module.exports = {
  url: 'http://localhost:3000',
  // Other configuration options...
}

2. Start the service:

node index.js

Development

1. Clone the repository:

git clone https://github.com/your-repository/pocketbase.git

2. Install dependencies:

npm install

3. Copy the configuration file and make adjustments:

cp .env.example .env

4. Build the project:

npm run build

5. Start the service:

npm start

✨ Features

1. Database Operations

• CRUD Operations: Support basic CRUD (Create, Read, Update, Delete) operations.
• Transaction Handling: Support atomic transactions to ensure data consistency.
• Index Management: Allow the creation and management of database indexes to improve query performance.

2. Collection Management

• Collection Lifecycle: Create, modify, and delete database collections (similar to tables in other databases).
• Permission Control: Set read and write permissions for each collection to enhance data security.
• Collection Attributes: Support features such as automatically generated IDs and soft deletes for collections.

3. Data Migration

• Schema Migration: Automatically detect and perform necessary database changes by defining a new schema structure.
• Data Transformation: Specify field transformation rules during migration to ensure data compatibility.

4. User and Authentication

• User Management: Create, read, update, and delete user records.
• Multi-factor Authentication: Support multiple authentication methods, such as passwords and OAuth2.
• Access Tokens: Generate and manage API access tokens to enhance security.

💻 Usage Examples

Basic Usage

Database Operation Tools

// Query all documents
async function findAll() {
  const response = await pocketbase.collection('users').get();
  console.log(response);
}

// Create a new document
async function createDocument() {
  const response = await pocketbase.collection('users').create({
    name: 'John Doe',
    email: 'john@example.com',
    password: 'securepassword'
  });
  console.log(response);
}

Transaction Handling Example

// Use transactions to ensure data consistency
async function transactionExample() {
  const trx = await pocketbase.startTransaction();
  
  // Perform multiple database operations
  await trx.collection('users').create({ name: 'Alice' });
  await trx.collection('logs').create({ action: 'user_created' });

  // Commit the transaction
  await trx.commit();
}

Index Management

// Create an index
async function createIndex() {
  const response = await pocketbase.collection('users').createIndex({
    fields: ['email'],
    unique: true
  });
  console.log(response);
}

// Delete an index
async function deleteIndex() {
  const indexId = 'index_id'; // Replace with the actual index ID
  const response = await pocketbase.collection('users').deleteIndex(indexId);
  console.log(response);
}

📚 Documentation

Best Practices

1. Data Validation: Ensure the legitimacy of input data before performing any database operations.
2. Error Handling: Always use try-catch blocks to capture and handle possible errors.
3. Performance Optimization: Create and manage indexes reasonably to improve query efficiency.
4. Security Measures: Regularly back up the database and ensure the secure storage of user credentials.

Contribution Guidelines

1. Clone the Repository: git clone https://github.com/your-repository/pocketbase.git
2. Create a Feature Branch: Create a separate branch for new features or bug fixes.
3. Submit Changes: After completing code modifications locally, make commits and push them to the remote repository.
4. Submit a Pull Request: Submit a Pull Request to the project maintainers and wait for review and merging.

📄 License

This project is licensed under the MIT License.