@payloadcms/plugin-mcp 4.0.0-internal.811e0a4 → 4.0.0-internal.8867dba

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

@@ -3,7 +3,6 @@ import { z } from 'zod'
 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 =
@@ -22,10 +21,7 @@ export const countVersionsTool = defineCollectionTool({
   },
   description: DEFAULT_DESCRIPTION,
   input: z.object({
-    locale: z
-      .string()
-      .describe('Optional: locale code to count versions in')
-      .optional(),
+    locale: z.string().describe('Optional: locale code to count versions in').optional(),
     where: whereSchema
       .describe(
         'Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.title":{"contains":"test"}}',
@@ -42,8 +38,8 @@ export const countVersionsTool = defineCollectionTool({
   try {
     const result = await payload.countVersions({
       collection: collectionSlug,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(locale ? { locale } : {}),
       ...(where ? { where } : {}),
     })

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

@@ -9,13 +9,13 @@ import {
   getCollectionVirtualFieldNames,
   stripVirtualFields,
 } from '../../../utils/getVirtualFieldNames.js'
-import { localAPIDefaults } from '../../../utils/localAPIDefaults.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 a document in any collection. Files can use a URL, base64, or an upload prepared by getUploadInstructions.'
 
 export const createDocumentTool = defineCollectionTool({
   access: (args) =>
@@ -29,7 +29,11 @@ export const createDocumentTool = defineCollectionTool({
   },
   description: DEFAULT_DESCRIPTION,
   input: z.object({
-    data: z.record(z.string(), z.unknown()).describe('The document fields to create'),
+    data: z
+      .record(z.string(), z.unknown())
+      .describe(
+        'The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.',
+      ),
     depth: z
       .number()
       .int()
@@ -40,13 +44,16 @@ export const createDocumentTool = defineCollectionTool({
       .default(0),
     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
       .string()
       .describe('Optional: fallback locale code to use when requested locale is not available')
       .optional(),
+    file: fileInputSchema.optional(),
     locale: z
       .string()
       .describe(
@@ -64,7 +71,7 @@ export const createDocumentTool = defineCollectionTool({
   const payload = req.payload
   const logger = getLogger({ payload })
 
-  const { data, depth, draft, fallbackLocale, locale, select } = input
+  const { data, depth, draft, fallbackLocale, file: fileInput, locale, select } = input
 
   logger.info(
     `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,
@@ -80,14 +87,16 @@ export const createDocumentTool = defineCollectionTool({
     }
 
     const parsedData = transformPointDataToPayload(inputData)
+    const file = await resolveFile({ collectionSlug, input: fileInput, req })
 
     const result = await payload.create({
       collection: collectionSlug,
       data: parsedData,
       depth,
       draft,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
+      ...(file ? { file } : {}),
       ...(locale ? { locale } : {}),
       ...(fallbackLocale ? { fallbackLocale } : {}),
       ...(select ? { select: select as SelectType } : {}),

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

@@ -3,7 +3,6 @@ import { z } from 'zod'
 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 =
@@ -69,8 +68,8 @@ export const deleteDocumentsTool = defineCollectionTool({
     const deleteOptions: Record<string, unknown> = {
       collection: collectionSlug,
       depth,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(locale && { locale }),
       ...(fallbackLocale && { fallbackLocale }),
     }

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

@@ -9,7 +9,6 @@ import {
   getCollectionVirtualFieldNames,
   stripVirtualFields,
 } from '../../../utils/getVirtualFieldNames.js'
-import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
 import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
 import { formatCollectionError } from './formatCollectionError.js'
 
@@ -105,8 +104,8 @@ export const duplicateDocumentTool = defineCollectionTool({
       collection: collectionSlug,
       depth,
       draft,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(parsedData ? { data: parsedData } : {}),
       ...(locale ? { locale } : {}),
       ...(fallbackLocale ? { fallbackLocale } : {}),

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,154 @@
+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('The file value returned by getUploadInstructions'),
+      source: z.literal('uploadReference'),
+    }),
+  ])
+  .describe(
+    'A file for an upload collection. Use externalURL for an online file, base64 for local file bytes, or uploadReference after following getUploadInstructions. Usage of getUploadInstructions and uploadReference is recommended.',
+  )
+
+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') {
+    return getFileFromUploadInstructions({ collectionSlug, file: input.file, req })
+  }
+
+  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/findDistinctTool.ts

@@ -5,7 +5,6 @@ import { z } from 'zod'
 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 =
@@ -73,7 +72,8 @@ export const findDistinctTool = defineCollectionTool({
 }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
-  const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } = input
+  const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } =
+    input
 
   logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`)
 
@@ -82,8 +82,8 @@ export const findDistinctTool = defineCollectionTool({
       collection: collectionSlug,
       depth,
       field,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(limit ? { limit } : {}),
       ...(locale ? { locale } : {}),
       ...(page ? { page } : {}),

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

@@ -5,7 +5,6 @@ import { z } from 'zod'
 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 =
@@ -40,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
@@ -134,8 +133,8 @@ export const findDocumentsTool = defineCollectionTool({
           id,
           collection: collectionSlug,
           depth,
+          overrideAccess: authorizedMCP.overrideAccess,
           req,
-          ...localAPIDefaults(authorizedMCP),
           ...(select && { select: select as SelectType }),
           ...(populate && { populate: populate as PopulateType }),
           ...(joins !== undefined && { joins: joins as JoinQuery }),
@@ -171,9 +170,9 @@ export const findDocumentsTool = defineCollectionTool({
       collection: collectionSlug,
       depth,
       limit,
+      overrideAccess: authorizedMCP.overrideAccess,
       page,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(select && { select: select as SelectType }),
       ...(populate && { populate: populate as PopulateType }),
       ...(joins !== undefined && { joins: joins as JoinQuery }),

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

@@ -5,7 +5,6 @@ import { z } from 'zod'
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
 import { getLogger } from '../../../utils/getLogger.js'
-import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
 
 const DEFAULT_DESCRIPTION =
   'Find a specific document version in any version-enabled collection by passing the collection slug and version ID.'
@@ -75,8 +74,8 @@ export const findVersionByIDTool = defineCollectionTool({
       id,
       collection: collectionSlug,
       depth,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(fallbackLocale ? { fallbackLocale } : {}),
       ...(locale ? { locale } : {}),
       ...(populate ? { populate: populate as PopulateType } : {}),

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

@@ -5,7 +5,6 @@ import { z } from 'zod'
 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 =
@@ -116,9 +115,9 @@ export const findVersionsTool = defineCollectionTool({
       collection: collectionSlug,
       depth,
       limit,
+      overrideAccess: authorizedMCP.overrideAccess,
       page,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(fallbackLocale ? { fallbackLocale } : {}),
       ...(locale ? { locale } : {}),
       ...(pagination !== undefined ? { pagination } : {}),

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

@@ -1,3 +1,5 @@
+import { getAccessResults } from 'payload'
+
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
 import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
@@ -6,12 +8,7 @@ export const getCollectionSchemaTool = defineCollectionTool({
   access: (args) => {
     const permissions = args.permissions?.collections?.[args.collectionSlug]
 
-    return (
-      defaultAccess(args) &&
-      Boolean(
-        permissions?.create || permissions?.delete || permissions?.read || permissions?.update,
-      )
-    )
+    return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)
   },
   annotations: {
     destructiveHint: false,
@@ -21,8 +18,28 @@ export const getCollectionSchemaTool = defineCollectionTool({
     title: 'Get Collection Schema',
   },
   description: 'Get the input schema for creating or updating documents in a collection.',
-}).handler(({ collectionSlug, req }) => {
-  const inputSchema = getCollectionInputSchema({ collectionSlug, req })
+}).handler(async ({ authorizedMCP, collectionSlug, req }) => {
+  const permissions = authorizedMCP.overrideAccess
+    ? null
+    : (await getAccessResults({ req })).collections?.[collectionSlug]
+
+  if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${collectionSlug}"`,
+        },
+      ],
+      isError: true,
+    }
+  }
+
+  const inputSchema = getCollectionInputSchema({
+    collectionSlug,
+    req,
+    ...(permissions ? { permissions } : {}),
+  })
 
   if (!inputSchema) {
     return {
@@ -31,16 +48,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/restoreVersionTool.ts

@@ -5,7 +5,6 @@ import { z } from 'zod'
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
 import { getLogger } from '../../../utils/getLogger.js'
-import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
 
 const DEFAULT_DESCRIPTION =
   'Restore a document from a previous version in any version-enabled collection.'
@@ -74,8 +73,8 @@ export const restoreVersionTool = defineCollectionTool({
       collection: collectionSlug,
       depth,
       draft,
+      overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...localAPIDefaults(authorizedMCP),
       ...(fallbackLocale ? { fallbackLocale } : {}),
       ...(locale ? { locale } : {}),
       ...(populate ? { populate: populate as PopulateType } : {}),