Pocketbase

🚀 Advanced Portable - Pocket Server Documentation

This advanced portable Pocket server offers a comprehensive set of features for seamless database management and user authentication.

✨ Features

The Advanced Portable - Pocket Server provides the following features:

• Database Operations: Supports Create, Read, Update, and Delete (CRUD) operations on the PocketBase database.
• Data Migration: Allows migrating the database from an old version to a new one.
• Backup and Restoration: Offers database backup and restoration functionality.
• User Authentication: Supports multiple authentication methods, including password, OAuth2, etc.
• Error Handling: Comes with a built - in comprehensive error handling mechanism.
• Type Safety: Provides TypeScript definitions to ensure the safety of operations.

🛠️ Tool List

Here is a list of all the tools provided by the server and their function descriptions:

1. create_collection - Create a new database collection.
2. read_collection - Read data from a specified collection.
3. update_collection - Update data in a specified collection.
4. delete_collection - Delete data from a specified collection.
5. migrate_collection - Migrate data from an old collection to a new one.
6. backup_database - Back up the entire database to a specified format.
7. restore_database - Restore the database from a backup file.
8. list_auth_methods - List all available authentication methods.
9. authenticate_user - Authenticate a user using a specified method.
10. request_password_reset - Request a password reset for a user.
11. confirm_password_reset - Confirm the password reset for a user.
12. auth_refresh - Refresh a user's authentication token.

📦 Installation

To configure the server, follow these steps:

1. Create an Environment Variable File: Copy .env.example to .env and modify it as needed.
2. Install Dependencies: Run the command npm install.
3. Build the Project: Execute the command npm run build.
4. Start the PocketBase Instance.
5. Automatic Server Connection: After configuration, the server will automatically connect to PocketBase.

💻 Usage Examples

Basic Usage

Create a New Collection

pocket create_collection users

Read Data

pocket read_collection users --query "email=user@example.com"

Update Data

pocket update_collection users --id 123 --data '{"name": "John Doe"}'

Delete Data

pocket delete_collection users --id 123

🔧 Error Handling

All tools include a comprehensive error - handling mechanism and support the following types of errors:

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

Each error comes with a detailed error message and code.

🔒 Type Safety

The server provides TypeScript definitions for all operations, ensuring strict adherence to type rules when using the tools. The input patterns of each tool are subject to strict type checking and validation.

💡 Best Practices

1. Always use try/catch blocks for error handling.
2. Thoroughly validate data before performing operations.
3. Create appropriate indexes for queries to improve performance.
4. Regularly back up the database.
5. Use the migration tool for schema changes.
6. Follow security best practices for user management.
7. Monitor and optimize database performance.

🛠️ Development Guide

1. Clone the Repository: Clone the project repository using Git.
2. Install Dependencies: Run npm install.
3. Copy the Environment File: Copy .env.example to .env.
4. Build the Project: Execute npm run build.
5. Start the PocketBase Instance.
6. Automatic Server Connection: After configuration, the server will automatically connect to PocketBase.

📥 Installation via Smithery

To automatically install the PocketBase server for the Claude desktop via Smithery:

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

🤝 Contribution Guide

1. Create a Branch: Create a new feature branch from the main branch.
2. Commit Changes: Commit your changes to the local repository.
3. Push Code: Push the code to the remote repository.
4. Create a Pull Request: Submit a pull request to merge into the main branch.