/g,
17 | '
'
18 | );
19 |
20 | // Write the updated HTML back to the file
21 | fs.writeFile(indexPath, updatedHtml, 'utf8', (err) => {
22 | if (err) {
23 | console.error('Error writing to index.html:', err);
24 | return;
25 | }
26 | console.log('Successfully updated the logo in index.html');
27 | console.log('Make sure to place your new logo file (matmax-payload-mcp-logo.png) in the public directory');
28 | });
29 | });
--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | # Redis connection URL (required for MCP server functionality)
2 | # Use either REDIS_URL or KV_URL (Vercel KV)
3 | REDIS_URL=redis://username:password@host:port
4 | # KV_URL=redis://username:password@host:port
5 |
6 | # Vercel KV specific configuration
7 | # KV_REST_API_URL=https://your-kv-rest-api-url
8 | # KV_REST_API_TOKEN=your-kv-rest-api-token
9 | # KV_REST_API_READ_ONLY_TOKEN=your-kv-rest-api-read-only-token
10 |
11 | # Connection timeout in milliseconds (optional, default: 30000)
12 | # REDIS_CONNECT_TIMEOUT=30000
13 |
14 | # Keep-alive interval in milliseconds (optional, default: 5000)
15 | # REDIS_KEEP_ALIVE=5000
16 |
17 | # Heartbeat interval in milliseconds (optional, default: 30000)
18 | # REDIS_HEARTBEAT_INTERVAL=30000
19 |
20 | # Redis ping interval in milliseconds (optional, default: 1000)
21 | # REDIS_PING_INTERVAL=1000
22 |
23 | # Redis command timeout in milliseconds (optional, default: 5000)
24 | # REDIS_COMMAND_TIMEOUT=5000
25 |
26 | # Persistence check interval in milliseconds (optional, default: 60000)
27 | # REDIS_PERSISTENCE_INTERVAL=60000
28 |
29 | # Maximum reconnect attempts before forcing clean reconnection (optional, default: 5)
30 | # REDIS_MAX_RECONNECT_ATTEMPTS=5
31 |
32 | # Force TLS verification (optional, default: false for rediss:// URLs)
33 | # REDIS_TLS_VERIFY=false
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "payload-cms-mcp",
3 | "version": "1.0.2",
4 | "description": "Payload CMS 3.0 MCP Server - A specialized Model Context Protocol server for Payload CMS",
5 | "main": "server.js",
6 | "bin": {
7 | "payload-cms-mcp": "./server.js"
8 | },
9 | "scripts": {
10 | "test": "echo \"No tests specified\"",
11 | "start": "node server.js",
12 | "dev": "node server.js",
13 | "local": "node server.js",
14 | "prepublishOnly": "npm test"
15 | },
16 | "keywords": [
17 | "payload-cms",
18 | "mcp",
19 | "model-context-protocol",
20 | "ai",
21 | "cursor-ide",
22 | "headless-cms"
23 | ],
24 | "author": "MATMAX WORLDWIDE",
25 | "license": "MIT",
26 | "repository": {
27 | "type": "git",
28 | "url": "git+https://github.com/Matmax-Worldwide/payloadcmsmcp.git"
29 | },
30 | "bugs": {
31 | "url": "https://github.com/Matmax-Worldwide/payloadcmsmcp/issues"
32 | },
33 | "homepage": "https://www.payloadcmsmcp.info",
34 | "packageManager": "pnpm@8.15.7+sha512.c85cd21b6da10332156b1ca2aa79c0a61ee7ad2eb0453b88ab299289e9e8ca93e6091232b25c07cbf61f6df77128d9c849e5c9ac6e44854dbd211c49f3a67adc",
35 | "dependencies": {
36 | "@modelcontextprotocol/sdk": "^1.6.1",
37 | "content-type": "^1.0.5",
38 | "express": "^4.18.3",
39 | "http-proxy-middleware": "^2.0.6",
40 | "raw-body": "^3.0.0",
41 | "redis": "^4.7.0",
42 | "zod": "^3.24.2"
43 | },
44 | "devDependencies": {
45 | "@types/node": "^22.13.10",
46 | "vercel": "^41.4.0"
47 | },
48 | "engines": {
49 | "node": ">=18.0.0"
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/public/logo-server.js:
--------------------------------------------------------------------------------
1 | const http = require('http');
2 | const fs = require('fs');
3 | const path = require('path');
4 |
5 | const PORT = 3000;
6 |
7 | const server = http.createServer((req, res) => {
8 | // Set CORS headers to allow access from any origin
9 | res.setHeader('Access-Control-Allow-Origin', '*');
10 | res.setHeader('Access-Control-Allow-Methods', 'GET');
11 | res.setHeader('Access-Control-Allow-Headers', 'Content-Type');
12 |
13 | // Handle the root path
14 | if (req.url === '/' || req.url === '/logo-generator') {
15 | fs.readFile(path.join(__dirname, 'logo-generator.html'), (err, content) => {
16 | if (err) {
17 | res.writeHead(500);
18 | res.end(`Error loading logo generator: ${err.message}`);
19 | return;
20 | }
21 | res.writeHead(200, { 'Content-Type': 'text/html' });
22 | res.end(content);
23 | });
24 | return;
25 | }
26 |
27 | // Handle requests for files in the public directory
28 | const filePath = path.join(__dirname, req.url);
29 | fs.readFile(filePath, (err, content) => {
30 | if (err) {
31 | res.writeHead(404);
32 | res.end(`File not found: ${req.url}`);
33 | return;
34 | }
35 |
36 | // Determine the content type based on file extension
37 | let contentType = 'text/plain';
38 | const ext = path.extname(filePath);
39 | switch (ext) {
40 | case '.html':
41 | contentType = 'text/html';
42 | break;
43 | case '.js':
44 | contentType = 'text/javascript';
45 | break;
46 | case '.css':
47 | contentType = 'text/css';
48 | break;
49 | case '.json':
50 | contentType = 'application/json';
51 | break;
52 | case '.png':
53 | contentType = 'image/png';
54 | break;
55 | case '.jpg':
56 | case '.jpeg':
57 | contentType = 'image/jpeg';
58 | break;
59 | case '.svg':
60 | contentType = 'image/svg+xml';
61 | break;
62 | }
63 |
64 | res.writeHead(200, { 'Content-Type': contentType });
65 | res.end(content);
66 | });
67 | });
68 |
69 | server.listen(PORT, () => {
70 | console.log(`Logo generator server running at http://localhost:${PORT}`);
71 | console.log(`Open http://localhost:${PORT}/logo-generator in your browser to create your logo`);
72 | });
--------------------------------------------------------------------------------
/public/keep-alive.js:
--------------------------------------------------------------------------------
1 | // Script to keep the Redis connection alive by pinging the keep-alive endpoint
2 | (function() {
3 | // Configuration
4 | const PING_INTERVAL = 15000; // 15 seconds
5 | const KEEP_ALIVE_URL = '/api/keep-alive';
6 | const MAX_CONSECUTIVE_FAILURES = 3;
7 |
8 | let consecutiveFailures = 0;
9 | let lastPingTime = 0;
10 | let isActive = true;
11 |
12 | // Function to ping the keep-alive endpoint
13 | async function pingKeepAlive() {
14 | if (!isActive) return;
15 |
16 | try {
17 | const now = Date.now();
18 | const timeSinceLastPing = lastPingTime ? now - lastPingTime : 0;
19 | lastPingTime = now;
20 |
21 | console.log(`Pinging keep-alive endpoint. Time since last ping: ${timeSinceLastPing}ms`);
22 |
23 | const response = await fetch(KEEP_ALIVE_URL);
24 | if (!response.ok) {
25 | throw new Error(`HTTP error! status: ${response.status}`);
26 | }
27 |
28 | const data = await response.json();
29 | console.log('Keep-alive response:', data);
30 |
31 | // Reset failure counter on success
32 | consecutiveFailures = 0;
33 |
34 | } catch (error) {
35 | console.error('Keep-alive ping failed:', error);
36 | consecutiveFailures++;
37 |
38 | if (consecutiveFailures >= MAX_CONSECUTIVE_FAILURES) {
39 | console.warn(`${MAX_CONSECUTIVE_FAILURES} consecutive failures. Increasing ping frequency.`);
40 | // If we're having trouble, ping more frequently
41 | setTimeout(pingKeepAlive, PING_INTERVAL / 2);
42 | }
43 | }
44 |
45 | // Schedule next ping
46 | setTimeout(pingKeepAlive, PING_INTERVAL);
47 | }
48 |
49 | // Start pinging when the page loads
50 | window.addEventListener('load', () => {
51 | console.log('Starting keep-alive pings...');
52 | pingKeepAlive();
53 | });
54 |
55 | // Pause pinging when the page is not visible
56 | document.addEventListener('visibilitychange', () => {
57 | if (document.visibilityState === 'hidden') {
58 | console.log('Page hidden, pausing keep-alive pings');
59 | isActive = false;
60 | } else {
61 | console.log('Page visible, resuming keep-alive pings');
62 | isActive = true;
63 | // Ping immediately when becoming visible again
64 | pingKeepAlive();
65 | }
66 | });
67 |
68 | // Also ping on user interaction to ensure activity
69 | ['click', 'keydown', 'mousemove', 'touchstart'].forEach(eventType => {
70 | document.addEventListener(eventType, () => {
71 | // Only ping if it's been at least half the interval since the last ping
72 | const now = Date.now();
73 | if (now - lastPingTime > PING_INTERVAL / 2) {
74 | pingKeepAlive();
75 | }
76 | }, { passive: true });
77 | });
78 | })();
--------------------------------------------------------------------------------
/public/logo-generator.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | 
77 | 
6 | 
9 | 
10 | 
11 | 
12 | Code Validation
511 |Validates Payload CMS collections, fields, globals, and other components with detailed feedback on validation issues.
512 |
492 |
499 | Payload CMS MCP Server
493 |A validation and query service for Payload CMS code, designed to be used with Cursor IDE for AI-assisted development.
494 | 498 |
503 |
530 |
504 |
507 | Features
505 |Enhance your Payload CMS development experience with powerful validation and query capabilities.
506 |
508 |
509 |
510 |
513 |
514 |
515 |
518 |
519 |
520 |
523 |
524 |
525 |
528 |
529 | Smart Queries
516 |Supports SQL-like queries for validation rules, making it easy to find and understand best practices.
517 |Suggestions
521 |Offers intelligent suggestions for improving code quality and security in your Payload CMS applications.
522 |AI Integration
526 |Seamlessly integrates with Cursor IDE for AI-assisted development of Payload CMS applications.
527 |
534 |
584 |
535 |
538 | API Endpoints
536 |Powerful endpoints to validate and query your Payload CMS code.
537 |
539 |
540 |
549 |
550 |
551 |
560 |
561 |
562 |
571 |
572 |
573 |
582 |
583 |
541 | /sse
542 | GET
543 |
544 |
545 | Server-Sent Events endpoint for real-time communication with the MCP server.
546 |
547 | https://www.payloadcmsmcp.info/sse
548 |
552 | /api/sse
553 | GET
554 |
555 |
556 | Alternative SSE endpoint for API-based communication.
557 |
558 | https://www.payloadcmsmcp.info/api/sse
559 |
563 | /api/validate
564 | POST
565 |
566 |
567 | Validates Payload CMS code and provides detailed feedback on validation issues.
568 |
569 | https://www.payloadcmsmcp.info/api/validate
570 |
574 | /api/query
575 | POST
576 |
577 |
578 | Query endpoint for retrieving validation rules and best practices.
579 |
580 | https://www.payloadcmsmcp.info/api/query
581 |
588 |
600 |
589 |
599 |
590 | 
591 |
592 |
591 |
593 |
598 | MATMAX WORLDWIDE
594 |Creating technology that helps humans be more human. We believe in tech for good—tools that enhance our lives while respecting our humanity.
595 |Join us in building a future where technology serves wellness, connection, and purpose. Together, we can create digital experiences that bring out the best in us all.
596 | Visit matmax.world 597 |