Deployment Options

Choose the deployment method that works best for your needs.

Deploy on Railway (Recommended)

The easiest way to deploy the MCP server is using Railway's one-click deployment:

Detailed Railway Deployment Guide

  1. Create a Railway account at railway.com
  2. Deploy the MCP server using the provided button
  3. Wait for deployment completion and verify via the provided URL

Run Locally

For local development or testing, follow these steps:

npm install -g payload-cms-mcp payload-cms-mcp

Your server will be available at http://localhost:8080 by default.

NPM Package

The MCP server is available as an npm package:

Install as a dependency:

npm install --save payload-cms-mcp

Configuring in Cursor IDE

After installing the npm package, follow these steps to configure it in Cursor IDE:

  1. Open Cursor IDE
  2. Go to Settings (gear icon in the bottom left)
  3. Navigate to "MCP Servers" section
  4. Click "Add MCP Server"
  5. Fill in the following details:
    • Name: "Payload CMS 3.0 MCP"
    • Transport Type: "Command"
    • Command: payload-cms-mcp (if installed globally) or npx payload-cms-mcp (if installed locally)
  6. Click "Save"

You can now use the MCP server in your Cursor IDE by referencing it in your prompts:

// Example prompt "Generate a Payload CMS collection for a blog with title, content, and author fields."