@payloadcms/plugin-mcp 3.86.0-internal.ac46214 → 4.0.0-internal.183b315

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

@@ -0,0 +1,116 @@
+import type { SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+} from '../../../utils/getVirtualFieldNames.js'
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
+import { buildToolInput } from '../../../utils/schemaConversion/buildToolInput.js'
+import { sanitizeEntitySchema } from '../../../utils/schemaConversion/sanitizeEntitySchema.js'
+import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
+
+const DEFAULT_DESCRIPTION = 'Create a document in a collection.'
+
+export const createCollectionTool = defineCollectionTool({
+  description: DEFAULT_DESCRIPTION,
+  input: ({ collectionSchema }) =>
+    buildToolInput({
+      controls: {
+        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 create the document 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 create the document in (e.g., "en", "es"). Defaults to the default locale',
+          )
+          .optional(),
+        select: z
+          .string()
+          .describe(
+            'Optional: define exactly which fields you\'d like to create (JSON), e.g., \'{"title": "My Post"}\'',
+          )
+          .optional(),
+      },
+      dataDescription: 'The document fields to create',
+      dataSchema: sanitizeEntitySchema(collectionSchema),
+    }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+
+  const { data, depth, draft, fallbackLocale, locale, select } = input
+
+  logger.info(
+    `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,
+  )
+
+  try {
+    let parsedData = transformPointDataToPayload(data)
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    parsedData = stripVirtualFields(parsedData, virtualFieldNames)
+
+    let selectClause: SelectType | undefined
+    if (select) {
+      try {
+        selectClause = JSON.parse(select) as SelectType
+      } catch {
+        logger.warn(`Invalid select clause JSON: ${select}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }
+      }
+    }
+
+    const result = await payload.create({
+      collection: collectionSlug,
+      data: parsedData,
+      depth,
+      draft,
+      req,
+      ...localAPIDefaults(authorizedMCP),
+      ...(locale ? { locale } : {}),
+      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(selectClause ? { select: selectClause } : {}),
+    })
+
+    logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)
+
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Document created successfully in collection "${collectionSlug}"!\nCreated 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 creating document in ${collectionSlug}: ${errorMessage}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error creating document in collection "${collectionSlug}": ${errorMessage}`,
+        },
+      ],
+    }
+  }
+})

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

@@ -0,0 +1,123 @@
+import { z } from 'zod'
+
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
+
+const DEFAULT_DESCRIPTION = 'Delete documents in a collection by ID or where clause.'
+
+export const deleteCollectionTool = defineCollectionTool({
+  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: z
+      .string()
+      .describe('Optional: JSON string for where clause to delete multiple documents')
+      .optional(),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, 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}` : ''}`,
+  )
+
+  try {
+    if (!id && !where) {
+      return {
+        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],
+      }
+    }
+
+    let whereClause: Record<string, unknown> = {}
+    if (where) {
+      try {
+        whereClause = JSON.parse(where) as Record<string, unknown>
+      } catch {
+        logger.warn(`Invalid where clause JSON: ${where}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }
+      }
+    }
+
+    const deleteOptions: Record<string, unknown> = {
+      collection: collectionSlug,
+      depth,
+      req,
+      ...localAPIDefaults(authorizedMCP),
+      ...(locale && { locale }),
+      ...(fallbackLocale && { fallbackLocale }),
+    }
+
+    if (id) {
+      deleteOptions.id = id
+    } else {
+      deleteOptions.where = whereClause
+    }
+
+    const result = await payload.delete(deleteOptions as Parameters<typeof payload.delete>[0])
+
+    if (id) {
+      return {
+        content: [
+          {
+            type: 'text',
+            text: `Document deleted successfully from collection "${collectionSlug}"!\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 || []
+
+    let responseText = `Document deleted successfully from collection "${collectionSlug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`
+    if (docs.length > 0) {
+      responseText += `\n\nDeleted documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``
+    }
+    if (errors.length > 0) {
+      responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``
+    }
+
+    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 deleting document from ${collectionSlug}: ${errorMessage}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error deleting document from collection "${collectionSlug}": ${errorMessage}`,
+        },
+      ],
+    }
+  }
+})

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

