Advanced Pocketbase MCP Server

🚀 Advanced PocketBase MCP Server

Advanced PocketBase MCP Server is a powerful tool that allows developers to deeply interact with PocketBase databases through the Model Context Protocol (MCP). It offers comprehensive features such as data management, user authentication, database backup, and migration.

🚀 Quick Start

The Advanced PocketBase MCP Server provides a wide range of features for in - depth interaction with PocketBase databases. To get started, you need to configure the server through the .env file and install the necessary dependencies.

✨ Features

Database Operations

• Query: Supports complex database queries.
• Insert/Update: Can add or modify records in the database.
• Delete: Can safely delete unwanted data.
• Transaction Handling: Supports atomic transactions to ensure data consistency.

User Authentication

• Password Authentication: Authenticates users via username and password.
• OAuth2 Integration: Supports integration with major OAuth2 providers (e.g., Google, GitHub).
• Password Reset: Allows users to reset their passwords via email.

Database Management

• Backup: Supports exporting the database in JSON or CSV format.
• Restore: Can restore data from backup files.
• Index Management: Can create, delete, and update database indexes to optimize query performance.

💻 Usage Examples

Basic Usage

// Query all users
const users = await mcp.query('users').all();

// Insert a new user
await mcp.query('users').insert({
  name: 'New User',
  email: 'new@example.com'
});

Authentication Examples

// Password authentication
const token = await mcp.authenticate('user@example.com', 'securepassword');

// OAuth2 authentication
const token = await mcp.oauth2Authenticate('google', {
  code: 'auth_code',
  redirectUrl: 'https://your-app.com/callback'
});

Backup and Restoration

// Create a backup
await mcp.backupDatabase();

// Restore a backup
await mcp.restoreDatabase('backup.json');

Query Tool

// Query a user
await mcp.query('users').where({ 
  email: 'user@example.com' 
}).first();

// Insert a new user
await mcp.query('users').insert({
  name: 'John Doe',
  email: 'john@example.com',
  password: 'securepassword'
});

// Update user information
await mcp.query('users').where({ 
  id: '123' 
}).update({
  name: 'Jane Doe',
  email: 'jane@example.com'
});

Backup Tool

// Create a backup
await mcp.backup('my-database-backup.json');

// Restore a backup
await mcp.restore('my-database-backup.json');

Index Management Tool

// Create an index
await mcp.index('users').create({
  fields: ['email'],
  name: 'unique_email'
});

// Delete an index
await mcp.index('users').delete('unique_email');

📚 Documentation

• Official Documentation
• Example Code Repository

🔧 Technical Details

Configuration

Configure the PocketBase MCP Server through the .env file:

POCKETBASE_API_KEY=your_api_key_here
POCKETBASE_DB_NAME=default
POCKETBASE_HOST=localhost
POCKETBASE_PORT=8096

Error Handling

All tools include a detailed error - handling mechanism that can capture and report the following types of errors:

• Incorrect request format
• Authentication failure
• Database operation exceptions
• Data validation failure
• Network connection issues

Type Safety

Through strict type checking and validation, it ensures the data integrity of all operations. Each tool defines the type signature of the input to prevent type - mismatch issues.

Best Practices

1. Error Handling: Always use try/catch blocks to handle potential errors.
2. Data Validation: Validate data before performing any database operations.
3. Index Optimization: Create appropriate indexes according to query requirements to improve performance.
4. Regular Backups: Frequently back up the database to prevent data loss.
5. Use Migrations: Manage database schema changes through migrations.
6. Security Measures: Follow security best practices for user authentication.
7. Performance Monitoring: Continuously monitor and optimize database performance.

Development

1. Clone the repository: git clone git@github.com:your-repository.git
2. Install dependencies: npm install
3. Copy .env.example to .env and configure it.
4. Build the project: npm run build
5. Start the PocketBase instance.
6. The MCP server will automatically connect to your PocketBase instance.

Installation via Smith

npm install @your-package-name/mcp

Usage via Smith

const mcp = new MCPPocketBase({
  key: 'your_api_key',
  host: 'localhost',
  port: 8096
});