@payloadcms/plugin-mcp 4.0.0-canary.3 → 4.0.0-canary.31

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

@@ -1,14 +1,15 @@
-import { z } from 'zod'
+import { deleteDocumentsInputSchema, parseDocumentID } from 'payload'
 
+import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
 import { getLogger } from '../../../utils/getLogger.js'
-import { localAPIDefaults } from '../../../utils/localAPIDefaults.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.slug]?.delete),
   annotations: {
     destructiveHint: true,
     idempotentHint: false,
@@ -17,86 +18,59 @@ export const deleteDocumentsTool = defineCollectionTool({
     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 }) => {
+  input: deleteDocumentsInputSchema,
+}).handler(async ({ slug, authorizedMCP, 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}` : ''}`,
+    `Deleting document from collection: ${slug}${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,
-      req,
-      ...localAPIDefaults(authorizedMCP),
-      ...(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 !== undefined) {
+      const result = await payload.delete({
+        id: parseDocumentID({ id, collectionSlug: slug, payload }),
+        collection: slug,
+        depth,
+        overrideAccess: authorizedMCP.overrideAccess,
+        req,
+        ...(locale && { locale }),
+        ...(fallbackLocale !== undefined && { fallbackLocale }),
+      })
 
-    if (id) {
       return {
         content: [
           {
             type: 'text',
-            text: `Document deleted successfully from collection "${collectionSlug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+            text: `Document deleted successfully from collection "${slug}"!\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 || []
+    if (where === undefined) {
+      return {
+        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],
+      }
+    }
+
+    const result = await payload.delete({
+      collection: slug,
+      depth,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      where,
+      ...(locale && { locale }),
+      ...(fallbackLocale !== undefined && { fallbackLocale }),
+    })
+    const docs = result.docs || []
+    const errors = result.errors || []
 
-    let responseText = `Document deleted successfully from collection "${collectionSlug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`
+    let responseText = `Document deleted successfully from collection "${slug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`
     if (docs.length > 0) {
       responseText += `\n\nDeleted documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``
     }
@@ -110,12 +84,12 @@ export const deleteDocumentsTool = defineCollectionTool({
     }
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-    logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`)
+    logger.error(`Error deleting document from ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `Error deleting document from collection "${collectionSlug}": ${errorMessage}`,
+          text: `Error deleting document from collection "${slug}": ${errorMessage}`,
         },
       ],
     }

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

@@ -0,0 +1,84 @@
+import {
+  duplicateDocumentInputSchema,
+  getCollectionVirtualFieldNames,
+  parseDocumentID,
+  stripVirtualFields,
+  transformPointDataToPayload,
+  validateCollectionData,
+} from 'payload'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import { formatEntityError } from '../formatEntityError.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.slug]?.create),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    title: 'Duplicate Document',
+  },
+  description: DEFAULT_DESCRIPTION,
+  input: duplicateDocumentInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const { id, data, depth, draft, fallbackLocale, locale, populate, select, selectedLocales } =
+    input
+
+  logger.info(`Duplicating document in collection: ${slug} with ID: ${id}`)
+
+  try {
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)
+    const inputData = data ? stripVirtualFields(data, virtualFieldNames) : undefined
+
+    if (inputData) {
+      validateCollectionData({
+        slug,
+        data: inputData,
+        partial: true,
+        req,
+      })
+    }
+
+    const parsedData = inputData ? transformPointDataToPayload(inputData) : undefined
+
+    const result = await payload.duplicate({
+      id: parseDocumentID({ id, collectionSlug: slug, payload }),
+      collection: slug,
+      depth,
+      draft,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(parsedData ? { data: parsedData } : {}),
+      ...(locale ? { locale } : {}),
+      ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
+      ...(populate ? { populate } : {}),
+      ...(select ? { select } : {}),
+      ...(selectedLocales ? { selectedLocales } : {}),
+    })
+
+    logger.info(`Successfully duplicated document in ${slug} from ID: ${id}`)
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Document duplicated successfully in collection "${slug}"!\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 ${slug}: ${errorMessage}`)
+    return formatEntityError({ slug, action: 'duplicating', entity: 'collection', 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({
+        slug: '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({
+        slug: '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,169 @@
+import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'
+
+import { APIError, z } from 'payload'
+import { getExternalFile, getFileFromUploadInstructions, isURLAllowed } from 'payload/internal'
+import { sanitizeFilename } from 'payload/shared'
+
+const mimeTypeSchema = z
+  .string()
+  .check(
+    z.regex(
+      /^[!#$%&'*+.^`|~\w-]+\/[!#$%&'*+.^`|~\w-]+$/,
+      'MIME type must use the type/subtype format',
+    ),
+  )
+
+const uploadFileSchema = z.strictObject({
+  filename: z.string(),
+  mimeType: z.string(),
+  size: z.int().check(z.nonnegative()),
+  uploadReference: z.record(z.string(), z.unknown()),
+})
+
+export const fileInputSchema = z
+  .discriminatedUnion('source', [
+    z.strictObject({
+      name: z.string().check(z.minLength(1), z.describe('The file name, including its extension.')),
+      data: z
+        .string()
+        .check(z.describe('The base64-encoded file bytes, without a data URL prefix.')),
+      mimeType: mimeTypeSchema.check(z.describe('The file MIME type, for example image/png.')),
+      source: z.literal('base64'),
+    }),
+    z.strictObject({
+      name: z.optional(z.string().check(z.minLength(1))).check(z.describe('File name override.')),
+      source: z.literal('externalURL'),
+      url: z.url().check(z.describe('The http or https URL to download.')),
+    }),
+    z.strictObject({
+      file: uploadFileSchema.check(z.describe('getUploadInstructions file field post-upload.')),
+      source: z.literal('uploadReference'),
+    }),
+  ])
+  .check(
+    z.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({
+  slug,
+  input,
+  req,
+}: {
+  input?: FileInput
+  req: PayloadRequest
+  slug: CollectionSlug
+}): Promise<File | undefined> {
+  if (!input) {
+    return undefined
+  }
+
+  if (input.source === 'uploadReference') {
+    try {
+      return await getFileFromUploadInstructions({ collectionSlug: slug, 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[slug]?.config.upload
+
+  if (!uploadConfig) {
+    throw new APIError(`Collection "${slug}" 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 "${slug}".`, 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/findDistinctTool.ts

@@ -0,0 +1,67 @@
+import { findDistinctInputSchema } from 'payload'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+
+const DEFAULT_DESCRIPTION =
+  'Find distinct values for a field in any collection by passing the collection slug and field path.'
+
+export const findDistinctTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.read),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: false,
+    readOnlyHint: true,
+    title: 'Find Distinct',
+  },
+  description: DEFAULT_DESCRIPTION,
+  input: findDistinctInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const { depth, field, limit, locale, page, populate, sort, trash, where } = input
+
+  logger.info(`Finding distinct values in collection: ${slug}, field: ${field}`)
+
+  try {
+    const result = await payload.findDistinct({
+      collection: slug,
+      depth,
+      field,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(limit ? { limit } : {}),
+      ...(locale ? { locale } : {}),
+      ...(page ? { page } : {}),
+      ...(populate ? { populate } : {}),
+      ...(sort ? { sort } : {}),
+      ...(trash !== undefined ? { trash } : {}),
+      ...(where ? { where } : {}),
+    })
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Distinct values for "${field}" in collection "${slug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+        },
+      ],
+      doc: result as unknown as Record<string, unknown>,
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+    logger.error(`Error finding distinct values in ${slug}: ${errorMessage}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `❌ **Error finding distinct values in collection "${slug}":** ${errorMessage}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+})