Pocketbase MCP Server

🚀 高度なPocketBase MCPサーバードキュメント

本ガイドでは、高度なPocketBase MCP（モデルコンテキストプロトコル）サーバーを使用してデータベースを管理および開発する方法について詳しく説明します。PocketBaseは、様々なデータ操作と管理機能をサポートする強力なデータベースソリューションです。

✨ 主な機能

1. データベース操作

• CRUD操作：基本的なCRUD（作成、読み取り、更新、削除）操作をサポートします。
• トランザクション処理：原子性トランザクションをサポートし、データの一貫性を保証します。
• インデックス管理：データベースインデックスの作成と管理を許可し、クエリ性能を向上させます。

2. コレクション管理

• コレクションのライフサイクル：データベースコレクション（他のデータベースのテーブルに相当）の作成、変更、および削除を行います。
• 権限制御：各コレクションに読み取りおよび書き込み権限を設定し、データの安全性を強化します。
• コレクション属性：コレクションの自動生成ID、ソフト削除などの機能を設定できます。

3. データ移行

• スキーマ移行：新しいスキーマ構造を定義することで、必要なデータベース変更を自動的に検出して実行します。
• データ変換：移行中にフィールドの変換ルールを指定でき、データの互換性を確保します。

4. ユーザーと認証

• ユーザー管理：ユーザーレコードの作成、読み取り、更新、および削除を行います。
• 多要素認証：パスワード、OAuth2などの複数の認証方法をサポートします。
• アクセストークン：APIアクセストークンの生成と管理を行い、安全性を強化します。

💻 使用例

基本的な使用法

1. データベース操作ツール

// すべてのドキュメントを取得
async function findAll() {
  const response = await pocketbase.collection('users').get();
  console.log(response);
}

// 新しいドキュメントを作成
async function createDocument() {
  const response = await pocketbase.collection('users').create({
    name: 'John Doe',
    email: 'john@example.com',
    password: 'securepassword'
  });
  console.log(response);
}

2. トランザクション処理の例

// トランザクションを使用してデータの一貫性を保証
async function transactionExample() {
  const trx = await pocketbase.startTransaction();
  
  // 複数のデータベース操作を実行
  await trx.collection('users').create({ name: 'Alice' });
  await trx.collection('logs').create({ action: 'user_created' });

  // トランザクションをコミット
  await trx.commit();
}

3. インデックス管理

// インデックスを作成
async function createIndex() {
  const response = await pocketbase.collection('users').createIndex({
    fields: ['email'],
    unique: true
  });
  console.log(response);
}

// インデックスを削除
async function deleteIndex() {
  const indexId = 'index_id'; // 実際のインデックスIDに置き換える
  const response = await pocketbase.collection('users').deleteIndex(indexId);
  console.log(response);
}

📦 インストール

依存関係のインストール

npm install @pocketbase/core

プロジェクトの初期化

1. pocketbase.config.jsファイルを作成します：

module.exports = {
  url: 'http://localhost:3000',
  // その他の設定オプション...
}

2. サービスを起動します：

node index.js

Smithery CLIを使用したPocketBaseサーバーのインストール

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

💡 使用アドバイス

1. データ検証：データベース操作を行う前に、入力データの合法性を確認してください。
2. エラー処理：常にtry-catchブロックを使用して、発生する可能性のあるエラーをキャッチして処理してください。
3. パフォーマンス最適化：クエリ効率を向上させるために、適切にインデックスを作成および管理してください。
4. セキュリティ対策：定期的にデータベースをバックアップし、ユーザーの資格情報を安全に保管してください。

開発手順

1. リポジトリをクローンします：

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

2. 依存関係をインストールします：

npm install

3. 設定ファイルをコピーして調整します：

cp .env.example .env

4. プロジェクトをビルドします：

npm run build

5. サービスを起動します：

npm start

貢献ガイド

1. リポジトリをクローン：git clone https://github.com/your-repository/pocketbase.git
2. 機能ブランチを作成：新しい機能または修正のために独立したブランチを作成します。
3. 変更をコミット：ローカルでコードの変更を完了したら、コミットしてリモートリポジトリにプッシュします。
4. プルリクエストを提出：プロジェクトメンテナにPull Requestを提出し、レビューとマージを待ちます。

📄 ライセンス

本プロジェクトはMIT Licenseに従います。