@payloadcms/plugin-mcp 4.0.0-internal.fa183d3 → 4.0.0-internal.fec2230

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

@@ -1,99 +1,97 @@
-import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'
-
-import { APIError } from 'payload'
-import { getExternalFile, isURLAllowed } from 'payload/internal'
+import type { CollectionSlug, File, PayloadRequest } from 'payload'
+
+import { APIError, z } from 'payload'
+import {
+  externalURLInputSchema,
+  getFileFromUploadInstructions,
+  resolveURLUploadInput,
+} 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')
+  .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.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'),
+    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.object({
-      name: z.string().min(1).describe('Optional file name override').optional(),
-      source: z.literal('url'),
-      url: z.url().describe('The http or https URL to download'),
+    externalURLInputSchema,
+    z.strictObject({
+      file: uploadFileSchema.check(z.describe('getUploadInstructions file field post-upload.')),
+      source: z.literal('uploadReference'),
     }),
   ])
-  .describe(
-    'A file for an upload collection. Use only a source listed by getCollectionSchema: url for an online file or base64 for a local file.',
+  .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 resolveFileInput({
-  collectionSlug,
+export async function resolveFile({
+  slug,
   input,
   req,
 }: {
-  collectionSlug: CollectionSlug
   input?: FileInput
   req: PayloadRequest
+  slug: CollectionSlug
 }): Promise<File | undefined> {
   if (!input) {
     return undefined
   }
 
-  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,
-      )
+  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 url = new URL(input.url)
+  if (input.source === 'externalURL') {
+    return resolveURLUploadInput({ slug, input, req })
+  }
 
-    if (!['http:', 'https:'].includes(url.protocol)) {
-      throw new APIError('File URLs must use http or https.', 400)
-    }
+  const uploadConfig = req.payload.collections[slug]?.config.upload
 
-    if (
-      typeof uploadConfig.pasteURL === 'object' &&
-      !isURLAllowed(input.url, uploadConfig.pasteURL.allowList)
-    ) {
-      throw new APIError('The provided file URL is not allowed.', 400)
-    }
+  if (!uploadConfig) {
+    throw new APIError(`Collection "${slug}" does not support file uploads.`, 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
+  const maxFileSize = req.payload.config.upload.limits?.fileSize
+  const data = decodeBase64({ maxFileSize, value: input.data })
+  const file: File = {
+    name: sanitizeFilename(input.name),
+    data,
+    mimetype: input.mimeType,
+    size: data.length,
   }
 
   if (maxFileSize !== undefined && Number.isFinite(maxFileSize) && file.size > maxFileSize) {
@@ -127,13 +125,3 @@ function decodeBase64({ maxFileSize, value }: { maxFileSize?: number; value: str
 
   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

@@ -1,18 +1,15 @@
-import type { PopulateType } from 'payload'
-
-import { z } from 'zod'
+import { findDistinctInputSchema } from 'payload'
 
 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 =
   '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.collectionSlug]?.read),
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.read),
   annotations: {
     destructiveHint: false,
     idempotentHint: true,
@@ -21,65 +18,17 @@ export const findDistinctTool = defineCollectionTool({
     title: 'Find Distinct',
   },
   description: DEFAULT_DESCRIPTION,
-  input: z.object({
-    depth: z
-      .number()
-      .int()
-      .min(0)
-      .max(10)
-      .describe('How many levels deep to populate relationships in distinct values')
-      .optional()
-      .default(0),
-    field: z.string().describe('The field path to get distinct values for'),
-    limit: z
-      .number()
-      .int()
-      .min(1)
-      .max(100)
-      .describe('Maximum number of distinct values to return (max: 100)')
-      .optional(),
-    locale: z
-      .string()
-      .describe(
-        'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
-      )
-      .optional(),
-    page: z.number().int().min(1).describe('Page number for pagination').optional(),
-    populate: z
-      .record(z.string(), z.unknown())
-      .describe(
-        'Optional: control which fields to include from populated relationship or upload documents.',
-      )
-      .optional(),
-    showHiddenFields: z
-      .boolean()
-      .describe('Optional: include hidden fields in the distinct query')
-      .optional(),
-    sort: z
-      .string()
-      .describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)')
-      .optional(),
-    trash: z
-      .boolean()
-      .describe('Optional: include soft-deleted documents when trash is enabled on the collection')
-      .optional(),
-    where: whereSchema
-      .describe(
-        'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
-      )
-      .optional(),
-  }),
-}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  input: findDistinctInputSchema,
+}).handler(async ({ slug, authorizedMCP, 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, sort, trash, where } = input
 
-  logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`)
+  logger.info(`Finding distinct values in collection: ${slug}, field: ${field}`)
 
   try {
     const result = await payload.findDistinct({
-      collection: collectionSlug,
+      collection: slug,
       depth,
       field,
       overrideAccess: authorizedMCP.overrideAccess,
@@ -87,8 +36,7 @@ export const findDistinctTool = defineCollectionTool({
       ...(limit ? { limit } : {}),
       ...(locale ? { locale } : {}),
       ...(page ? { page } : {}),
-      ...(populate ? { populate: populate as PopulateType } : {}),
-      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
+      ...(populate ? { populate } : {}),
       ...(sort ? { sort } : {}),
       ...(trash !== undefined ? { trash } : {}),
       ...(where ? { where } : {}),
@@ -98,19 +46,19 @@ export const findDistinctTool = defineCollectionTool({
       content: [
         {
           type: 'text',
-          text: `Distinct values for "${field}" in collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          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 ${collectionSlug}: ${errorMessage}`)
+    logger.error(`Error finding distinct values in ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `❌ **Error finding distinct values in collection "${collectionSlug}":** ${errorMessage}`,
+          text: `❌ **Error finding distinct values in collection "${slug}":** ${errorMessage}`,
         },
       ],
       isError: true,

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

@@ -1,18 +1,15 @@
-import type { JoinQuery, PopulateType, SelectType } from 'payload'
-
-import { z } from 'zod'
+import { findDocumentsInputSchema, parseDocumentID } from 'payload'
 
 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 =
   'Find documents in any collection by passing the collection slug and optional ID or where clause.'
 
 export const findDocumentsTool = defineCollectionTool({
   access: (args) =>
-    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.read),
   annotations: {
     destructiveHint: false,
     idempotentHint: true,
@@ -21,87 +18,8 @@ export const findDocumentsTool = defineCollectionTool({
     title: 'Find Documents',
   },
   description: DEFAULT_DESCRIPTION,
-  input: z.object({
-    id: z
-      .union([z.string(), z.number()])
-      .describe(
-        'Optional: specific document ID to retrieve. If not provided, returns all documents',
-      )
-      .optional(),
-    depth: z
-      .number()
-      .int()
-      .min(0)
-      .max(10)
-      .describe('How many levels deep to populate relationships (default: 0)')
-      .optional()
-      .default(0),
-    draft: z
-      .boolean()
-      .describe(
-        'For versioned collections, true returns the latest draft version when available. False reads the main document.',
-      )
-      .optional(),
-    fallbackLocale: z
-      .string()
-      .describe('Optional: fallback locale code to use when requested locale is not available')
-      .optional(),
-    joins: z
-      .union([z.record(z.string(), z.unknown()), z.literal(false)])
-      .describe('Optional: configure join field queries, or pass false to disable all join fields.')
-      .optional(),
-    limit: z
-      .number()
-      .int()
-      .min(1)
-      .max(100)
-      .describe('Maximum number of documents to return (default: 10, max: 100)')
-      .optional()
-      .default(10),
-    locale: z
-      .string()
-      .describe(
-        'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
-      )
-      .optional(),
-    page: z
-      .number()
-      .int()
-      .min(1)
-      .describe('Page number for pagination (default: 1)')
-      .optional()
-      .default(1),
-    pagination: z
-      .boolean()
-      .describe('Optional: set to false to skip the count query overhead')
-      .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(),
-    sort: z
-      .string()
-      .describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)')
-      .optional(),
-    trash: z
-      .boolean()
-      .describe('Optional: include soft-deleted documents when trash is enabled on the collection')
-      .optional(),
-    where: whereSchema
-      .describe(
-        'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
-      )
-      .optional(),
-  }),
-}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  input: findDocumentsInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
 
@@ -123,23 +41,23 @@ export const findDocumentsTool = defineCollectionTool({
   } = input
 
   logger.info(
-    `Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
+    `Reading document from collection: ${slug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
   )
 
   try {
-    if (id) {
+    if (id !== undefined) {
       try {
         const doc = await payload.findByID({
-          id,
-          collection: collectionSlug,
+          id: parseDocumentID({ id, collectionSlug: slug, payload }),
+          collection: slug,
           depth,
           overrideAccess: authorizedMCP.overrideAccess,
           req,
-          ...(select && { select: select as SelectType }),
-          ...(populate && { populate: populate as PopulateType }),
-          ...(joins !== undefined && { joins: joins as JoinQuery }),
+          ...(select && { select }),
+          ...(populate && { populate }),
+          ...(joins !== undefined && { joins }),
           ...(locale && { locale }),
-          ...(fallbackLocale && { fallbackLocale }),
+          ...(fallbackLocale !== undefined && { fallbackLocale }),
           ...(draft !== undefined && { draft }),
           ...(trash !== undefined && { trash }),
         })
@@ -148,18 +66,18 @@ export const findDocumentsTool = defineCollectionTool({
           content: [
             {
               type: 'text',
-              text: `Document from collection "${collectionSlug}":\n${JSON.stringify(doc)}`,
+              text: `Document from collection "${slug}":\n${JSON.stringify(doc)}`,
             },
           ],
           doc: doc as Record<string, unknown>,
         }
       } catch {
-        logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`)
+        logger.warn(`Document not found with ID: ${id} in collection: ${slug}`)
         return {
           content: [
             {
               type: 'text',
-              text: `Error: Document with ID "${id}" not found in collection "${collectionSlug}"`,
+              text: `Error: Document with ID "${id}" not found in collection "${slug}"`,
             },
           ],
         }
@@ -167,17 +85,17 @@ export const findDocumentsTool = defineCollectionTool({
     }
 
     const findOptions: Parameters<typeof payload.find>[0] = {
-      collection: collectionSlug,
+      collection: slug,
       depth,
       limit,
       overrideAccess: authorizedMCP.overrideAccess,
       page,
       req,
-      ...(select && { select: select as SelectType }),
-      ...(populate && { populate: populate as PopulateType }),
-      ...(joins !== undefined && { joins: joins as JoinQuery }),
+      ...(select && { select }),
+      ...(populate && { populate }),
+      ...(joins !== undefined && { joins }),
       ...(locale && { locale }),
-      ...(fallbackLocale && { fallbackLocale }),
+      ...(fallbackLocale !== undefined && { fallbackLocale }),
       ...(draft !== undefined && { draft }),
       ...(pagination !== undefined && { pagination }),
       ...(trash !== undefined && { trash }),
@@ -192,7 +110,7 @@ export const findDocumentsTool = defineCollectionTool({
 
     const result = await payload.find(findOptions)
 
-    let responseText = `Collection: "${collectionSlug}"\nTotal: ${result.totalDocs} documents\nPage: ${result.page} of ${result.totalPages}\n`
+    let responseText = `Collection: "${slug}"\nTotal: ${result.totalDocs} documents\nPage: ${result.page} of ${result.totalPages}\n`
     for (const doc of result.docs) {
       responseText += `\n\`\`\`json\n${JSON.stringify(doc)}\n\`\`\``
     }
@@ -203,12 +121,12 @@ export const findDocumentsTool = defineCollectionTool({
     }
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-    logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`)
+    logger.error(`Error reading documents from collection ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `❌ **Error reading documents from collection "${collectionSlug}":** ${errorMessage}`,
+          text: `❌ **Error reading documents from collection "${slug}":** ${errorMessage}`,
         },
       ],
     }

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

@@ -1,6 +1,4 @@
-import type { PopulateType, SelectType } from 'payload'
-
-import { z } from 'zod'
+import { findVersionByIDInputSchema } from 'payload'
 
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
@@ -11,8 +9,7 @@ const DEFAULT_DESCRIPTION =
 
 export const findVersionByIDTool = defineCollectionTool({
   access: (args) =>
-    defaultAccess(args) &&
-    Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.readVersions),
   annotations: {
     destructiveHint: false,
     idempotentHint: true,
@@ -21,66 +18,26 @@ export const findVersionByIDTool = defineCollectionTool({
     title: 'Find Version By ID',
   },
   description: DEFAULT_DESCRIPTION,
-  input: z.object({
-    id: z.string().describe('The ID of the version to retrieve'),
-    depth: z
-      .number()
-      .int()
-      .min(0)
-      .max(10)
-      .describe('How many levels deep to populate relationships in the version document')
-      .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 to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
-      )
-      .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., {"version.title": true}',
-      )
-      .optional(),
-    showHiddenFields: z
-      .boolean()
-      .describe('Optional: include hidden fields in the returned version document')
-      .optional(),
-    trash: z
-      .boolean()
-      .describe('Optional: include soft-deleted version documents when trash is enabled')
-      .optional(),
-  }),
-}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  input: findVersionByIDInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
-  const { id, depth, fallbackLocale, locale, populate, select, showHiddenFields, trash } = input
+  const { id, depth, draft, fallbackLocale, locale, populate, select, trash } = input
 
-  logger.info(`Finding version in collection: ${collectionSlug} with ID: ${id}`)
+  logger.info(`Finding version in collection: ${slug} with ID: ${id}`)
 
   try {
     const result = await payload.findVersionByID({
-      id,
-      collection: collectionSlug,
+      id: String(id),
+      collection: slug,
       depth,
       overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(draft !== undefined ? { draft } : {}),
+      ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
       ...(locale ? { locale } : {}),
-      ...(populate ? { populate: populate as PopulateType } : {}),
-      ...(select ? { select: select as SelectType } : {}),
-      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
+      ...(populate ? { populate } : {}),
+      ...(select ? { select } : {}),
       ...(trash !== undefined ? { trash } : {}),
     })
 
@@ -88,19 +45,19 @@ export const findVersionByIDTool = defineCollectionTool({
       content: [
         {
           type: 'text',
-          text: `Version "${id}" from collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          text: `Version "${id}" from 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 version ${id} in ${collectionSlug}: ${errorMessage}`)
+    logger.error(`Error finding version ${id} in ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `❌ **Error finding version "${id}" in collection "${collectionSlug}":** ${errorMessage}`,
+          text: `❌ **Error finding version "${id}" in collection "${slug}":** ${errorMessage}`,
         },
       ],
       isError: true,