🚀 Payload CMS 3.0 MCP Server

<div align="center"> <p align="center"> <img src="https://www.payloadcmsmcp.info/logopayload.png" alt="Payload CMS Logo" width="120" height="120" style="border-radius: 10px; padding: 5px; background-color: white; box-shadow: 0 3px 10px rgba(0, 0, 0, 0.25);" /> </p> <p align="center"> <img src="https://img.shields.io/badge/Model%20Context%20Protocol-Enabled-6366F1?style=for-the-badge" alt="MCP Enabled" /> <img src="https://img.shields.io/badge/Payload%20CMS%203.0-Integration-3B82F6?style=for-the-badge" alt="Payload CMS" /> <img src="https://img.shields.io/badge/License-MIT-10B981?style=for-the-badge" alt="License" /> <img src="https://img.shields.io/badge/Railway-Deployment-0B0D0E?style=for-the-badge" alt="Railway Deployment" /> </p> <h3>A specialized MCP server for Payload CMS 3.0</h3> <p>Validate code, generate templates, and scaffold projects following best practices</p> </div> <hr>

📋 Overview

The Payload CMS 3.0 MCP Server is a specialized Model Context Protocol server designed to enhance your Payload CMS development experience. It helps developers build better Payload CMS applications by providing code validation, template generation, and project scaffolding capabilities that follow best practices.

<hr>

✨ Features

<div align="center"> <table> <tr> <td align="center"> <h3>📚</h3> <b>Code Validation</b> <p>Validate Payload CMS code for collections, fields, globals, and config files with detailed feedback on syntax errors and best practices.</p> </td> <td align="center"> <h3>🔍</h3> <b>Code Generation</b> <p>Generate code templates for collections, fields, globals, access control, hooks, endpoints, plugins, blocks, and migrations.</p> </td> <td align="center"> <h3>🚀</h3> <b>Project Scaffolding</b> <p>Scaffold entire Payload CMS projects with validated options for consistency and adherence to best practices.</p> </td> </tr> </table> </div> <hr>

🔧 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)

<hr>

📝 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.

Parameters:

• projectName (string): Name of the project
• description (optional string): Project description
• serverUrl (optional string): Server URL
• database (optional enum): Database type - "mongodb" or "postgres"
• auth (optional boolean): Whether to include authentication
• admin (optional object): Admin panel configuration
• collections (optional array): Array of collection objects
• globals (optional array): Array of global objects
• blocks (optional array): Array of block objects
• plugins (optional array): Array of plugin strings
• typescript (optional boolean): Whether to use TypeScript

Example Prompt:

Scaffold a Payload CMS project called "blog-platform" with MongoDB, authentication, and collections for posts, categories, and users. Include a global for site settings.

<hr>

🚀 Getting Started

1. Prerequisites

Before you begin, make sure you have:

• Node.js 18+ (required for Payload CMS 3.0)
• An active Railway account
• A Railway API token (create one at railway.app/account/tokens)
• Basic familiarity with Payload CMS 3.0 concepts

2. Configure Cursor

To use with Cursor IDE:

1. Open Cursor Settings
2. Go to MCP Servers section
3. Add a new MCP server
4. Name it "Payload CMS 3.0 MCP"
5. Set Transport Type to "Command"
6. Set Command to: railway run --service=YOUR_SERVICE_ID
7. Save the configuration

3. Using the MCP Server

Once configured, you can use these tools in your AI prompts:

• Code Validation: "Validate this Payload CMS collection code"
• Template Generation: "Generate a template for a media collection"
• Query Rules: "Query validation rules for access control"
• SQL-like Queries: "Execute a query to find field types for collections"

4. Example Workflow

A typical workflow with the Payload CMS MCP Server:

1. Generate a collection template with specific fields
2. Validate the generated code for best practices
3. Query for specific validation rules to improve the code
4. Generate additional components like hooks or endpoints
5. Scaffold a complete project structure when ready

5. Complete Workflow Example

Here's a complete example of how you might use the MCP server in a conversation:

User: I need to create a Payload CMS collection for a product catalog.

AI: I'll help you create a product catalog collection. Let me generate a template for you.

[Uses generate_collection tool]

Here's a collection template for your product catalog:

```typescript
import { CollectionConfig } from 'payload/types';

export const Products: CollectionConfig = {
  slug: 'products',
  admin: {
    useAsTitle: 'name',
    defaultColumns: ['name', 'price', 'category', 'inStock'],
    group: 'Shop',
  },
  access: {
    read: () => true,
  },
  fields: [
    {
      name: 'name',
      type: 'text',
      required: true,
    },
    {
      name: 'description',
      type: 'richText',
    },
    {
      name: 'price',
      type: 'number',
      required: true,
    },
    {
      name: 'category',
      type: 'relationship',
      relationTo: 'categories',
      required: true,
    },
    {
      name: 'images',
      type: 'array',
      fields: [
        {
          name: 'image',
          type: 'upload',
          relationTo: 'media',
          required: true,
        },
        {
          name: 'altText',
          type: 'text',
          required: true,
        }
      ]
    },
    {
      name: 'inStock',
      type: 'checkbox',
      defaultValue: true,
    },
  ],
  timestamps: true,
}

User: Can you validate this code to make sure it follows best practices?

AI: I'll validate the code for you.

[Uses validate tool]

The validation results show that your code is valid and follows best practices. Here are a few suggestions:

1. Consider adding a maxDepth to your category relationship field to prevent deep queries
2. You might want to add access control for create, update, and delete operations

---