Scaffold entire Payload CMS projects with validated options for consistency and adherence to best practices.

## 🔧 Payload CMS 3.0 Capabilities ### Validation Tools * `validate` - Validate code for collections, fields, globals, and config * `query` - Query validation rules and best practices * `mcp_query` - Execute SQL-like queries for Payload CMS structures ### Code Generation * `generate_template` - Generate code templates for various components * `generate_collection` - Create complete collection definitions * `generate_field` - Generate field definitions with proper typing ### Project Setup * `scaffold_project` - Create entire Payload CMS project structures * `validate_scaffold_options` - Ensure scaffold options follow best practices (used internally by scaffold_project)

## 📝 Detailed Tool Reference ### Validation Tools #### `validate` Validates Payload CMS code for syntax and best practices. **Parameters:** - `code` (string): The code to validate - `fileType` (enum): Type of file - "collection", "field", "global", or "config" **Example Prompt:** ``` Can you validate this Payload CMS collection code? ```typescript export const Posts = { slug: 'posts', fields: [ { name: 'title', type: 'text', required: true, }, { name: 'content', type: 'richText', } ], admin: { useAsTitle: 'title', } } ``` #### `query` Queries validation rules and best practices for Payload CMS. **Parameters:** - `query` (string): The query string - `fileType` (optional enum): Type of file - "collection", "field", "global", or "config" **Example Prompt:** ``` What are the best practices for implementing access control in Payload CMS collections? ``` #### `mcp_query` Executes SQL-like queries against Payload CMS structures. **Parameters:** - `sql` (string): SQL-like query string **Example Prompt:** ``` Can you execute this query to find all valid field types in Payload CMS? SELECT field_types FROM payload_schema WHERE version = '3.0' ``` ### Code Generation #### `generate_template` Generates code templates for various Payload CMS components. **Parameters:** - `templateType` (enum): Type of template - "collection", "field", "global", "config", "access-control", "hook", "endpoint", "plugin", "block", "migration" - `options` (record): Configuration options for the template **Example Prompt:** ``` Generate a template for a Payload CMS hook that logs when a document is created. ``` #### `generate_collection` Generates a complete Payload CMS collection definition. **Parameters:** - `slug` (string): Collection slug - `fields` (optional array): Array of field objects - `auth` (optional boolean): Whether this is an auth collection - `timestamps` (optional boolean): Whether to include timestamps - `admin` (optional object): Admin panel configuration - `hooks` (optional boolean): Whether to include hooks - `access` (optional boolean): Whether to include access control - `versions` (optional boolean): Whether to enable versioning **Example Prompt:** ``` Generate a Payload CMS collection for a blog with title, content, author, and published date fields. Include timestamps and versioning. ``` #### `generate_field` Generates a Payload CMS field definition. **Parameters:** - `name` (string): Field name - `type` (string): Field type - `required` (optional boolean): Whether the field is required - `unique` (optional boolean): Whether the field should be unique - `localized` (optional boolean): Whether the field should be localized - `access` (optional boolean): Whether to include access control - `admin` (optional object): Admin panel configuration - `validation` (optional boolean): Whether to include validation - `defaultValue` (optional any): Default value for the field **Example Prompt:** ``` Generate a Payload CMS image field with validation that requires alt text and has a description in the admin panel. ``` ### Project Setup #### `scaffold_project` Scaffolds a complete Payload CMS project structure. **Param

🚀 Payload CMS 3.0 MCP Server

Comments