@@ -0,0 +1,187 @@
+import type { SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
+
+const DEFAULT_DESCRIPTION =
+  'Find documents in a collection by ID or where clause using Find or FindByID.'
+
+export const findCollectionTool = defineCollectionTool({
+  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(
+        'Optional: whether the document should be queried from the versions table/collection or not.',
+      )
+      .optional(),
+    fallbackLocale: z
+      .string()
+      .describe('Optional: fallback locale code to use when requested locale is not available')
+      .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),
+    select: z
+      .string()
+      .describe(
+        "Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'",
+      )
+      .optional(),
+    sort: z
+      .string()
+      .describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)')
+      .optional(),
+    where: z
+      .string()
+      .describe(
+        'Optional JSON string for where clause filtering (e.g., \'{"title": {"contains": "test"}}\')',
+      )
+      .optional(),
+  }),
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+
+  const { id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where } = input
+
+  logger.info(
+    `Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
+  )
+
+  try {
+    let whereClause: Record<string, unknown> = {}
+    if (where) {
+      try {
+        whereClause = JSON.parse(where) as Record<string, unknown>
+      } catch {
+        logger.warn(`Invalid where clause JSON: ${where}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }
+      }
+    }
+
+    let selectClause: SelectType | undefined
+    if (select) {
+      try {
+        selectClause = JSON.parse(select) as SelectType
+      } catch {
+        logger.warn(`Invalid select clause JSON: ${select}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }
+      }
+    }
+
+    if (id) {
+      try {
+        const doc = await payload.findByID({
+          id,
+          collection: collectionSlug,
+          depth,
+          req,
+          ...localAPIDefaults(authorizedMCP),
+          ...(selectClause && { select: selectClause }),
+          ...(locale && { locale }),
+          ...(fallbackLocale && { fallbackLocale }),
+          ...(draft !== undefined && { draft }),
+        })
+
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Document from collection "${collectionSlug}":\n${JSON.stringify(doc)}`,
+            },
+          ],
+          doc: doc as Record<string, unknown>,
+        }
+      } catch {
+        logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`)
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Error: Document with ID "${id}" not found in collection "${collectionSlug}"`,
+            },
+          ],
+        }
+      }
+    }
+
+    const findOptions: Parameters<typeof payload.find>[0] = {
+      collection: collectionSlug,
+      depth,
+      limit,
+      page,
+      req,
+      ...localAPIDefaults(authorizedMCP),
+      ...(selectClause && { select: selectClause }),
+      ...(locale && { locale }),
+      ...(fallbackLocale && { fallbackLocale }),
+      ...(draft !== undefined && { draft }),
+    }
+
+    if (sort) {
+      findOptions.sort = sort
+    }
+    if (Object.keys(whereClause).length > 0) {
+      findOptions.where = whereClause as Parameters<typeof payload.find>[0]['where']
+    }
+
+    const result = await payload.find(findOptions)
+
+    let responseText = `Collection: "${collectionSlug}"\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\`\`\``
+    }
+
+    return {
+      content: [{ type: 'text', text: responseText }],
+      doc: result as unknown as Record<string, unknown>,
+    }
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+    logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`)
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `❌ **Error reading documents from collection "${collectionSlug}":** ${errorMessage}`,
+        },
+      ],
+    }
+  }
+})

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

@@ -0,0 +1,210 @@
+import type { SelectType } from 'payload'
+
+import { z } from 'zod'
+
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getLogger } from '../../../utils/getLogger.js'
+import {
+  getCollectionVirtualFieldNames,
+  stripVirtualFields,
+} from '../../../utils/getVirtualFieldNames.js'
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
+import { buildToolInput } from '../../../utils/schemaConversion/buildToolInput.js'
+import { sanitizeEntitySchema } from '../../../utils/schemaConversion/sanitizeEntitySchema.js'
+import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
+
+const DEFAULT_DESCRIPTION = 'Update documents in a collection by ID or where clause.'
+
+export const updateCollectionTool = defineCollectionTool({
+  description: DEFAULT_DESCRIPTION,
+  input: ({ collectionSchema }) => {
+    const partialSchema = sanitizeEntitySchema(collectionSchema)
+
+    // Collection updates do not require all required fields to be passed => delete .required.
+    //
+    // Local API equivalent: packages/payload/src/collections/operations/local/update.ts#BaseOptions#data:
+    // data: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>
+    delete partialSchema.required
+
+    return buildToolInput({
+      controls: {
+        id: z
+          .union([z.string(), z.number()])
+          .describe('The ID of the document to update')
+          .optional(),
+        depth: z
+          .number()
+          .describe('How many levels deep to populate relationships')
+          .optional()
+          .default(0),
+        draft: z
+          .boolean()
+          .describe('Whether to update the document as a draft')
+          .optional()
+          .default(false),
+        fallbackLocale: z
+          .string()
+          .describe('Optional: fallback locale code to use when requested locale is not available')
+          .optional(),
+        filePath: z.string().describe('File path for file uploads').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),
+        select: z
+          .string()
+          .describe(
+            'Optional: define exactly which fields you\'d like to return in the response (JSON), e.g., \'{"title": "My Post"}\'',
+          )
+          .optional(),
+        where: z
+          .string()
+          .describe('JSON string for where clause to update multiple documents')
+          .optional(),
+      },
+      dataDescription: 'The fields to update',
+      dataSchema: partialSchema,
+    })
+  },
+}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
+  const payload = req.payload
+  const logger = getLogger({ payload })
+
+  const {
+    id,
+    data,
+    depth,
+    draft,
+    fallbackLocale,
+    filePath,
+    locale,
+    overrideLock,
+    overwriteExistingFiles,
+    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' }],
+      }
+    }
+
+    let parsedData = transformPointDataToPayload(data)
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    parsedData = stripVirtualFields(parsedData, virtualFieldNames)
+
+    let whereClause: Record<string, unknown> = {}
+    if (where) {
+      try {
+        whereClause = JSON.parse(where) as Record<string, unknown>
+      } catch {
+        logger.error(`Invalid where clause JSON: ${where}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }
+      }
+    }
+
+    let selectClause: SelectType | undefined
+    if (select) {
+      try {
+        selectClause = JSON.parse(select) as SelectType
+      } catch {
+        logger.warn(`Invalid select clause JSON: ${select}`)
+        return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }
+      }
+    }
+
+    if (id) {
+      const updateOptions = {
+        id,
+        collection: collectionSlug,
+        data: parsedData,
+        depth,
+        draft,
+        overrideLock,
+        req,
+        ...localAPIDefaults(authorizedMCP),
+        ...(filePath ? { filePath } : {}),
+        ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+        ...(locale ? { locale } : {}),
+        ...(fallbackLocale ? { fallbackLocale } : {}),
+        ...(selectClause ? { select: selectClause } : {}),
+      }
+
+      const result = await payload.update(updateOptions as any)
+
+      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 updateOptions = {
+      collection: collectionSlug,
+      data: parsedData,
+      depth,
+      draft,
+      overrideLock,
+      req,
+      ...localAPIDefaults(authorizedMCP),
+      where: whereClause,
+      ...(filePath ? { filePath } : {}),
+      ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
+      ...(locale ? { locale } : {}),
+      ...(fallbackLocale ? { fallbackLocale } : {}),
+      ...(selectClause ? { select: selectClause } : {}),
+    }
+
+    const result = await payload.update(updateOptions as any)
+
+    const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }
+    const docs = bulkResult.docs || []
+    const errors = bulkResult.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\`\`\``
+    }
+
+    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 {
+      content: [
+        {
+          type: 'text',
+          text: `Error updating document in collection "${collectionSlug}": ${errorMessage}`,
+        },
+      ],
+    }
+  }
+})