Payload MCP

🚀 Payload 負載 MCP

Payload MCP（Model Context Protocol）是連接 AI 助手與 Payload CMS 開發流程的橋樑，提供標準化工具和接口，助力開發者高效完成內容建模、查詢優化和項目搭建等任務。

🚀 快速開始

⚠️ 重要提示

此項目正在開發中，請勿用於生產環境。

項目狀態

安裝指南

先決條件

• Node.js 版本 >= 14.0
• npm 或 yarn 包管理器

安裝步驟

1. 克隆倉庫：

   git clone [倉庫地址]
   cd payload-mcp
   

2. 安裝依賴項：

   npm install
   # 或者
   yarn install
   

3. 啟動開發服務器：

   npm start
   # 或者
   yarn dev
   

快速上手

核心功能

1. 內容建模：自動生成 Payload 集合（Collection）配置文件，簡化數據模型設計流程。
2. 查詢優化：提供即時的 GraphQL 查詢驗證和格式化工具，確保遵循最佳實踐。
3. 項目搭建：一鍵式腳手架工具，快速生成結構完整、配置齊全的 Payload 項目模板。

示例工作流

1. 安裝並啟動 MCP 服務器：

   npm start
   

2. 在你的 AI 助手（如 ChatGPT）中配置 MCP 地址：http://localhost:3001/
3. 要求 AI 生成一個新集合的配置文件。
4. 使用 MCP 的驗證工具檢查生成的代碼是否符合規範。
5. 將通過驗證的配置文件集成到你的 Payload 項目中。

✨ 主要特性

內容建模工具

• 自動生成集合：基於需求描述，快速生成完整的 Payload 集合配置文件。
• 字段類型支持：涵蓋字符串、數字、布爾值、日期、關聯關係（relation）、多選框（select）、富文本（richText）等多種常見字段類型。
• 驗證與優化：提供即時反饋，確保字段配置合理。

查詢優化工具

• GraphQL 查詢生成：根據需求自動生成高效的 GraphQL 查詢語句。
• 查詢格式化：自動對齊和美化查詢代碼，提高可讀性。
• 最佳實踐建議：提供關於分頁、排序、過濾等操作的使用建議。

項目搭建工具

• 一鍵式腳手架：快速生成包含基本配置文件和目錄結構的 Payload 項目模板。
• 環境變量管理：自動創建 .env 文件，並提供常用環境變量示例。
• 開發環境設置：集成常用的開發依賴，如 payload-cli、typescript 和 eslint。

驗證工具

• 配置文件驗證：檢查 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
    }
  }
}

📚 詳細文檔

配置選項

項目元數據

{
  "name": "payload-mcp",
  "version": "0.1.0",
  "description": "AI 輔助的 Payload CMS 開發工具鏈"
}

服務器配置

// config/server.ts
export const serverConfig = {
  port: 3001, // 默認端口
  host: 'localhost', // 監聽地址
  name: 'payload-mcp' // 服務器標識
};

🔧 技術細節

未來發展

• 支持更多字段類型：擴展對複雜字段（如 richText、relationship）的支持。
• 集成機器學習模型：利用 AI 技術優化查詢性能和內容建模流程。
• 提供可視化界面：開發圖形化操作界面，便於開發者與工具交互。

貢獻指南

1. 提交問題或建議到 GitHub 倉庫。
2. 創建功能分支並提交 Pull Request。
3. 遵循項目貢獻規範和代碼風格指南。

支持

• 開發者交流群：加入 Discord 群組
• 郵件支持：聯繫維護者
• 文檔倉庫：查看完整文檔集

📄 許可證

本項目採用 MIT 許可證。

感謝使用 Payload MCP！希望它能為你的開發工作帶來便利和效率提升。