@govcraft/payload-cms-mcp 1.0.1

package/dist/mcp/generated/tools/createDateField.json

@@ -0,0 +1,84 @@
+{
+  "name": "createDateField",
+  "description": "Creates a Payload CMS 3.0 DateField configuration\n\nExample:\n```typescript\n{\n  name: 'dateField',\n  type: 'date',\n  required: true,\n  label: 'Date Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "format": "date-time",
+    "description": "Date string (ISO format)",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "date"
+        ],
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      },
+      "admin": {
+        "type": "object",
+        "description": "Admin panel configuration for this field",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Additional description shown in the admin UI"
+          },
+          "position": {
+            "type": "string",
+            "enum": [
+              "sidebar"
+            ],
+            "description": "Position of the field in the admin UI"
+          },
+          "width": {
+            "type": "string",
+            "description": "Width of the field in the admin UI"
+          },
+          "style": {
+            "type": "object",
+            "description": "Custom CSS styles for the field"
+          },
+          "className": {
+            "type": "string",
+            "description": "CSS class name for the field"
+          },
+          "readOnly": {
+            "type": "boolean",
+            "description": "Whether the field is read-only in the admin UI"
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Whether the field is hidden in the admin UI"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Condition for showing/hiding the field"
+          }
+        }
+      },
+      "defaultValue": {
+        "type": "string",
+        "description": "Default date value"
+      },
+      "validate": {
+        "type": "string",
+        "description": "Custom validation function that returns true if valid or an error message string if invalid"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ]
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'date',\n  label: 'Date Field', // Label shown in the admin UI\n  required: true,\n  admin: {\n    date: {\n      pickerAppearance: 'dayAndTime', // 'dayOnly', 'timeOnly', or 'dayAndTime'\n    },\n  },\n  // Optional: Add custom validation\n  validate: (value) => {\n    const date = new Date(value);\n    if (date < new Date()) {\n      return 'Date must be in the future';\n    }\n    return true; // Return true if valid\n  },\n}"
+}

package/dist/mcp/generated/tools/createEmailField.json

@@ -0,0 +1,87 @@
+{
+  "name": "createEmailField",
+  "description": "Creates a Payload CMS 3.0 EmailField configuration\n\nExample:\n```typescript\n{\n  name: 'emailField',\n  type: 'email',\n  required: true,\n  label: 'Email Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "description": "Payload.EmailField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "email"
+        ],
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      },
+      "admin": {
+        "type": "object",
+        "description": "Admin panel configuration for this field",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Additional description shown in the admin UI"
+          },
+          "position": {
+            "type": "string",
+            "enum": [
+              "sidebar"
+            ],
+            "description": "Position of the field in the admin UI"
+          },
+          "width": {
+            "type": "string",
+            "description": "Width of the field in the admin UI"
+          },
+          "style": {
+            "type": "object",
+            "description": "Custom CSS styles for the field"
+          },
+          "className": {
+            "type": "string",
+            "description": "CSS class name for the field"
+          },
+          "readOnly": {
+            "type": "boolean",
+            "description": "Whether the field is read-only in the admin UI"
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Whether the field is hidden in the admin UI"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Condition for showing/hiding the field"
+          }
+        }
+      },
+      "minLength": {
+        "type": "number",
+        "description": "Minimum length of the text"
+      },
+      "maxLength": {
+        "type": "number",
+        "description": "Maximum length of the text"
+      },
+      "validate": {
+        "type": "string",
+        "description": "Custom validation function that returns true if valid or an error message string if invalid"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ]
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'email',\n  label: 'Email Field', // Label shown in the admin UI\n  required: true,\n  // Optional: Add custom validation beyond the built-in email validation\n  validate: (value) => {\n    if (value && !value.includes('@example.com')) {\n      return 'Only example.com email addresses are allowed';\n    }\n    return true; // Return true if valid\n  },\n  // Optional: Admin UI configuration\n  admin: {\n    description: 'Enter a valid email address',\n    position: 'sidebar'\n  }\n}"
+}

package/dist/mcp/generated/tools/createField.json

