@payloadcms/plugin-mcp 4.0.0-internal.e16cf59 → 4.0.0-internal.e38d3ac

package/src/mcp/builtin/collections/createTool.ts

@@ -0,0 +1,168 @@
+import type { SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+} from '../../../utils/getVirtualFieldNames.js'
+import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
+import { validateCollectionData } from '../validateEntityData.js'
+import { fileInputSchema, resolveFile } from './fileInput.js'
+import { formatCollectionError } from './formatCollectionError.js'
+
+const DEFAULT_DESCRIPTION =
+  'Create one or more documents. Each can have different data or a file. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'
+
+export const createDocumentsTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    title: 'Create Documents',
+  },
+  description: DEFAULT_DESCRIPTION,
+  input: z.object({
+    depth: z
+      .number()
+      .int()
+      .min(0)
+      .max(10)
+      .describe('How many levels deep to populate relationships in response')
+      .optional()
+      .default(0),
+    documents: z
+      .array(
+        z.object({
+          data: z
+            .record(z.string(), z.unknown())
+            .describe(
+              'The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.',
+            ),
+          file: fileInputSchema.optional(),
+        }),
+      )
+      .min(1)
+      .describe('The documents to create, in order'),
+    draft: z
+      .boolean()
+      .describe(
+        'Only if getCollectionSchema includes _status; otherwise _status does not exist. true forces data._status to "draft"; with false, data._status controls draft or published.',
+      )
+      .optional()
+      .default(false),
+    fallbackLocale: z
+      .string()
+      .describe('Optional: fallback locale code to use when requested locale is not available')
+      .optional(),
+    locale: z
+      .string()
+      .describe(
+        'Optional: locale code to create the documents in (e.g., "en", "es"). Defaults to the default locale',
+      )
+      .optional(),
+    select: z
+      .record(z.string(), z.unknown())
+      .describe(
+        'Optional: define exactly which fields you\'d like to return, e.g., {"title": true}',
+      )
+      .optional(),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const { depth, documents, draft, fallbackLocale, locale, select } = input
+
+  logger.info(`Creating ${documents.length} documents in collection: ${collectionSlug}`)
+
+  try {
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    const docs: Array<{ doc: Record<string, unknown>; index: number }> = []
+    const errors: Array<{ index: number; message: string }> = []
+    let validationSchema: Record<string, unknown> | undefined
+
+    for (const [index, document] of documents.entries()) {
+      try {
+        const inputData = stripVirtualFields(document.data, virtualFieldNames)
+        const validationError = validateCollectionData({ collectionSlug, data: inputData, req })
+
+        if (validationError) {
+          const firstContent = validationError.content[0]
+          const validationContent = validationError.structuredContent as
+            | Record<string, unknown>
+            | undefined
+          const schema = validationContent?.schema
+
+          if (!validationSchema && schema && typeof schema === 'object') {
+            validationSchema = schema as Record<string, unknown>
+          }
+
+          errors.push({
+            index,
+            message:
+              firstContent?.type === 'text'
+                ? (firstContent.text.split('\n\nUse this schema')[0] ?? 'Invalid document data')
+                : 'Invalid document data',
+          })
+          continue
+        }
+
+        const parsedData = transformPointDataToPayload(inputData)
+        const file = await resolveFile({ collectionSlug, input: document.file, req })
+        const result = await payload.create({
+          collection: collectionSlug,
+          data: parsedData,
+          depth,
+          draft,
+          overrideAccess: authorizedMCP.overrideAccess,
+          req,
+          ...(file ? { file } : {}),
+          ...(locale ? { locale } : {}),
+          ...(fallbackLocale ? { fallbackLocale } : {}),
+          ...(select ? { select: select as SelectType } : {}),
+        })
+
+        docs.push({ doc: result as Record<string, unknown>, index })
+      } catch (error) {
+        const message = error instanceof Error ? error.message : 'Unknown error'
+
+        logger.error(`Error creating document at index ${index} in ${collectionSlug}: ${message}`)
+        errors.push({ index, message })
+      }
+    }
+
+    const batchResult = { docs, errors }
+    const retryMessage = errors.length > 0 ? '\nRetry failed indexes only.' : ''
+    const schemaMessage = validationSchema
+      ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(validationSchema)}\n\`\`\``
+      : ''
+    const structuredContent = validationSchema
+      ? { ...batchResult, schema: validationSchema }
+      : batchResult
+
+    logger.info(`Created ${docs.length} of ${documents.length} documents in ${collectionSlug}`)
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Created ${docs.length} of ${documents.length} documents in collection "${collectionSlug}".${retryMessage}\nResults:\n\`\`\`json\n${JSON.stringify(batchResult)}\n\`\`\`${schemaMessage}`,
+        },
+      ],
+      doc: structuredContent as unknown as Record<string, unknown>,
+      isError: docs.length === 0 && errors.length > 0,
+      structuredContent,
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : 'Unknown error'
+
+    logger.error(`Error creating documents in ${collectionSlug}: ${message}`)
+    return formatCollectionError({ action: 'creating', collectionSlug, error, req })
+  }
+})

