@govcraft/payload-cms-mcp 1.0.1

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

@@ -0,0 +1,10 @@
+{
+  "name": "createAccess",
+  "description": "Creates a Payload CMS 3.0 Access configuration\n\nAccess function runs on the server\nand is sent to the client allowing the dashboard to show accessible data and actions.\n@see ://payloadcms.com/docs/access-control/overview",
+  "inputSchema": {
+    "type": "object",
+    "properties": {},
+    "description": "Access function runs on the server\nand is sent to the client allowing the dashboard to show accessible data and actions.\n@see ://payloadcms.com/docs/access-control/overview"
+  },
+  "template": "/**\n * Access control function to determine if the operation is allowed\n * Returns true if access is granted, false if denied\n * Can also return a string with an error message if denied\n */\nconst accessControl = ({ req, id, data, doc }) => {\n  // 'req' is the Express request object with the Payload instance and user\n  // 'id' is the ID of the document being accessed (for operations on existing documents)\n  // 'data' contains the data for create/update operations\n  // 'doc' is the existing document for update operations\n  \n  // Example: Only allow access if user is logged in\n  if (!req.user) {\n    return false; // Or return 'You must be logged in'\n  }\n  \n  // Example: Check user roles\n  if (req.user.role === 'admin') {\n    return true; // Admins have full access\n  }\n  \n  // Example: Users can only access their own documents\n  if (id && doc && doc.createdBy === req.user.id) {\n    return true;\n  }\n  \n  // Deny access with a custom message\n  return 'You do not have permission to access this resource';\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterChangeHook",
+  "description": "Creates a Payload CMS 3.0 AfterChangeHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs after a document has been saved to the database\n * It allows you to perform side effects but cannot modify the saved data\n */\nconst afterChangeHook = ({ doc, req, operation, previousDoc }) => {\n  // 'doc' contains the saved document\n  // 'req' is the Express request object with the Payload instance\n  // 'operation' is either 'create' or 'update'\n  // 'previousDoc' is the document before changes (for updates)\n  \n  // Example: Send a notification\n  if (operation === 'create') {\n    // Send notification about new document\n    logger.info(`New document created: ${doc.id}`);\n  }\n  \n  // Return the document (cannot be modified)\n  return doc;\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterDeleteHook",
+  "description": "Creates a Payload CMS 3.0 AfterDeleteHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs after a document has been deleted\n * It allows you to perform side effects\n */\nconst afterDeleteHook = ({ req, id, doc }) => {\n  // 'req' is the Express request object with the Payload instance\n  // 'id' is the ID of the document that was deleted\n  // 'doc' is the document that was deleted\n  \n  // Example: Clean up related data\n  logger.info(`Document deleted: ${id}`);\n  \n  // No return value is expected\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterErrorHook",
+  "description": "Creates a Payload CMS 3.0 AfterErrorHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterForgotPasswordHook",
+  "description": "Creates a Payload CMS 3.0 AfterForgotPasswordHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterLoginHook",
+  "description": "Creates a Payload CMS 3.0 AfterLoginHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterLogoutHook",
+  "description": "Creates a Payload CMS 3.0 AfterLogoutHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterMeHook",
+  "description": "Creates a Payload CMS 3.0 AfterMeHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterOperationHook",
+  "description": "Creates a Payload CMS 3.0 AfterOperationHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterReadHook",
+  "description": "Creates a Payload CMS 3.0 AfterReadHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs before/after documents are returned from the database\n * It allows you to modify the data before it's sent to the client\n */\nconst readHook = ({ doc, req }) => {\n  // 'doc' contains the document(s) being read\n  // 'req' is the Express request object with the Payload instance\n  \n  // Example: Add computed properties\n  return {\n    ...doc,\n    computedProperty: `${doc.firstName} ${doc.lastName}`,\n  };\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createAfterRefreshHook",
+  "description": "Creates a Payload CMS 3.0 AfterRefreshHook 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};"
+}

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