@@ -0,0 +1,31 @@
+{
+  "name": "createField",
+  "description": "Creates a Payload CMS 3.0 Field configuration\n\nExample:\n```typescript\n{\n  name: 'Field',\n  type: '',\n  required: true,\n  label: ' Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field"
+      },
+      "type": {
+        "type": "string",
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ],
+    "description": "Field configuration"
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'text',\n  label: 'Text Field', // Label shown in the admin UI\n  required: true,\n  minLength: 2,\n  maxLength: 100,\n  // Optional: Add custom validation\n  validate: (value, { siblingData }) => {\n    if (value && value.toLowerCase().includes('forbidden')) {\n      return 'This field cannot contain the word \"forbidden\"';\n    }\n    return true; // Return true if valid\n  },\n  // Optional: Admin UI configuration\n  admin: {\n    description: 'Enter text content here',\n    position: 'sidebar',\n    width: '50%',\n    readOnly: false,\n    hidden: false\n  }\n}"
+}

package/dist/mcp/generated/tools/createGlobal.json

@@ -0,0 +1,220 @@
+{
+  "name": "createGlobal",
+  "description": "Creates a Payload CMS 3.0 GlobalConfig configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {
+      "endpoints": {
+        "oneOf": [
+          {
+            "type": "object",
+            "description": "false configuration object"
+          },
+          {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "custom": {
+                  "type": "object",
+                  "properties": {}
+                },
+                "handler": {
+                  "type": "string",
+                  "description": "Function expression (e.g., \"({ req }) => req.user.role === 'admin'\")"
+                },
+                "method": {
+                  "type": "string",
+                  "enum": [
+                    "connect",
+                    "delete",
+                    "get",
+                    "head",
+                    "options",
+                    "patch",
+                    "post",
+                    "put"
+                  ],
+                  "description": "One of the allowed string values"
+                },
+                "path": {
+                  "type": "string"
+                },
+                "root": {
+                  "type": "object",
+                  "description": "never configuration object"
+                }
+              },
+              "required": [
+                "method",
+                "path"
+              ]
+            }
+          }
+        ],
+        "description": "One of the allowed types"
+      },
+      "fields": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "The name of the field"
+            },
+            "type": {
+              "type": "string",
+              "description": "The type of field"
+            },
+            "label": {
+              "type": "string",
+              "description": "The label shown in the admin UI"
+            },
+            "required": {
+              "type": "boolean",
+              "description": "Whether this field is required"
+            },
+            "admin": {
+              "type": "object",
+              "description": "Admin panel configuration for this field",
+              "properties": {
+                "description": {
+                  "type": "string",
+                  "description": "Additional description shown in the admin UI"
+                },
+                "position": {
+                  "type": "string",
+                  "enum": [
+                    "sidebar"
+                  ],
+                  "description": "Position of the field in the admin UI"
+                },
+                "width": {
+                  "type": "string",
+                  "description": "Width of the field in the admin UI"
+                },
+                "style": {
+                  "type": "object",
+                  "description": "Custom CSS styles for the field"
+                },
+                "className": {
+                  "type": "string",
+                  "description": "CSS class name for the field"
+                },
+                "readOnly": {
+                  "type": "boolean",
+                  "description": "Whether the field is read-only in the admin UI"
+                },
+                "hidden": {
+                  "type": "boolean",
+                  "description": "Whether the field is hidden in the admin UI"
+                },
+                "condition": {
+                  "type": "string",
+                  "description": "Condition for showing/hiding the field"
+                },
+                "components": {
+                  "type": "object",
+                  "description": "Custom components for the field",
+                  "properties": {
+                    "Field": {
+                      "type": "string",
+                      "description": "Custom field component"
+                    },
+                    "Cell": {
+                      "type": "string",
+                      "description": "Custom cell component for list views"
+                    },
+                    "Filter": {
+                      "type": "string",
+                      "description": "Custom filter component"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "required": [
+            "name",
+            "type"
+          ]
+        },
+        "description": "Array of field configurations"
+      },
+      "flattenedFields": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "description": "any configuration object"
+        },
+        "description": "Fields in the database schema structure\nRows / collapsible / tabs w/o name `fields` merged to top, UIs are excluded"
+      },
+      "slug": {
+        "type": "string"
+      },
+      "versions": {
+        "type": "object",
+        "properties": {
+          "drafts": {
+            "oneOf": [
+              {
+                "type": "object",
+                "description": "false configuration object"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "autosave": {
+                    "oneOf": [
+                      {
+                        "type": "object",
+                        "description": "false configuration object"
+                      },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "interval": {
+                            "type": "number"
+                          }
+                        }
+                      }
+                    ],
+                    "description": "One of the allowed types"
+                  },
+                  "schedulePublish": {
+                    "type": "boolean"
+                  },
+                  "validate": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "autosave",
+                  "schedulePublish",
+                  "validate"
+                ]
+              }
+            ],
+            "description": "One of the allowed types"
+          },
+          "max": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "drafts",
+          "max"
+        ]
+      }
+    },
+    "required": [
+      "endpoints",
+      "fields",
+      "flattenedFields",
+      "slug",
+      "versions"
+    ]
+  },
+  "template": "// Global configuration for Payload CMS\nexport const {slug} = {\n  slug: '{slug}', // URL-friendly identifier for this global\n  admin: {\n    group: 'Settings', // Group in the admin UI\n  },\n  // Define the fields for this global\n  fields: [\n    // Add your fields here\n    {fields}\n  ],\n  // Optional: Add hooks, access control, etc.\n  ...{rest}\n};"
+}

