Payload MCP

🚀 Payload 負荷 MCP

Payload MCP（Model Context Protocol）は、AI アシスタントと Payload CMS の開発プロセスをつなぐ橋渡しとなるツールです。一連の標準化されたツールとインターフェースを提供することで、開発者はコンテンツモデリング、クエリ最適化、プロジェクト構築などのタスクをより効率的に行うことができます。

🚀 クイックスタート

核心機能

1. コンテンツモデリング：Payload コレクション（Collection）の設定ファイルを自動生成することで、データモデルの設計プロセスを簡素化します。
2. クエリ最適化：リアルタイムの GraphQL クエリ検証とフォーマットツールを提供し、ベストプラクティスが遵守されるようにします。
3. プロジェクト構築：ワンクリックで構造が整い、設定が完了した Payload プロジェクトテンプレートを生成するスケルトンツールを提供します。

サンプルワークフロー

1. MCP サーバーをインストールして起動します：

   npm start
   

2. あなたの AI アシスタント（例：ChatGPT）で MCP アドレスを設定します：http://localhost:3001/
3. AI に新しいコレクションの設定ファイルを生成するように依頼します。
4. MCP の検証ツールを使用して、生成されたコードが規格に合致しているかを確認します。
5. 検証を通過した設定ファイルをあなたの Payload プロジェクトに統合します。

✨ 主な機能

1. コンテンツモデリングツール

• 自動コレクション生成：要件記述に基づいて、完全な Payload コレクション設定ファイルを迅速に生成します。
• フィールドタイプサポート：文字列、数値、ブール値、日付、関連関係（relation）、マルチセレクト（select）、リッチテキスト（richText）など、多くの一般的なフィールドタイプをサポートします。
• 検証と最適化：リアルタイムのフィードバックを提供し、フィールド設定の合理性を確保します。

2. クエリ最適化ツール

• GraphQL クエリ生成：要件に基づいて効率的な GraphQL クエリを自動生成します。
• クエリフォーマット：クエリコードを自動的に整列して美化し、可読性を向上させます。
• ベストプラクティス提案：ページネーション、ソート、フィルタリングなどの操作に関する使用提案を提供します。

3. プロジェクト構築ツール

• ワンクリックスケルトン：基本的な設定ファイルとディレクトリ構造を持つ Payload プロジェクトテンプレートを迅速に生成します。
• 環境変数管理：.env ファイルを自動的に作成し、一般的な環境変数の例を提供します。
• 開発環境設定：payload-cli、typescript、eslint などの一般的な開発依存関係を統合します。

4. 検証ツール

• 設定ファイル検証：Payload 設定ファイルの構文と意味的なエラーをチェックします。
• クエリ有効性チェック：GraphQL クエリが予期されるデータモデルに合致していることを確認します。
• コード規範チェック：チームまたはプロジェクトのコード規範に従い、改善提案を提供します。

📦 インストール

前提条件

• Node.js バージョン >= 14.0
• npm または yarn パッケージマネージャー

インストール手順

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

   git clone [リポジトリアドレス]
   cd payload-mcp
   

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

   npm install
   # または
   yarn install
   

3. 開発サーバーを起動します：

   npm start
   # または
   yarn dev
   

💻 使用例

基本的な使用法

例 1：コレクション設定ファイルの生成

// 入力記述：
/*
{
  "name": "Product",
  "description": "管理产品数据",
  "fields": {
    "title": { "type": "string", "required": true },
    "price": { "type": "number", "default": 0 },
    "category": { "type": "select", "options": ["Electronics", "Clothing", "Books"] }
  }
}
*/

// 自動生成されたコレクション設定ファイル：
export interface Product {
  title: string;
  price: number;
  category?: 'Electronics' | 'Clothing' | 'Books';
}

export const productCollection = {
  name: 'products',
  label: 'Product',
  fields: [
    { name: 'title', type: 'string', required: true },
    { name: 'price', type: 'number', default: 0 },
    {
      name: 'category',
      type: 'select',
      options: ['Electronics', 'Clothing', 'Books']
    }
  ]
};

例 2：GraphQL クエリ生成

// 入力クエリ記述：
/*
{
  "operation": "query",
  "description": "获取所有产品及其分类",
  "args": {
    "first": 10,
    "after": null,
    "filter": { "category": "Electronics" }
  }
}
*/

// 自動生成された GraphQL クエリ：
query Products($first: Int!, $after: String, $filter: FilterInput) {
  products(first: $first, after: $after, filter: $filter) {
    edges {
      node {
        title
        price
        category
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

📚 ドキュメント

プロジェクトの状態

将来の開発予定

• より多くのフィールドタイプのサポート：複雑なフィールド（richText、relationship など）へのサポートを拡張します。
• 機械学習モデルの統合：AI 技術を利用して、クエリ性能とコンテンツモデリングプロセスを最適化します。
• 視覚的なインターフェースの提供：開発者がツールと対話しやすいように、グラフィカルな操作インターフェースを開発します。

貢献ガイド

1. 問題や提案を GitHub リポジトリ に提出します。
2. 機能ブランチを作成し、Pull Request を送信します。
3. プロジェクトの貢献規範とコードスタイルガイドに従います。

サポート

• 開発者交流グループ：Discord グループに参加する
• メールサポート：メンテナに連絡する
• ドキュメントリポジトリ：完全なドキュメントセットを表示する

📄 ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。

⚠️ 重要提示

このプロジェクトは現在開発中であり、本番環境での使用は避けてください。

感謝します！Payload MCP を使用していただき、開発作業に役立てていただければ幸いです。