🚀 Payload CMS 3.0 MCP Server

📋 基本能力

产品定位

Payload CMS 3.0 MCP Server 是一个专为 Payload CMS 开发设计的工具，旨在通过自动化代码生成、验证和项目脚手架来提升开发效率和代码质量。

核心功能

1. 代码验证：验证 Payload CMS 的集合、字段、全局和配置文件，提供详细的语法错误和最佳实践反馈。
2. 代码生成：生成集合、字段、全局、访问控制、钩子、端点、插件、块和迁移的代码模板。
3. 项目脚手架：创建完整的 Payload CMS 项目结构，确保一致性和最佳实践。

适用场景

• 快速生成 Payload CMS 项目的初始结构。
• 验证现有代码是否符合最佳实践。
• 自动化生成常见的代码模板，减少重复劳动。

工具列表

1. 验证工具：
2. validate：验证代码的语法和最佳实践。
3. query：查询验证规则和最佳实践。
4. mcp_query：执行 SQL-like 查询以获取 Payload CMS 结构信息。
5. 代码生成工具：
6. generate_template：生成各种组件的代码模板。
7. generate_collection：创建完整的集合定义。
8. generate_field：生成字段定义。
9. 项目设置工具：
10. scaffold_project：创建完整的 Payload CMS 项目结构。
11. validate_scaffold_options：验证脚手架选项是否符合最佳实践。

常见问题解答

• 如何验证代码：使用 validate 工具并提供代码和文件类型。
• 如何生成模板：使用 generate_template 工具并指定模板类型和选项。
• 如何创建项目：使用 scaffold_project 工具并提供项目名称和其他配置。

🚀 使用教程

使用依赖

1. 安装 Node.js 18+。
2. 创建一个 Railway 账户并获取 API 令牌。

安装教程

1. 全局安装： bash npm install -g payload-cms-mcp payload-cms-mcp
2. 从仓库克隆： bash git clone https://github.com/Matmax-Worldwide/payloadcmsmcp.git cd payloadcmsmcp npm install npm run dev

调试方式

1. 运行本地服务器： bash npm run dev
2. 使用 Cursor IDE 配置 MCP 服务器：
3. 在 Cursor 设置中添加 MCP 服务器。
4. 设置命令为 railway run --service=YOUR_SERVICE_ID。

📄 详细工具参考

验证工具

• validate：验证代码的语法和最佳实践。
• query：查询验证规则和最佳实践。
• mcp_query：执行 SQL-like 查询以获取 Payload CMS 结构信息。

代码生成工具

• generate_template：生成各种组件的代码模板。
• generate_collection：创建完整的集合定义。
• generate_field：生成字段定义。

项目设置工具

• scaffold_project：创建完整的 Payload CMS 项目结构。
• validate_scaffold_options：验证脚手架选项是否符合最佳实践。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。