package/src/mcp/builtin/collections/deleteTool.ts

@@ -0,0 +1,125 @@
+import { z } from 'zod'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import { whereSchema } from '../../../utils/whereSchema.js'
+
+const DEFAULT_DESCRIPTION =
+  'Delete documents in any collection by passing the collection slug and ID or where clause.'
+
+export const deleteDocumentsTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.delete),
+  annotations: {
+    destructiveHint: true,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    title: 'Delete Documents',
+  },
+  description: DEFAULT_DESCRIPTION,
+  input: z.object({
+    id: z
+      .union([z.string(), z.number()])
+      .describe('Optional: specific document ID to delete')
+      .optional(),
+    depth: z
+      .number()
+      .int()
+      .min(0)
+      .max(10)
+      .describe('Depth of population for relationships in response')
+      .optional()
+      .default(0),
+    fallbackLocale: z
+      .string()
+      .describe('Optional: fallback locale code to use when requested locale is not available')
+      .optional(),
+    locale: z
+      .string()
+      .describe(
+        'Optional: locale code for the operation (e.g., "en", "es"). Defaults to the default locale',
+      )
+      .optional(),
+    where: whereSchema
+      .describe(
+        'Optional: where clause to delete multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
+      )
+      .optional(),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+
+  const { id, depth, fallbackLocale, locale, where } = input
+
+  logger.info(
+    `Deleting document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`,
+  )
+
+  try {
+    if (!id && !where) {
+      return {
+        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],
+      }
+    }
+
+    const deleteOptions: Record<string, unknown> = {
+      collection: collectionSlug,
+      depth,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(locale && { locale }),
+      ...(fallbackLocale && { fallbackLocale }),
+    }
+
+    if (id) {
+      deleteOptions.id = id
+    } else {
+      deleteOptions.where = where
+    }
+
+    const result = await payload.delete(deleteOptions as Parameters<typeof payload.delete>[0])
+
+    if (id) {
+      return {
+        content: [
+          {
+            type: 'text',
+            text: `Document deleted successfully from collection "${collectionSlug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          },
+        ],
+        doc: result as Record<string, unknown>,
+      }
+    }
+
+    const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }
+    const docs = bulkResult.docs || []
+    const errors = bulkResult.errors || []
+
+    let responseText = `Document deleted successfully from collection "${collectionSlug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`
+    if (docs.length > 0) {
+      responseText += `\n\nDeleted documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``
+    }
+    if (errors.length > 0) {
+      responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``
+    }
+
+    return {
+      content: [{ type: 'text', text: responseText }],
+      doc: { docs, errors } as unknown as Record<string, unknown>,
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+    logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error deleting document from collection "${collectionSlug}": ${errorMessage}`,
+        },
+      ],
+    }
+  }
+})

package/src/mcp/builtin/collections/duplicateTool.ts

@@ -0,0 +1,134 @@
+import type { PopulateType, SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+} from '../../../utils/getVirtualFieldNames.js'
+import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
+import { formatCollectionError } from './formatCollectionError.js'
+
+const DEFAULT_DESCRIPTION =
+  'Duplicate a document in any collection by passing the collection slug and source document ID.'
+
+export const duplicateDocumentTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    title: 'Duplicate Document',
+  },
+  description: DEFAULT_DESCRIPTION,
+  input: z.object({
+    id: z.union([z.string(), z.number()]).describe('The ID of the document to duplicate'),
+    data: z
+      .record(z.string(), z.unknown())
+      .describe('Optional: fields to override on the duplicated document')
+      .optional(),
+    depth: z
+      .number()
+      .int()
+      .min(0)
+      .max(10)
+      .describe('How many levels deep to populate relationships in response')
+      .optional()
+      .default(0),
+    draft: z
+      .boolean()
+      .describe('Whether to create the duplicate as a draft')
+      .optional()
+      .default(false),
+    fallbackLocale: z
+      .string()
+      .describe('Optional: fallback locale code to use when requested locale is not available')
+      .optional(),
+    locale: z
+      .string()
+      .describe(
+        'Optional: locale code to duplicate in (e.g., "en", "es"). Defaults to the default locale',
+      )
+      .optional(),
+    populate: z
+      .record(z.string(), z.unknown())
+      .describe(
+        'Optional: control which fields to include from populated relationship or upload documents.',
+      )
+      .optional(),
+    select: z
+      .record(z.string(), z.unknown())
+      .describe(
+        'Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}',
+      )
+      .optional(),
+    selectedLocales: z
+      .array(z.string())
+      .describe('Optional: localized field locales to include in the duplicated document')
+      .optional(),
+    showHiddenFields: z
+      .boolean()
+      .describe('Optional: include hidden fields in the duplicated document response')
+      .optional(),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const {
+    id,
+    data,
+    depth,
+    draft,
+    fallbackLocale,
+    locale,
+    populate,
+    select,
+    selectedLocales,
+    showHiddenFields,
+  } = input
+
+  logger.info(`Duplicating document in collection: ${collectionSlug} with ID: ${id}`)
+
+  try {
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    const inputData = data ? stripVirtualFields(data, virtualFieldNames) : undefined
+    const parsedData = inputData ? transformPointDataToPayload(inputData) : undefined
+
+    const result = await payload.duplicate({
+      id,
+      collection: collectionSlug,
+      depth,
+      draft,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(parsedData ? { data: parsedData } : {}),
+      ...(locale ? { locale } : {}),
+      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(populate ? { populate: populate as PopulateType } : {}),
+      ...(select ? { select: select as SelectType } : {}),
+      ...(selectedLocales ? { selectedLocales } : {}),
+      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
+    })
+
+    logger.info(`Successfully duplicated document in ${collectionSlug} from ID: ${id}`)
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Document duplicated successfully in collection "${collectionSlug}"!\nDuplicated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+        },
+      ],
+      doc: result as Record<string, unknown>,
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+    logger.error(`Error duplicating document in ${collectionSlug}: ${errorMessage}`)
+    return formatCollectionError({ action: 'duplicating', collectionSlug, error, req })
+  }
+})