package/dist/mcp/generated/tools/createGroupField.json

@@ -0,0 +1,79 @@
+{
+  "name": "createGroupField",
+  "description": "Creates a Payload CMS 3.0 GroupField configuration\n\nExample:\n```typescript\n{\n  name: 'groupField',\n  type: 'group',\n  required: true,\n  label: 'Group Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "description": "Payload.GroupField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "group"
+        ],
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      },
+      "admin": {
+        "type": "object",
+        "description": "Admin panel configuration for this field",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Additional description shown in the admin UI"
+          },
+          "position": {
+            "type": "string",
+            "enum": [
+              "sidebar"
+            ],
+            "description": "Position of the field in the admin UI"
+          },
+          "width": {
+            "type": "string",
+            "description": "Width of the field in the admin UI"
+          },
+          "style": {
+            "type": "object",
+            "description": "Custom CSS styles for the field"
+          },
+          "className": {
+            "type": "string",
+            "description": "CSS class name for the field"
+          },
+          "readOnly": {
+            "type": "boolean",
+            "description": "Whether the field is read-only in the admin UI"
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Whether the field is hidden in the admin UI"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Condition for showing/hiding the field"
+          }
+        }
+      },
+      "validate": {
+        "type": "string",
+        "description": "Custom validation function that returns true if valid or an error message string if invalid"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ]
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'group',\n  label: 'Group Field', // Label shown in the admin UI\n  fields: [\n    {\n      name: 'groupedField1',\n      type: 'text',\n      required: true,\n    },\n    {\n      name: 'groupedField2',\n      type: 'number',\n    },\n    // Add more fields as needed\n  ],\n  // Optional: Add custom validation for the entire group\n  validate: (value) => {\n    if (value && (!value.groupedField1 || !value.groupedField2)) {\n      return 'Both fields in the group are required';\n    }\n    return true; // Return true if valid\n  },\n}"
+}

package/dist/mcp/generated/tools/createJSONField.json

