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！希望它能为你的开发工作带来便利和效率提升。