package/src/mcp/builtin/collections/fileInput.spec.ts

@@ -0,0 +1,93 @@
+import type { PayloadRequest } from 'payload'
+
+import { describe, expect, it } from 'vitest'
+
+import { fileInputSchema, resolveFile } from './fileInput.js'
+
+describe('MCP file input', () => {
+  it('should reject malformed MIME types', () => {
+    const result = fileInputSchema.safeParse({
+      data: 'aGVsbG8=',
+      mimeType: 'text/plain\r\nx-test: value',
+      name: 'hello.txt',
+      source: 'base64',
+    })
+
+    expect(result.success).toBe(false)
+  })
+
+  it('should accept a prepared upload', () => {
+    const result = fileInputSchema.safeParse({
+      file: {
+        filename: 'image.png',
+        mimeType: 'image/png',
+        size: 123,
+        uploadReference: { uploadId: 'upload-id' },
+      },
+      source: 'uploadReference',
+    })
+
+    expect(result.success).toBe(true)
+  })
+
+  it('should reject oversized base64 files', async () => {
+    const req = createRequest({ maxFileSize: 4 })
+
+    await expect(
+      resolveFile({
+        collectionSlug: 'media',
+        input: {
+          data: Buffer.from('hello').toString('base64'),
+          mimeType: 'text/plain',
+          name: 'hello.txt',
+          source: 'base64',
+        },
+        req,
+      }),
+    ).rejects.toThrow('File exceeds the 4 byte upload limit.')
+  })
+
+  it('should reject URLs outside the collection allowlist', async () => {
+    const req = createRequest({
+      allowList: [{ hostname: 'assets.example.com', protocol: 'https' }],
+    })
+
+    await expect(
+      resolveFile({
+        collectionSlug: 'media',
+        input: {
+          source: 'externalURL',
+          url: 'https://example.com/image.png',
+        },
+        req,
+      }),
+    ).rejects.toThrow('The provided file URL is not allowed.')
+  })
+})
+
+function createRequest({
+  allowList,
+  maxFileSize,
+}: {
+  allowList?: Array<{ hostname: string; protocol: 'http' | 'https' }>
+  maxFileSize?: number
+}): PayloadRequest {
+  return {
+    payload: {
+      collections: {
+        media: {
+          config: {
+            upload: allowList ? { pasteURL: { allowList } } : {},
+          },
+        },
+      },
+      config: {
+        upload: {
+          limits: {
+            fileSize: maxFileSize,
+          },
+        },
+      },
+    },
+  } as unknown as PayloadRequest
+}

