🚀 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'

... View full README on GitHub