@payloadcms/plugin-mcp 4.0.0-internal.cd69eef → 4.0.0-internal.ce66a41

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

@@ -1,6 +1,4 @@
-import type { PopulateType, SelectType } from 'payload'
-
-import { z } from 'zod'
+import { restoreVersionInputSchema } from 'payload'
 
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineCollectionTool } from '../../../defineTool.js'
@@ -11,7 +9,7 @@ const DEFAULT_DESCRIPTION =
 
 export const restoreVersionTool = defineCollectionTool({
   access: (args) =>
-    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
   annotations: {
     destructiveHint: true,
     idempotentHint: false,
@@ -20,85 +18,45 @@ export const restoreVersionTool = defineCollectionTool({
     title: 'Restore Version',
   },
   description: DEFAULT_DESCRIPTION,
-  input: z.object({
-    id: z.string().describe('The ID of the version to restore'),
-    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 restore the version 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 restore in (e.g., "en", "es")')
-      .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(),
-    showHiddenFields: z
-      .boolean()
-      .describe('Optional: include hidden fields in the restored document response')
-      .optional(),
-  }),
-}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  input: restoreVersionInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
-  const { id, depth, draft, fallbackLocale, locale, populate, select, showHiddenFields } = input
+  const { id, depth, draft, fallbackLocale, locale, populate, select } = input
 
-  logger.info(`Restoring version in collection: ${collectionSlug} with ID: ${id}`)
+  logger.info(`Restoring version in collection: ${slug} with ID: ${id}`)
 
   try {
     const result = await payload.restoreVersion({
-      id,
-      collection: collectionSlug,
+      id: String(id),
+      collection: slug,
       depth,
       draft,
       overrideAccess: authorizedMCP.overrideAccess,
       req,
-      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
       ...(locale ? { locale } : {}),
-      ...(populate ? { populate: populate as PopulateType } : {}),
-      ...(select ? { select: select as SelectType } : {}),
-      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
+      ...(populate ? { populate } : {}),
+      ...(select ? { select } : {}),
     })
 
     return {
       content: [
         {
           type: 'text',
-          text: `Version "${id}" restored successfully in collection "${collectionSlug}"!\nRestored document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          text: `Version "${id}" restored successfully in collection "${slug}"!\nRestored 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 restoring version ${id} in ${collectionSlug}: ${errorMessage}`)
+    logger.error(`Error restoring version ${id} in ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `❌ **Error restoring version "${id}" in collection "${collectionSlug}":** ${errorMessage}`,
+          text: `❌ **Error restoring version "${id}" in collection "${slug}":** ${errorMessage}`,
         },
       ],
       isError: true,

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

@@ -1,27 +1,27 @@
-import type { SelectType, Where } from 'payload'
+import type { Where } from 'payload'
 
-import { z } from 'zod'
+import {
+  getCollectionInputSchema,
+  getCollectionVirtualFieldNames,
+  parseDocumentID,
+  stripVirtualFields,
+  transformPointDataToPayload,
+  updateDocumentInputSchema,
+  validateCollectionData,
+} from 'payload'
 
 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, resolveFileInput } from './fileInput.js'
-import { formatCollectionError } from './formatCollectionError.js'
+import { formatEntityError } from '../formatEntityError.js'
+import { fileInputSchema, resolveFile } from './fileInput.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) =>
-    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
   annotations: {
     destructiveHint: true,
     idempotentHint: false,
@@ -30,65 +30,8 @@ export const updateDocumentTool = defineCollectionTool({
     title: 'Update Document',
   },
   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. Only include fields permitted by the schema returned by getCollectionSchema.',
-      ),
-    depth: z
-      .number()
-      .describe('How many levels deep to populate relationships')
-      .optional()
-      .default(0),
-    draft: z
-      .boolean()
-      .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(),
-    file: fileInputSchema.optional(),
-    locale: z
-      .string()
-      .describe(
-        'Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale',
-      )
-      .optional(),
-    overrideLock: z
-      .boolean()
-      .describe('Whether to override document locks')
-      .optional()
-      .default(true),
-    overwriteExistingFiles: z
-      .boolean()
-      .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(
-        'Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}',
-      )
-      .optional(),
-    where: whereSchema
-      .describe(
-        'Where clause to update 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: updateDocumentInputSchema({ file: fileInputSchema }),
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
 
@@ -99,100 +42,103 @@ export const updateDocumentTool = defineCollectionTool({
     draft,
     fallbackLocale,
     file: fileInput,
+    limit,
     locale,
     overrideLock,
-    overwriteExistingFiles,
+    populate,
     publishAllLocales,
+    returning,
     select,
+    sort,
+    trash,
+    unpublishAllLocales,
     where,
   } = input
 
   logger.info(
-    `Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,
+    `Updating document in collection: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,
   )
 
   try {
-    if (!id && !where) {
-      return {
-        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],
-      }
-    }
-
-    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)
     const inputData = stripVirtualFields(data, virtualFieldNames)
-    const validationError = validateCollectionData({
-      collectionSlug,
+    validateCollectionData({
+      slug,
       data: inputData,
       partial: true,
       req,
     })
 
-    if (validationError) {
-      return validationError
-    }
-
     const parsedData = transformPointDataToPayload(inputData)
-    const file = await resolveFileInput({ collectionSlug, input: fileInput, req })
+    const file = await resolveFile({ slug, input: fileInput, req })
 
     const whereClause: Where = where ?? {}
 
-    if (id) {
+    if (id !== undefined) {
       const result = await payload.update({
-        id,
-        collection: collectionSlug,
+        id: parseDocumentID({ id, collectionSlug: slug, payload }),
+        collection: slug,
         data: parsedData,
         depth,
         draft,
+        fallbackLocale,
+        locale,
         overrideAccess: authorizedMCP.overrideAccess,
         overrideLock,
+        populate,
+        publishAllLocales,
         req,
+        select: returning ? select : { id: true },
+        trash,
+        unpublishAllLocales,
         ...(file ? { file } : {}),
-        ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
-        ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
-        ...(locale ? { locale } : {}),
-        ...(fallbackLocale ? { fallbackLocale } : {}),
-        ...(select ? { select: select as SelectType } : {}),
       })
 
+      const responseResult = returning ? result : { id: result.id }
+
       return {
         content: [
           {
             type: 'text',
-            text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+            text: `Document updated successfully in collection "${slug}"!\nResult:\n\`\`\`json\n${JSON.stringify(responseResult)}\n\`\`\``,
           },
         ],
-        doc: result as Record<string, unknown>,
+        doc: responseResult as Record<string, unknown>,
       }
     }
 
     const result = await payload.update({
-      collection: collectionSlug,
+      collection: slug,
       data: parsedData,
       depth,
       draft,
+      fallbackLocale,
+      limit,
+      locale,
       overrideAccess: authorizedMCP.overrideAccess,
       overrideLock,
+      populate,
+      publishAllLocales,
       req,
+      select: returning ? select : { id: true },
+      sort,
+      trash,
+      unpublishAllLocales,
       where: whereClause,
       ...(file ? { file } : {}),
-      ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
-      ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
-      ...(locale ? { locale } : {}),
-      ...(fallbackLocale ? { fallbackLocale } : {}),
-      ...(select ? { select: select as SelectType } : {}),
     })
 
-    const docs = result.docs || []
+    const docs = returning ? result.docs : result.docs.map(({ id }) => ({ id }))
     const errors = result.errors || []
 
-    let responseText = `Multiple documents updated in collection "${collectionSlug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`
+    let responseText = `Multiple documents updated in collection "${slug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`
     if (docs.length > 0) {
       responseText += `\n\nUpdated documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``
     }
     if (errors.length > 0) {
       responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``
 
-      const errorSchema = getCollectionInputSchema({ collectionSlug, req })
+      const errorSchema = getCollectionInputSchema({ collectionSlug: slug, req })
 
       if (errorSchema) {
         responseText += `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(errorSchema)}\n\`\`\``
@@ -205,7 +151,7 @@ export const updateDocumentTool = defineCollectionTool({
         ...(errorSchema
           ? {
               structuredContent: {
-                collectionSlug,
+                slug,
                 docs,
                 errors,
                 schema: errorSchema,
@@ -221,7 +167,7 @@ export const updateDocumentTool = defineCollectionTool({
     }
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-    logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`)
-    return formatCollectionError({ action: 'updating', collectionSlug, error, req })
+    logger.error(`Error updating document in ${slug}: ${errorMessage}`)
+    return formatEntityError({ slug, action: 'updating', entity: 'collection', error, req })
   }
 })

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

@@ -0,0 +1,64 @@
+import { strictObject, z } from 'payload'
+import { getUploadInstructions as getPayloadUploadInstructions } from 'payload/internal'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+
+export const getUploadInstructionsTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) &&
+    Boolean(
+      args.permissions?.collections?.[args.slug]?.create ||
+        args.permissions?.collections?.[args.slug]?.update,
+    ),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+    title: 'Get Upload Instructions',
+  },
+  description:
+    'Prepare uploads for createDocuments or updateDocument. This does not upload bytes; finish the returned action before use.',
+  input: strictObject({
+    docPrefix: z.optional(z.string()).check(z.describe('Document folder or prefix.')),
+    filename: z.string().check(z.describe('The original file name.')),
+    filesize: z.int().check(z.nonnegative(), z.describe('The file size in bytes.')),
+    mimeType: z.string().check(z.describe('The file MIME type.')),
+  }),
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
+  try {
+    const instructions = await getPayloadUploadInstructions({
+      ...input,
+      collectionSlug: slug,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+    })
+
+    const nextStep =
+      instructions.type === 'http'
+        ? 'Upload bytes with instructions.request. After success, pass { source: "uploadReference", file: instructions.file }.'
+        : `Call "${instructions.name}" with file and data. After success, pass { source: "uploadReference", file: instructions.file }.`
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Upload instructions for collection "${slug}":\n\`\`\`json\n${JSON.stringify(instructions)}\n\`\`\`\n${nextStep}`,
+        },
+      ],
+      structuredContent: { instructions },
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : 'Unknown error'
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error getting upload instructions for collection "${slug}": ${message}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+})

package/src/mcp/builtin/formatEntityError.ts

@@ -0,0 +1,77 @@
+import type { CollectionSlug, GlobalSlug, PayloadRequest } from 'payload'
+
+import { getCollectionInputSchema, getGlobalInputSchema, ValidationError } from 'payload'
+
+import type { MCPToolResponse } from '../../types.js'
+
+export const formatEntityError = ({
+  slug,
+  action,
+  entity,
+  error,
+  req,
+}:
+  | {
+      action: 'creating' | 'duplicating' | 'updating'
+      entity: 'collection'
+      error: unknown
+      req: PayloadRequest
+      slug: CollectionSlug
+    }
+  | {
+      action: 'updating'
+      entity: 'global'
+      error: unknown
+      req: PayloadRequest
+      slug: GlobalSlug
+    }): MCPToolResponse => {
+  const message = error instanceof Error ? error.message : 'Unknown error'
+  const target = entity === 'collection' ? `document in collection "${slug}"` : `global "${slug}"`
+
+  if (!isValidationError(error, message)) {
+    return {
+      content: [{ type: 'text', text: `Error ${action} ${target}: ${message}` }],
+      isError: true,
+    }
+  }
+
+  const schema =
+    entity === 'collection'
+      ? getCollectionInputSchema({ collectionSlug: slug, req })
+      : getGlobalInputSchema({ globalSlug: slug, req })
+  const errors = error instanceof ValidationError ? error.data.errors : [{ message }]
+  const validationMessage = errors
+    .map((issue) => `${'path' in issue ? `${issue.path}: ` : ''}${issue.message}`)
+    .join('\n')
+  const schemaText = schema
+    ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\``
+    : ''
+
+  return {
+    content: [
+      { type: 'text', text: `Error ${action} ${target}: ${validationMessage}${schemaText}` },
+    ],
+    isError: true,
+    ...(schema
+      ? {
+          structuredContent: {
+            slug,
+            errors,
+            schema,
+          },
+        }
+      : {}),
+  }
+}
+
+const isValidationError = (error: unknown, message: string): boolean => {
+  if (error instanceof ValidationError) {
+    return true
+  }
+
+  const name = error && typeof error === 'object' && 'name' in error ? error.name : undefined
+
+  return (
+    name === 'CastError' || message.includes('Cast to ') || message.includes('validation failed')
+  )
+}

package/src/mcp/builtin/getConfigInfoTool.ts

@@ -1,4 +1,4 @@
-import { getAccessResults, isEntityHidden } from 'payload'
+import { getAccessResults, getConfigInfoInputSchema, isEntityHidden } from 'payload'
 
 import { defineTool } from '../../defineTool.js'
 
@@ -11,6 +11,7 @@ export const getConfigInfoTool = defineTool({
     title: 'Config Info',
   },
   description: 'List the Payload collection and global slugs visible to this MCP client.',
+  input: getConfigInfoInputSchema,
 }).handler(async ({ authorizedMCP, req }) => {
   const user = req.user
   const permissions = authorizedMCP.overrideAccess ? null : await getAccessResults({ req })

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

@@ -1,16 +1,15 @@
-import { z } from 'zod'
+import { countGlobalVersionsInputSchema } from 'payload'
 
 import { defaultAccess } from '../../../defaultAccess.js'
 import { defineGlobalTool } from '../../../defineTool.js'
 import { getLogger } from '../../../utils/getLogger.js'
-import { whereSchema } from '../../../utils/whereSchema.js'
 
 const DEFAULT_DESCRIPTION =
   'Count global versions in any version-enabled global by passing the global slug and optional where clause.'
 
 export const countGlobalVersionsTool = defineGlobalTool({
   access: (args) =>
-    defaultAccess(args) && Boolean(args.permissions?.globals?.[args.globalSlug]?.readVersions),
+    defaultAccess(args) && Boolean(args.permissions?.globals?.[args.slug]?.readVersions),
   annotations: {
     destructiveHint: false,
     idempotentHint: true,
@@ -19,24 +18,17 @@ export const countGlobalVersionsTool = defineGlobalTool({
     title: 'Count Global Versions',
   },
   description: DEFAULT_DESCRIPTION,
-  input: z.object({
-    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.siteName":{"contains":"test"}}',
-      )
-      .optional(),
-  }),
-}).handler(async ({ authorizedMCP, globalSlug, input, req }) => {
+  input: countGlobalVersionsInputSchema,
+}).handler(async ({ slug, authorizedMCP, input, req }) => {
   const payload = req.payload
   const logger = getLogger({ payload })
   const { locale, where } = input
 
-  logger.info(`Counting versions for global: ${globalSlug}`)
+  logger.info(`Counting versions for global: ${slug}`)
 
   try {
     const result = await payload.countGlobalVersions({
-      global: globalSlug,
+      global: slug,
       overrideAccess: authorizedMCP.overrideAccess,
       req,
       ...(locale ? { locale } : {}),
@@ -47,19 +39,19 @@ export const countGlobalVersionsTool = defineGlobalTool({
       content: [
         {
           type: 'text',
-          text: `Global "${globalSlug}" contains ${result.totalDocs} matching versions.\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          text: `Global "${slug}" contains ${result.totalDocs} matching versions.\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
         },
       ],
       doc: result,
     }
   } catch (error) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-    logger.error(`Error counting versions for global ${globalSlug}: ${errorMessage}`)
+    logger.error(`Error counting versions for global ${slug}: ${errorMessage}`)
     return {
       content: [
         {
           type: 'text',
-          text: `❌ **Error counting versions for global "${globalSlug}":** ${errorMessage}`,
+          text: `❌ **Error counting versions for global "${slug}":** ${errorMessage}`,
         },
       ],
       isError: true,