项目简介

Payload MCP（Model Context Protocol）是一个专为Payload CMS开发者设计的后端应用。它基于Model Context Protocol构建，旨在将AI助手集成到Payload CMS的开发流程中，通过标准化的协议提供一系列实用工具。

主要功能点

• 代码生成: 快速生成Payload CMS集合、字段、配置、访问控制、钩子、端点、插件、块、迁移和组件等 boilerplate 代码。
• 验证: 验证Payload CMS组件配置（如集合、字段、访问控制）是否符合最佳实践和语法。
• 脚手架: 协助设置新的Payload CMS项目，包括项目结构和基本配置。
• 专业查询: 提供Payload CMS查询相关的验证、格式化和建议。

安装步骤

1. 确保已安装 Node.js (v16或更高版本) 和 npm (或 Bun)。
2. 通过npm安装该软件包：

   npm install -g @ngyngcphu/payload-mcp
   

MCP服务器配置

该项目作为一个MCP服务器运行。您需要在支持MCP协议的客户端（如Cursor）中配置该服务器。典型的配置信息会告诉客户端如何启动或连接到此服务器。

以下是配置示例中关键参数的说明：

• 'server name': Payload CMS MCP (服务器声明的名称)
• 'command': npx (启动服务器的可执行命令)
• 'args': [@ngyngcphu/payload-mcp] (传递给启动命令的参数，用于指定要运行的软件包)

通过这种配置，您的MCP客户端将知道如何启动 Payload MCP 服务器并在需要时与之通信。服务器默认运行在端口 3001。

基本使用方法

安装并在您的MCP客户端中配置完成后，当您在与AI助手交互并涉及Payload CMS开发任务时，AI客户端会自动利用Payload MCP服务器提供的工具来完成请求。例如：

• 您可以直接向AI助手提问：“生成一个包含标题、内容和状态字段的博客文章集合配置。” AI助手会调用 Payload MCP 的代码生成工具来完成。
• 您可以要求AI助手：“检查我的Payload CMS集合配置是否有误。” AI助手会调用验证工具来分析您的代码。
• 您可以询问AI助手：“我该如何编写一个只允许管理员读取的全局访问控制？” AI助手可以利用查询或访问控制生成工具来提供帮助。

总而言之，您无需直接与服务器交互，AI助手会作为中间层，利用Payload MCP提供的能力来增强其对Payload CMS相关任务的处理能力。