@@ -0,0 +1,90 @@
+{
+  "name": "createArrayField",
+  "description": "Creates a Payload CMS 3.0 ArrayField configuration\n\nExample:\n```typescript\n{\n  name: 'items',\n  type: 'array',\n  label: 'Items',\n  minRows: 1,\n  maxRows: 10,\n  fields: [\n    {\n      name: 'name',\n      type: 'text',\n      required: true\n    },\n    {\n      name: 'quantity',\n      type: 'number',\n      required: true,\n      min: 1\n    }\n  ],\n  // Custom validation example\n  validate: (value) => {\n    if (value && value.length > 0) {\n      const totalQuantity = value.reduce((sum, item) => sum + (item.quantity || 0), 0);\n      if (totalQuantity > 100) {\n        return 'Total quantity cannot exceed 100';\n      }\n    }\n    return true;\n  }\n}\n```",
+  "inputSchema": {
+    "type": "object",
+    "items": {
+      "type": "object"
+    },
+    "description": "Array of items",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "array"
+        ],
+        "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"
+          }
+        }
+      },
+      "minRows": {
+        "type": "number",
+        "description": "Minimum number of rows"
+      },
+      "maxRows": {
+        "type": "number",
+        "description": "Maximum number of rows"
+      },
+      "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: 'array',\n  label: 'Array 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/createBeforeChangeHook.json

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeChangeHook",
+  "description": "Creates a Payload CMS 3.0 BeforeChangeHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs before a document is saved to the database\n * It allows you to modify the data or perform validation\n */\nconst beforeChangeHook = ({ data, req, operation, originalDoc }) => {\n  // 'data' contains the data being saved\n  // 'req' is the Express request object with the Payload instance\n  // 'operation' is either 'create' or 'update'\n  // 'originalDoc' is the document before changes (for updates)\n  \n  // Example: Add a timestamp\n  return {\n    ...data,\n    modifiedAt: new Date().toISOString(),\n    modifiedBy: req.user?.id,\n  };\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeDeleteHook",
+  "description": "Creates a Payload CMS 3.0 BeforeDeleteHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs before a document is deleted\n * It allows you to perform validation or prevent deletion\n */\nconst beforeDeleteHook = ({ req, id }) => {\n  // 'req' is the Express request object with the Payload instance\n  // 'id' is the ID of the document being deleted\n  \n  // Example: Check if deletion is allowed\n  // If you return a string, it will prevent deletion with that error message\n  // If you throw an error, it will prevent deletion with that error\n  \n  // To allow deletion, return undefined or void\n  return;\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeLoginHook",
+  "description": "Creates a Payload CMS 3.0 BeforeLoginHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeOperationHook",
+  "description": "Creates a Payload CMS 3.0 BeforeOperationHook 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};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeReadHook",
+  "description": "Creates a Payload CMS 3.0 BeforeReadHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs before/after documents are returned from the database\n * It allows you to modify the data before it's sent to the client\n */\nconst readHook = ({ doc, req }) => {\n  // 'doc' contains the document(s) being read\n  // 'req' is the Express request object with the Payload instance\n  \n  // Example: Add computed properties\n  return {\n    ...doc,\n    computedProperty: `${doc.firstName} ${doc.lastName}`,\n  };\n};"
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "createBeforeValidateHook",
+  "description": "Creates a Payload CMS 3.0 BeforeValidateHook configuration",
+  "inputSchema": {
+    "type": "object",
+    "properties": {}
+  },
+  "template": "/**\n * This hook runs before validation occurs\n * It allows you to modify the data before validation\n */\nconst beforeValidateHook = ({ data, req, operation, originalDoc }) => {\n  // 'data' contains the data to be validated\n  // 'req' is the Express request object with the Payload instance\n  // 'operation' is either 'create' or 'update'\n  // 'originalDoc' is the document before changes (for updates)\n  \n  // Example: Set default values\n  return {\n    ...data,\n    status: data.status || 'draft',\n  };\n};"
+}

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

@@ -0,0 +1,79 @@
+{
+  "name": "createBlocksField",
+  "description": "Creates a Payload CMS 3.0 BlocksField configuration\n\nExample:\n```typescript\n{\n  name: 'blocksField',\n  type: 'blocks',\n  required: true,\n  label: 'Blocks 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.BlocksField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "blocks"
+        ],
+        "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: 'blocks',\n  label: 'Blocks Field', // Label shown in the admin UI\n  minRows: 1,\n  maxRows: 10,\n  blocks: [\n    {\n      slug: 'textBlock',\n      fields: [\n        {\n          name: 'text',\n          type: 'richText',\n          required: true,\n        },\n      ],\n    },\n    {\n      slug: 'imageBlock',\n      fields: [\n        {\n          name: 'image',\n          type: 'upload',\n          relationTo: 'media',\n          required: true,\n        },\n      ],\n    },\n    // Add more block types as needed\n  ],\n  // Optional: Add custom validation\n  validate: (value) => {\n    if (value && value.length > 0) {\n      // Validate the blocks as a whole\n      return true;\n    }\n    return 'Please add at least one block';\n  },\n}"
+}

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

@@ -0,0 +1,79 @@
+{
+  "name": "createCodeField",
+  "description": "Creates a Payload CMS 3.0 CodeField configuration\n\nExample:\n```typescript\n{\n  name: 'codeField',\n  type: 'code',\n  required: true,\n  label: 'Code 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.CodeField configuration object",
+    "properties": {
+      "name": {
+        "type": "string",
+        "description": "The name of the field, used as the property name in the database"
+      },
+      "type": {
+        "type": "string",
+        "enum": [
+          "code"
+        ],
+        "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: 'code',\n  label: 'Code Field', // Label shown in the admin UI\n  admin: {\n    language: 'javascript', // The language for syntax highlighting\n  },\n  // Optional: Add custom validation\n  validate: (value) => {\n    if (value && value.length < 10) {\n      return 'Please enter more code';\n    }\n    return true; // Return true if valid\n  },\n}"
+}