@payloadcms/plugin-mcp 3.86.0-internal.ac46214 → 4.0.0-canary.1

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

@@ -0,0 +1,112 @@
+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 { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
+import { validateCollectionData } from '../validateEntityData.js'
+import { formatCollectionError } from './formatCollectionError.js'
+
+const DEFAULT_DESCRIPTION =
+  'Create a document in any collection by passing the collection slug and data.'
+
+export const createDocumentTool = defineCollectionTool({
+  description: DEFAULT_DESCRIPTION,
+  input: z.object({
+    data: z.record(z.string(), z.unknown()).describe('The document fields to create'),
+    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 return (JSON), e.g., '{\"title\": true}'",
+      )
+      .optional(),
+  }),
+}).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 {
+    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
+    const inputData = stripVirtualFields(data, virtualFieldNames)
+    const validationError = validateCollectionData({ collectionSlug, data: inputData, req })
+
+    if (validationError) {
+      return validationError
+    }
+
+    const parsedData = transformPointDataToPayload(inputData)
+
+    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 formatCollectionError({ action: 'creating', collectionSlug, error, req })
+  }
+})

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

@@ -0,0 +1,116 @@
+import { z } from 'zod'
+
+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 =
+  'Delete documents in any collection by passing the collection slug and ID or where clause.'
+
+export const deleteDocumentsTool = 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: whereSchema
+      .describe(
+        'Optional: where clause to delete 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, 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' }],
+      }
+    }
+
+    const deleteOptions: Record<string, unknown> = {
+      collection: collectionSlug,
+      depth,
+      req,
+      ...localAPIDefaults(authorizedMCP),
+      ...(locale && { locale }),
+      ...(fallbackLocale && { fallbackLocale }),
+    }
+
+    if (id) {
+      deleteOptions.id = id
+    } else {
+      deleteOptions.where = where
+    }
+
+    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,177 @@
+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'
+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({
+  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: 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 }) => {
+  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 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 (where) {
+      findOptions.where = 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/formatCollectionError.ts

@@ -0,0 +1,84 @@
+import type { CollectionSlug, PayloadRequest } from 'payload'
+
+import type { MCPToolResponse } from '../../../types.js'
+
+import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
+
+const getValidationErrors = (error: unknown): undefined | unknown[] => {
+  if (!error || typeof error !== 'object') {
+    return undefined
+  }
+
+  const data = 'data' in error ? error.data : undefined
+  if (!data || typeof data !== 'object' || !('errors' in data) || !Array.isArray(data.errors)) {
+    return undefined
+  }
+
+  return data.errors
+}
+
+const isSchemaError = (error: unknown, message: string): boolean => {
+  if (getValidationErrors(error)) {
+    return true
+  }
+
+  const name = error && typeof error === 'object' && 'name' in error ? error.name : undefined
+
+  return (
+    name === 'CastError' ||
+    name === 'ValidationError' ||
+    message.includes('Cast to ') ||
+    message.includes('validation failed')
+  )
+}
+
+export const formatCollectionError = ({
+  action,
+  collectionSlug,
+  error,
+  req,
+}: {
+  action: 'creating' | 'updating'
+  collectionSlug: CollectionSlug
+  error: unknown
+  req: PayloadRequest
+}): MCPToolResponse => {
+  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+  const errors = getValidationErrors(error) ?? [{ message: errorMessage }]
+
+  if (!isSchemaError(error, errorMessage)) {
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}`,
+        },
+      ],
+      isError: true,
+    }
+  }
+
+  const schema = getCollectionInputSchema({ collectionSlug, req })
+  const schemaText = schema
+    ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\``
+    : ''
+
+  return {
+    content: [
+      {
+        type: 'text',
+        text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}${schemaText}`,
+      },
+    ],
+    isError: true,
+    ...(schema
+      ? {
+          structuredContent: {
+            collectionSlug,
+            errors,
+            schema,
+          },
+        }
+      : {}),
+  }
+}

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

@@ -0,0 +1,28 @@
+import { defineCollectionTool } from '../../../defineTool.js'
+import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
+
+export const getCollectionSchemaTool = defineCollectionTool({
+  description: 'Get the input schema for creating or updating documents in a collection.',
+}).handler(({ collectionSlug, req }) => {
+  const inputSchema = getCollectionInputSchema({ collectionSlug, req })
+
+  if (!inputSchema) {
+    return {
+      content: [{ type: 'text', text: `Error: Collection "${collectionSlug}" not found` }],
+      isError: true,
+    }
+  }
+
+  return {
+    content: [
+      {
+        type: 'text',
+        text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``,
+      },
+    ],
+    structuredContent: {
+      collectionSlug,
+      schema: inputSchema,
+    },
+  }
+})