@payloadcms/plugin-mcp 4.0.0-internal.e16cf59 → 4.0.0-internal.e38d3ac

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

@@ -0,0 +1,80 @@
+import { getAccessResults } 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) => {
+    const permissions = args.permissions?.collections?.[args.collectionSlug]
+
+    return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)
+  },
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: false,
+    readOnlyHint: true,
+    title: 'Get Collection Schema',
+  },
+  description: 'Get the input schema for creating or updating documents in a collection.',
+}).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 {
+      content: [{ type: 'text', text: `Error: Collection "${collectionSlug}" not found` }],
+      isError: true,
+    }
+  }
+
+  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\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``,
+      },
+    ],
+    structuredContent: {
+      collectionSlug,
+      schema: inputSchema,
+      upload,
+    },
+  }
+})

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

@@ -0,0 +1,107 @@
+import type { PopulateType, SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+
+const DEFAULT_DESCRIPTION =
+  'Restore a document from a previous version in any version-enabled collection.'
+
+export const restoreVersionTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
+  annotations: {
+    destructiveHint: true,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    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 }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const { id, depth, draft, fallbackLocale, locale, populate, select, showHiddenFields } = input
+
+  logger.info(`Restoring version in collection: ${collectionSlug} with ID: ${id}`)
+
+  try {
+    const result = await payload.restoreVersion({
+      id,
+      collection: collectionSlug,
+      depth,
+      draft,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(locale ? { locale } : {}),
+      ...(populate ? { populate: populate as PopulateType } : {}),
+      ...(select ? { select: select as SelectType } : {}),
+      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
+    })
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Version "${id}" restored successfully in collection "${collectionSlug}"!\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}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `❌ **Error restoring version "${id}" in collection "${collectionSlug}":** ${errorMessage}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+})

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

@@ -0,0 +1,227 @@
+import type { SelectType, Where } 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. 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),
+  annotations: {
+    destructiveHint: true,
+    idempotentHint: false,
+    openWorldHint: false,
+    readOnlyHint: false,
+    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 }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+
+  const {
+    id,
+    data,
+    depth,
+    draft,
+    fallbackLocale,
+    file: fileInput,
+    locale,
+    overrideLock,
+    overwriteExistingFiles,
+    publishAllLocales,
+    select,
+    where,
+  } = input
+
+  logger.info(
+    `Updating document in collection: ${collectionSlug}${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 inputData = stripVirtualFields(data, virtualFieldNames)
+    const validationError = validateCollectionData({
+      collectionSlug,
+      data: inputData,
+      partial: true,
+      req,
+    })
+
+    if (validationError) {
+      return validationError
+    }
+
+    const parsedData = transformPointDataToPayload(inputData)
+    const file = await resolveFile({ collectionSlug, input: fileInput, req })
+
+    const whereClause: Where = where ?? {}
+
+    if (id) {
+      const result = await payload.update({
+        id,
+        collection: collectionSlug,
+        data: parsedData,
+        depth,
+        draft,
+        overrideAccess: authorizedMCP.overrideAccess,
+        overrideLock,
+        req,
+        ...(file ? { file } : {}),
+        ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+        ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
+        ...(locale ? { locale } : {}),
+        ...(fallbackLocale ? { fallbackLocale } : {}),
+        ...(select ? { select: select as SelectType } : {}),
+      })
+
+      return {
+        content: [
+          {
+            type: 'text',
+            text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
+          },
+        ],
+        doc: result as Record<string, unknown>,
+      }
+    }
+
+    const result = await payload.update({
+      collection: collectionSlug,
+      data: parsedData,
+      depth,
+      draft,
+      overrideAccess: authorizedMCP.overrideAccess,
+      overrideLock,
+      req,
+      where: whereClause,
+      ...(file ? { file } : {}),
+      ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+      ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
+      ...(locale ? { locale } : {}),
+      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(select ? { select: select as SelectType } : {}),
+    })
+
+    const docs = result.docs || []
+    const errors = result.errors || []
+
+    let responseText = `Multiple documents updated in collection "${collectionSlug}"!\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 })
+
+      if (errorSchema) {
+        responseText += `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(errorSchema)}\n\`\`\``
+      }
+
+      return {
+        content: [{ type: 'text', text: responseText }],
+        doc: { docs, errors } as unknown as Record<string, unknown>,
+        isError: true,
+        ...(errorSchema
+          ? {
+              structuredContent: {
+                collectionSlug,
+                docs,
+                errors,
+                schema: errorSchema,
+              },
+            }
+          : {}),
+      }
+    }
+
+    return {
+      content: [{ type: 'text', text: responseText }],
+      doc: { docs, errors } as unknown as Record<string, unknown>,
+    }
+  } 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 })
+  }
+})

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

