@payloadcms/plugin-mcp 4.0.0-internal.5214550 → 4.0.0-internal.532221d

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

@@ -1,22 +1,23 @@
 import type { SelectType } from 'payload'
 
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+  transformPointDataToPayload,
+} 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 a document in any collection by passing the collection slug and data.'
+  '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 createDocumentTool = defineCollectionTool({
+export const createDocumentsTool = defineCollectionTool({
   access: (args) =>
     defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
   annotations: {
@@ -24,11 +25,10 @@ export const createDocumentTool = defineCollectionTool({
     idempotentHint: false,
     openWorldHint: false,
     readOnlyHint: false,
-    title: 'Create Document',
+    title: 'Create Documents',
   },
   description: DEFAULT_DESCRIPTION,
   input: z.object({
-    data: z.record(z.string(), z.unknown()).describe('The document fields to create'),
     depth: z
       .number()
       .int()
@@ -37,9 +37,24 @@ export const createDocumentTool = defineCollectionTool({
       .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('Whether to create the document as a draft')
+      .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
@@ -49,7 +64,7 @@ export const createDocumentTool = defineCollectionTool({
     locale: z
       .string()
       .describe(
-        'Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale',
+        'Optional: locale code to create the documents in (e.g., "en", "es"). Defaults to the default locale',
       )
       .optional(),
     select: z
@@ -62,50 +77,92 @@ export const createDocumentTool = defineCollectionTool({
 }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
+  const { depth, documents, draft, fallbackLocale, locale, select } = input
 
-  const { data, depth, draft, fallbackLocale, locale, select } = input
-
-  logger.info(
-    `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,
-  )
+  logger.info(`Creating ${documents.length} documents in collection: ${collectionSlug}`)
 
   try {
     const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
-    const inputData = stripVirtualFields(data, virtualFieldNames)
-    const validationError = validateCollectionData({ collectionSlug, data: inputData, req })
+    const docs: Array<{ doc: Record<string, unknown>; index: number }> = []
+    const errors: Array<{ index: number; message: string }> = []
+    let validationSchema: Record<string, unknown> | undefined
 
-    if (validationError) {
-      return validationError
-    }
+    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
 
-    const parsedData = transformPointDataToPayload(inputData)
+          if (!validationSchema && schema && typeof schema === 'object') {
+            validationSchema = schema as Record<string, unknown>
+          }
 
-    const result = await payload.create({
-      collection: collectionSlug,
-      data: parsedData,
-      depth,
-      draft,
-      overrideAccess: authorizedMCP.overrideAccess,
-      req,
-      ...(locale ? { locale } : {}),
-      ...(fallbackLocale ? { fallbackLocale } : {}),
-      ...(select ? { select: select as SelectType } : {}),
-    })
+          errors.push({
+            index,
+            message:
+              firstContent?.type === 'text'
+                ? (firstContent.text.split('\n\nUse this schema')[0] ?? 'Invalid document data')
+                : 'Invalid document data',
+          })
+          continue
+        }
 
-    logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)
+        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: `Document created successfully in collection "${collectionSlug}"!\nCreated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          text: `Created ${docs.length} of ${documents.length} documents in collection "${collectionSlug}".${retryMessage}\nResults:\n\`\`\`json\n${JSON.stringify(batchResult)}\n\`\`\`${schemaMessage}`,
         },
       ],
-      doc: result as Record<string, unknown>,
+      doc: structuredContent as unknown as Record<string, unknown>,
+      isError: docs.length === 0 && errors.length > 0,
+      structuredContent,
     }
   } catch (error) {
-    const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-    logger.error(`Error creating document in ${collectionSlug}: ${errorMessage}`)
+    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/duplicateTool.ts

@@ -1,15 +1,15 @@
 import type { PopulateType, SelectType } from 'payload'
 
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+  transformPointDataToPayload,
+} 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 =

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
+  }
+}

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

@@ -39,7 +39,7 @@ export const findDocumentsTool = defineCollectionTool({
     draft: z
       .boolean()
       .describe(
-        'Optional: whether the document should be queried from the versions table/collection or not.',
+        'For versioned collections, true returns the latest draft version when available. False reads the main document.',
       )
       .optional(),
     fallbackLocale: z

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

@@ -1,8 +1,8 @@
 import type { CollectionSlug, PayloadRequest } from 'payload'
 
-import type { MCPToolResponse } from '../../../types.js'
+import { getCollectionInputSchema } from 'payload'
 
-import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
+import type { MCPToolResponse } from '../../../types.js'
 
 const getValidationErrors = (error: unknown): undefined | unknown[] => {
   if (!error || typeof error !== 'object') {

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

@@ -1,8 +1,7 @@
-import { getAccessResults } from 'payload'
+import { getAccessResults, getCollectionInputSchema } from 'payload'
 
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
-import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
 
 export const getCollectionSchemaTool = defineCollectionTool({
   access: (args) => {
@@ -48,16 +47,33 @@ export const getCollectionSchemaTool = defineCollectionTool({
     }
   }
 
+  const uploadConfig = req.payload.collections[collectionSlug]?.config.upload
+  const maxFileSize = req.payload.config.upload.limits?.fileSize
+  const upload = uploadConfig
+    ? {
+        enabled: true,
+        filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,
+        mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],
+        sources: [
+          ...(uploadConfig.pasteURL !== false ? ['externalURL'] : []),
+          'base64',
+          'uploadReference',
+        ],
+        ...(typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? { maxFileSize } : {}),
+      }
+    : { enabled: false }
+
   return {
     content: [
       {
         type: 'text',
-        text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``,
+        text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``,
       },
     ],
     structuredContent: {
       collectionSlug,
       schema: inputSchema,
+      upload,
     },
   }
 })

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

@@ -1,22 +1,23 @@
 import type { SelectType, Where } from 'payload'
 
+import {
+  getCollectionInputSchema,
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+  transformPointDataToPayload,
+} 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 { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
-import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
 import { whereSchema } from '../../../utils/whereSchema.js'
 import { validateCollectionData } from '../validateEntityData.js'
+import { fileInputSchema, resolveFile } from './fileInput.js'
 import { formatCollectionError } from './formatCollectionError.js'
 
 const DEFAULT_DESCRIPTION =
-  'Update documents in any collection by passing the collection slug and data.'
+  'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'
 
 export const updateDocumentTool = defineCollectionTool({
   access: (args) =>
@@ -31,7 +32,11 @@ export const updateDocumentTool = defineCollectionTool({
   description: DEFAULT_DESCRIPTION,
   input: z.object({
     id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),
-    data: z.record(z.string(), z.unknown()).describe('The fields to update'),
+    data: z
+      .record(z.string(), z.unknown())
+      .describe(
+        'The fields to update. Only include fields permitted by the schema returned by getCollectionSchema.',
+      ),
     depth: z
       .number()
       .describe('How many levels deep to populate relationships')
@@ -39,14 +44,16 @@ export const updateDocumentTool = defineCollectionTool({
       .default(0),
     draft: z
       .boolean()
-      .describe('Whether to update the document as a draft')
+      .describe(
+        'Only if getCollectionSchema includes _status; otherwise _status does not exist. true saves only a draft version; false updates main and versions. data._status: "published" overrides true.',
+      )
       .optional()
       .default(false),
     fallbackLocale: z
       .string()
       .describe('Optional: fallback locale code to use when requested locale is not available')
       .optional(),
-    filePath: z.string().describe('File path for file uploads').optional(),
+    file: fileInputSchema.optional(),
     locale: z
       .string()
       .describe(
@@ -63,6 +70,12 @@ export const updateDocumentTool = defineCollectionTool({
       .describe('Whether to overwrite existing files')
       .optional()
       .default(false),
+    publishAllLocales: z
+      .boolean()
+      .describe(
+        'For collections with localized publishing status, whether publishing should affect every locale. Set false with locale to publish only that locale.',
+      )
+      .optional(),
     select: z
       .record(z.string(), z.unknown())
       .describe(
@@ -85,10 +98,11 @@ export const updateDocumentTool = defineCollectionTool({
     depth,
     draft,
     fallbackLocale,
-    filePath,
+    file: fileInput,
     locale,
     overrideLock,
     overwriteExistingFiles,
+    publishAllLocales,
     select,
     where,
   } = input
@@ -118,6 +132,7 @@ export const updateDocumentTool = defineCollectionTool({
     }
 
     const parsedData = transformPointDataToPayload(inputData)
+    const file = await resolveFile({ collectionSlug, input: fileInput, req })
 
     const whereClause: Where = where ?? {}
 
@@ -131,8 +146,9 @@ export const updateDocumentTool = defineCollectionTool({
         overrideAccess: authorizedMCP.overrideAccess,
         overrideLock,
         req,
-        ...(filePath ? { filePath } : {}),
+        ...(file ? { file } : {}),
         ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+        ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
         ...(locale ? { locale } : {}),
         ...(fallbackLocale ? { fallbackLocale } : {}),
         ...(select ? { select: select as SelectType } : {}),
@@ -158,8 +174,9 @@ export const updateDocumentTool = defineCollectionTool({
       overrideLock,
       req,
       where: whereClause,
-      ...(filePath ? { filePath } : {}),
+      ...(file ? { file } : {}),
       ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+      ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
       ...(locale ? { locale } : {}),
       ...(fallbackLocale ? { fallbackLocale } : {}),
       ...(select ? { select: select as SelectType } : {}),