@@ -0,0 +1,79 @@
+{
+  "name": "createJSONField",
+  "description": "Creates a Payload CMS 3.0 JSONField configuration\n\nExample:\n```typescript\n{\n  name: 'jsonField',\n  type: 'json',\n  required: true,\n  label: 'Json Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "description": "Payload.JSONField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "json"
+        ],
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      },
+      "admin": {
+        "type": "object",
+        "description": "Admin panel configuration for this field",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Additional description shown in the admin UI"
+          },
+          "position": {
+            "type": "string",
+            "enum": [
+              "sidebar"
+            ],
+            "description": "Position of the field in the admin UI"
+          },
+          "width": {
+            "type": "string",
+            "description": "Width of the field in the admin UI"
+          },
+          "style": {
+            "type": "object",
+            "description": "Custom CSS styles for the field"
+          },
+          "className": {
+            "type": "string",
+            "description": "CSS class name for the field"
+          },
+          "readOnly": {
+            "type": "boolean",
+            "description": "Whether the field is read-only in the admin UI"
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Whether the field is hidden in the admin UI"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Condition for showing/hiding the field"
+          }
+        }
+      },
+      "validate": {
+        "type": "string",
+        "description": "Custom validation function that returns true if valid or an error message string if invalid"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ]
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'json',\n  label: 'JSON Field', // Label shown in the admin UI\n  // Optional: Add custom validation\n  validate: (value) => {\n    try {\n      if (typeof value === 'string') {\n        JSON.parse(value);\n      }\n      return true; // Return true if valid\n    } catch (err) {\n      return 'Invalid JSON format';\n    }\n  },\n}"
+}

package/dist/mcp/generated/tools/createJoinField.json

@@ -0,0 +1,79 @@
+{
+  "name": "createJoinField",
+  "description": "Creates a Payload CMS 3.0 JoinField configuration\n\nA virtual field that loads in related collections by querying a relationship or upload field.\n\nExample:\n```typescript\n{\n  name: 'joinField',\n  type: 'join',\n  required: true,\n  label: 'Join Field',\n  // Custom validation example\n  validate: (value, { siblingData, operation }) => {\n    // Validation logic based on the value, sibling data, or operation\n    if (operation === 'create' && !value) {\n      return 'This field is required for new records';\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "description": "Payload.JoinField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "join"
+        ],
+        "description": "The type of field"
+      },
+      "label": {
+        "type": "string",
+        "description": "The label shown in the admin UI"
+      },
+      "required": {
+        "type": "boolean",
+        "description": "Whether this field is required"
+      },
+      "admin": {
+        "type": "object",
+        "description": "Admin panel configuration for this field",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "Additional description shown in the admin UI"
+          },
+          "position": {
+            "type": "string",
+            "enum": [
+              "sidebar"
+            ],
+            "description": "Position of the field in the admin UI"
+          },
+          "width": {
+            "type": "string",
+            "description": "Width of the field in the admin UI"
+          },
+          "style": {
+            "type": "object",
+            "description": "Custom CSS styles for the field"
+          },
+          "className": {
+            "type": "string",
+            "description": "CSS class name for the field"
+          },
+          "readOnly": {
+            "type": "boolean",
+            "description": "Whether the field is read-only in the admin UI"
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Whether the field is hidden in the admin UI"
+          },
+          "condition": {
+            "type": "string",
+            "description": "Condition for showing/hiding the field"
+          }
+        }
+      },
+      "validate": {
+        "type": "string",
+        "description": "Custom validation function that returns true if valid or an error message string if invalid"
+      }
+    },
+    "required": [
+      "name",
+      "type"
+    ]
+  },
+  "template": "{\n  name: '{name}', // Database field name\n  type: 'join',\n  label: 'Join Field', // Label shown in the admin UI\n  required: true,\n  // Add field-specific properties here\n  \n  // Optional: Add custom validation\n  validate: (value, { siblingData, operation }) => {\n    // Custom validation logic based on the value, sibling data, or operation\n    if (!value && operation === 'create') {\n      return 'This field is required for new records';\n    }\n    return true; // Return true if valid\n  },\n  ...{rest}\n}"
+}

package/dist/mcp/generated/tools/createMeHook.json

@@ -0,0 +1,9 @@
+{
+  "name": "createMeHook",
+  "description": "Creates a Payload CMS 3.0 MeHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * Generic Payload CMS hook\n * See documentation for specific hook parameters\n */\nconst hook = (args) => {\n  // Extract relevant properties from args based on hook type\n  const { req } = args;\n  \n  // Example: Log hook execution\n  logger.info('Hook executed');\n  \n  // For hooks that modify data, return the modified data\n  // For other hooks, return as appropriate for the hook type\n  return args.data ? { ...args.data, modified: true } : undefined;\n};"
+}