package/src/mcp/builtin/collections/fileInput.ts

@@ -0,0 +1,164 @@
+import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'
+
+import { APIError } from 'payload'
+import { getExternalFile, getFileFromUploadInstructions, isURLAllowed } from 'payload/internal'
+import { sanitizeFilename } from 'payload/shared'
+import { z } from 'zod'
+
+const mimeTypeSchema = z
+  .string()
+  .regex(/^[!#$%&'*+.^`|~\w-]+\/[!#$%&'*+.^`|~\w-]+$/, 'MIME type must use the type/subtype format')
+
+const uploadFileSchema = z.object({
+  filename: z.string(),
+  mimeType: z.string(),
+  size: z.number().int().nonnegative(),
+  uploadReference: z.record(z.string(), z.unknown()),
+})
+
+export const fileInputSchema = z
+  .discriminatedUnion('source', [
+    z.object({
+      name: z.string().min(1).describe('The file name, including its extension'),
+      data: z.string().describe('The base64-encoded file bytes, without a data URL prefix'),
+      mimeType: mimeTypeSchema.describe('The file MIME type, for example image/png'),
+      source: z.literal('base64'),
+    }),
+    z.object({
+      name: z.string().min(1).describe('Optional file name override').optional(),
+      source: z.literal('externalURL'),
+      url: z.url().describe('The http or https URL to download'),
+    }),
+    z.object({
+      file: uploadFileSchema.describe('getUploadInstructions file field post-upload'),
+      source: z.literal('uploadReference'),
+    }),
+  ])
+  .describe(
+    'A file for an upload collection. Prefer uploadReference after its upload succeeds; use base64 only for small local files or externalURL for an online file.',
+  )
+
+type FileInput = z.infer<typeof fileInputSchema>
+
+export async function resolveFile({
+  collectionSlug,
+  input,
+  req,
+}: {
+  collectionSlug: CollectionSlug
+  input?: FileInput
+  req: PayloadRequest
+}): Promise<File | undefined> {
+  if (!input) {
+    return undefined
+  }
+
+  if (input.source === 'uploadReference') {
+    try {
+      return await getFileFromUploadInstructions({ collectionSlug, file: input.file, req })
+    } catch (error) {
+      if (error instanceof Error && error.message === 'Staged upload was not found.') {
+        throw new APIError(
+          'Staged upload not found. Complete the upload action first, or use base64 for small local files.',
+          400,
+        )
+      }
+      throw error
+    }
+  }
+
+  const uploadConfig = req.payload.collections[collectionSlug]?.config.upload
+
+  if (!uploadConfig) {
+    throw new APIError(`Collection "${collectionSlug}" does not support file uploads.`, 400)
+  }
+
+  const maxFileSize = req.payload.config.upload.limits?.fileSize
+  let file: File
+
+  if (input.source === 'base64') {
+    const data = decodeBase64({ maxFileSize, value: input.data })
+
+    file = {
+      name: sanitizeFilename(input.name),
+      data,
+      mimetype: input.mimeType,
+      size: data.length,
+    }
+  } else {
+    if (uploadConfig.pasteURL === false) {
+      throw new APIError(
+        `Uploading files from URLs is disabled for collection "${collectionSlug}".`,
+        400,
+      )
+    }
+
+    const url = new URL(input.url)
+
+    if (!['http:', 'https:'].includes(url.protocol)) {
+      throw new APIError('File URLs must use http or https.', 400)
+    }
+
+    if (
+      typeof uploadConfig.pasteURL === 'object' &&
+      !isURLAllowed(input.url, uploadConfig.pasteURL.allowList)
+    ) {
+      throw new APIError('The provided file URL is not allowed.', 400)
+    }
+
+    file = await getExternalFile({
+      data: {
+        filename: sanitizeFilename(input.name || getURLFilename(url)),
+        url: input.url,
+      } as FileData,
+      req,
+      uploadConfig: {
+        ...uploadConfig,
+        externalFileHeaderFilter: uploadConfig.externalFileHeaderFilter ?? (() => ({})),
+      },
+    })
+    file.mimetype = file.mimetype?.split(';')[0] || 'application/octet-stream'
+    file.size = file.data.length
+  }
+
+  if (maxFileSize !== undefined && Number.isFinite(maxFileSize) && file.size > maxFileSize) {
+    throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)
+  }
+
+  return file
+}
+
+function decodeBase64({ maxFileSize, value }: { maxFileSize?: number; value: string }): Buffer {
+  const normalized = value.replace(/\s/g, '')
+
+  if (!/^[a-z0-9+/]*={0,2}$/i.test(normalized) || normalized.length % 4 === 1) {
+    throw new APIError('File data must be valid base64.', 400)
+  }
+
+  if (maxFileSize !== undefined && Number.isFinite(maxFileSize)) {
+    const paddingLength = normalized.endsWith('==') ? 2 : normalized.endsWith('=') ? 1 : 0
+    const decodedSize = Math.floor((normalized.length * 3) / 4) - paddingLength
+
+    if (decodedSize > maxFileSize) {
+      throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)
+    }
+  }
+
+  const data = Buffer.from(normalized, 'base64')
+
+  if (data.toString('base64').replace(/=+$/, '') !== normalized.replace(/=+$/, '')) {
+    throw new APIError('File data must be valid base64.', 400)
+  }
+
+  return data
+}
+
+function getURLFilename(url: URL): string {
+  const pathSegment = url.pathname.split('/').pop() || 'upload'
+
+  try {
+    return decodeURIComponent(pathSegment)
+  } catch {
+    return pathSegment
+  }
+}