@@ -0,0 +1,64 @@
+import { getUploadInstructions as getPayloadUploadInstructions } from 'payload/internal'
+import { z } from 'zod'
+
+import { defaultAccess } from '../../../defaultAccess.js'
+import { defineCollectionTool } from '../../../defineTool.js'
+
+export const getUploadInstructionsTool = defineCollectionTool({
+  access: (args) =>
+    defaultAccess(args) &&
+    Boolean(
+      args.permissions?.collections?.[args.collectionSlug]?.create ||
+        args.permissions?.collections?.[args.collectionSlug]?.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: z.object({
+    docPrefix: z.string().describe('Optional document folder or prefix').optional(),
+    filename: z.string().describe('The original file name'),
+    filesize: z.number().int().nonnegative().describe('The file size in bytes'),
+    mimeType: z.string().describe('The file MIME type'),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  try {
+    const instructions = await getPayloadUploadInstructions({
+      ...input,
+      collectionSlug,
+      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 "${collectionSlug}":\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 "${collectionSlug}": ${message}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+})

package/src/mcp/builtin/getConfigInfoTool.ts

@@ -0,0 +1,67 @@
+import { getAccessResults, isEntityHidden } from 'payload'
+
+import { defineTool } from '../../defineTool.js'
+
+export const getConfigInfoTool = defineTool({
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: false,
+    readOnlyHint: true,
+    title: 'Config Info',
+  },
+  description: 'List the Payload collection and global slugs visible to this MCP client.',
+}).handler(async ({ authorizedMCP, req }) => {
+  const user = req.user
+  const permissions = authorizedMCP.overrideAccess ? null : await getAccessResults({ req })
+  const authorizedCollectionSlugs = new Set<string>()
+  const authorizedGlobalSlugs = new Set<string>()
+
+  for (const item of authorizedMCP.items) {
+    if (item.type === 'collectionTool') {
+      authorizedCollectionSlugs.add(item.collectionSlug)
+    } else if (item.type === 'globalTool') {
+      authorizedGlobalSlugs.add(item.globalSlug)
+    }
+  }
+
+  const collections: string[] = []
+  const globals: string[] = []
+
+  for (const collection of req.payload.config.collections) {
+    if (!authorizedCollectionSlugs.has(collection.slug)) {
+      continue
+    }
+    if (user && isEntityHidden({ hidden: collection.admin.hidden, user })) {
+      continue
+    }
+    if (!authorizedMCP.overrideAccess && !permissions?.collections?.[collection.slug]?.read) {
+      continue
+    }
+
+    collections.push(collection.slug)
+  }
+
+  for (const global of req.payload.config.globals) {
+    if (!authorizedGlobalSlugs.has(global.slug)) {
+      continue
+    }
+    if (user && isEntityHidden({ hidden: global.admin.hidden, user })) {
+      continue
+    }
+    if (!authorizedMCP.overrideAccess && !permissions?.globals?.[global.slug]?.read) {
+      continue
+    }
+
+    globals.push(global.slug)
+  }
+
+  return {
+    content: [
+      {
+        type: 'text',
+        text: `Collections: ${collections.join(', ') || 'none'}\nGlobals: ${globals.join(', ') || 'none'}`,
+      },
+    ],
+  }
+})

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

@@ -0,0 +1,68 @@
+import { z } from 'zod'
+
+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),
+  annotations: {
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: false,
+    readOnlyHint: true,
+    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 }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+  const { locale, where } = input
+
+  logger.info(`Counting versions for global: ${globalSlug}`)
+
+  try {
+    const result = await payload.countGlobalVersions({
+      global: globalSlug,
+      overrideAccess: authorizedMCP.overrideAccess,
+      req,
+      ...(locale ? { locale } : {}),
+      ...(where ? { where } : {}),
+    })
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Global "${globalSlug}" 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}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `❌ **Error counting versions for global "${globalSlug}":** ${errorMessage}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+})