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

package/src/mcp/tools/resource/find.ts

@@ -1,246 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import type { PayloadRequest, SelectType, TypedUser } from 'payload'
-
-import type { MCPPluginConfig } from '../../../types.js'
-
-import { toCamelCase } from '../../../utils/camelCase.js'
-import { toolSchemas } from '../schemas.js'
-
-export const findResourceTool = (
-  server: McpServer,
-  req: PayloadRequest,
-  user: TypedUser,
-  verboseLogs: boolean,
-  collectionSlug: string,
-  collections: MCPPluginConfig['collections'],
-) => {
-  const tool = async (
-    id?: number | string,
-    limit: number = 10,
-    page: number = 1,
-    sort?: string,
-    where?: string,
-    select?: string,
-    depth: number = 0,
-    locale?: string,
-    fallbackLocale?: string,
-    draft?: boolean,
-  ): Promise<{
-    content: Array<{
-      text: string
-      type: 'text'
-    }>
-  }> => {
-    const payload = req.payload
-
-    if (verboseLogs) {
-      payload.logger.info(
-        `[payload-mcp] Reading resource from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
-      )
-    }
-
-    try {
-      // Parse where clause if provided
-      let whereClause = {}
-      if (where) {
-        try {
-          whereClause = JSON.parse(where)
-          if (verboseLogs) {
-            payload.logger.info(`[payload-mcp] Using where clause: ${where}`)
-          }
-        } catch (_parseError) {
-          payload.logger.warn(`[payload-mcp] Invalid where clause JSON: ${where}`)
-          const response = {
-            content: [{ type: 'text' as const, text: 'Error: Invalid JSON in where clause' }],
-          }
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        }
-      }
-
-      // Parse select clause if provided
-      let selectClause: SelectType | undefined
-      if (select) {
-        try {
-          selectClause = JSON.parse(select) as SelectType
-        } catch (_parseError) {
-          payload.logger.warn(`[payload-mcp] Invalid select clause JSON: ${select}`)
-          const response = {
-            content: [{ type: 'text' as const, text: 'Error: Invalid JSON in select clause' }],
-          }
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        }
-      }
-
-      // If ID is provided, use findByID
-      if (id) {
-        try {
-          const doc = await payload.findByID({
-            id,
-            collection: collectionSlug,
-            depth,
-            ...(selectClause && { select: selectClause }),
-            overrideAccess: false,
-            req,
-            user,
-            ...(locale && { locale }),
-            ...(fallbackLocale && { fallbackLocale }),
-            ...(draft !== undefined && { draft }),
-          })
-
-          if (verboseLogs) {
-            payload.logger.info(`[payload-mcp] Found document with ID: ${id}`)
-          }
-
-          const response = {
-            content: [
-              {
-                type: 'text' as const,
-                text: `Resource from collection "${collectionSlug}":
-${JSON.stringify(doc)}`,
-              },
-            ],
-          }
-
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, doc, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        } catch (_findError) {
-          payload.logger.warn(
-            `[payload-mcp] Document not found with ID: ${id} in collection: ${collectionSlug}`,
-          )
-          const response = {
-            content: [
-              {
-                type: 'text' as const,
-                text: `Error: Document with ID "${id}" not found in collection "${collectionSlug}"`,
-              },
-            ],
-          }
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        }
-      }
-
-      // Otherwise, use find to get multiple documents
-      const findOptions: Parameters<typeof payload.find>[0] = {
-        collection: collectionSlug,
-        depth,
-        limit,
-        overrideAccess: false,
-        page,
-        req,
-        user,
-        ...(selectClause && { select: selectClause }),
-        ...(locale && { locale }),
-        ...(fallbackLocale && { fallbackLocale }),
-        ...(draft !== undefined && { draft }),
-      }
-
-      if (sort) {
-        findOptions.sort = sort
-      }
-
-      if (Object.keys(whereClause).length > 0) {
-        findOptions.where = whereClause
-      }
-
-      const result = await payload.find(findOptions)
-
-      if (verboseLogs) {
-        payload.logger.info(
-          `[payload-mcp] Found ${result.docs.length} documents in collection: ${collectionSlug}`,
-        )
-      }
-
-      let responseText = `Collection: "${collectionSlug}"
-Total: ${result.totalDocs} documents
-Page: ${result.page} of ${result.totalPages}
-`
-
-      for (const doc of result.docs) {
-        responseText += `\n\`\`\`json\n${JSON.stringify(doc)}\n\`\`\``
-      }
-
-      const response = {
-        content: [
-          {
-            type: 'text' as const,
-            text: responseText,
-          },
-        ],
-      }
-
-      return (collections?.[collectionSlug]?.overrideResponse?.(response, result, req) ||
-        response) as {
-        content: Array<{
-          text: string
-          type: 'text'
-        }>
-      }
-    } catch (error) {
-      const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-      payload.logger.error(
-        `[payload-mcp] Error reading resources from collection ${collectionSlug}: ${errorMessage}`,
-      )
-      const response = {
-        content: [
-          {
-            type: 'text' as const,
-            text: `❌ **Error reading resources from collection "${collectionSlug}":** ${errorMessage}`,
-          },
-        ],
-      }
-      return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) || response) as {
-        content: Array<{
-          text: string
-          type: 'text'
-        }>
-      }
-    }
-  }
-
-  if (collections?.[collectionSlug]?.enabled) {
-    server.registerTool(
-      `find${collectionSlug.charAt(0).toUpperCase() + toCamelCase(collectionSlug).slice(1)}`,
-      {
-        description: `${collections?.[collectionSlug]?.description || toolSchemas.findResources.description.trim()}`,
-        inputSchema: toolSchemas.findResources.parameters.shape,
-      },
-      async ({ id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where }) => {
-        return await tool(
-          id,
-          limit,
-          page,
-          sort,
-          where,
-          select,
-          depth,
-          locale,
-          fallbackLocale,
-          draft,
-        )
-      },
-    )
-  }
-}

package/src/mcp/tools/resource/update.ts

@@ -1,383 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import type { JSONSchema4 } from 'json-schema'
-import type { PayloadRequest, SelectType, TypedUser } from 'payload'
-
-import { z } from 'zod'
-
-import type { MCPPluginConfig } from '../../../types.js'
-
-import { toCamelCase } from '../../../utils/camelCase.js'
-import {
-  getCollectionVirtualFieldNames,
-  stripVirtualFields,
-} from '../../../utils/getVirtualFieldNames.js'
-import { convertCollectionSchemaToZod } from '../../../utils/schemaConversion/convertCollectionSchemaToZod.js'
-import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
-import { toolSchemas } from '../schemas.js'
-export const updateResourceTool = (
-  server: McpServer,
-  req: PayloadRequest,
-  user: TypedUser,
-  verboseLogs: boolean,
-  collectionSlug: string,
-  collections: MCPPluginConfig['collections'],
-  schema: JSONSchema4,
-) => {
-  const tool = async (
-    data: string,
-    id?: number | string,
-    where?: string,
-    draft: boolean = false,
-    depth: number = 0,
-    overrideLock: boolean = true,
-    filePath?: string,
-    overwriteExistingFiles: boolean = false,
-    locale?: string,
-    fallbackLocale?: string,
-    select?: string,
-  ): Promise<{
-    content: Array<{
-      text: string
-      type: 'text'
-    }>
-  }> => {
-    const payload = req.payload
-
-    if (verboseLogs) {
-      payload.logger.info(
-        `[payload-mcp] Updating resource in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,
-      )
-    }
-
-    try {
-      // Parse the data JSON
-      let parsedData: Record<string, unknown>
-      try {
-        parsedData = JSON.parse(data)
-
-        // Transform point fields from object format to tuple array
-        parsedData = transformPointDataToPayload(parsedData)
-
-        const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
-        parsedData = stripVirtualFields(parsedData, virtualFieldNames)
-
-        if (verboseLogs) {
-          payload.logger.info(
-            `[payload-mcp] Parsed data for ${collectionSlug}: ${JSON.stringify(parsedData)}`,
-          )
-        }
-      } catch (_parseError) {
-        payload.logger.error(`[payload-mcp] Invalid JSON data provided: ${data}`)
-        const response = {
-          content: [{ type: 'text' as const, text: 'Error: Invalid JSON data provided' }],
-        }
-        return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-          response) as {
-          content: Array<{
-            text: string
-            type: 'text'
-          }>
-        }
-      }
-
-      // Validate that either id or where is provided
-      if (!id && !where) {
-        payload.logger.error('[payload-mcp] Either id or where clause must be provided')
-        const response = {
-          content: [
-            { type: 'text' as const, text: 'Error: Either id or where clause must be provided' },
-          ],
-        }
-        return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-          response) as {
-          content: Array<{
-            text: string
-            type: 'text'
-          }>
-        }
-      }
-
-      // Parse where clause if provided
-      let whereClause = {}
-      if (where) {
-        try {
-          whereClause = JSON.parse(where)
-          if (verboseLogs) {
-            payload.logger.info(`[payload-mcp] Using where clause: ${where}`)
-          }
-        } catch (_parseError) {
-          payload.logger.error(`[payload-mcp] Invalid where clause JSON: ${where}`)
-          const response = {
-            content: [{ type: 'text' as const, text: 'Error: Invalid JSON in where clause' }],
-          }
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        }
-      }
-
-      let selectClause: SelectType | undefined
-      if (select) {
-        try {
-          selectClause = JSON.parse(select) as SelectType
-        } catch (_parseError) {
-          payload.logger.warn(`[payload-mcp] Invalid select clause JSON: ${select}`)
-          const response = {
-            content: [{ type: 'text' as const, text: 'Error: Invalid JSON in select clause' }],
-          }
-          return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) ||
-            response) as {
-            content: Array<{
-              text: string
-              type: 'text'
-            }>
-          }
-        }
-      }
-
-      // Update by ID or where clause
-      if (id) {
-        // Single document update
-        const updateOptions = {
-          id,
-          collection: collectionSlug,
-          data: parsedData,
-          depth,
-          draft,
-          overrideAccess: false,
-          overrideLock,
-          req,
-          user,
-          ...(filePath && { filePath }),
-          ...(overwriteExistingFiles && { overwriteExistingFiles }),
-          ...(locale && { locale }),
-          ...(fallbackLocale && { fallbackLocale }),
-          ...(selectClause && { select: selectClause }),
-        }
-
-        if (verboseLogs) {
-          payload.logger.info(`[payload-mcp] Updating single document with ID: ${id}`)
-        }
-        const result = await payload.update({
-          ...updateOptions,
-          data: parsedData,
-        } as any)
-
-        if (verboseLogs) {
-          payload.logger.info(`[payload-mcp] Successfully updated document with ID: ${id}`)
-        }
-
-        const response = {
-          content: [
-            {
-              type: 'text' as const,
-              text: `Document updated successfully in collection "${collectionSlug}"!
-Updated document:
-\`\`\`json
-${JSON.stringify(result)}
-\`\`\``,
-            },
-          ],
-        }
-
-        return (collections?.[collectionSlug]?.overrideResponse?.(response, result, req) ||
-          response) as {
-          content: Array<{
-            text: string
-            type: 'text'
-          }>
-        }
-      } else {
-        // Multiple documents update
-        const updateOptions = {
-          collection: collectionSlug,
-          data: parsedData,
-          depth,
-          draft,
-          overrideAccess: false,
-          overrideLock,
-          req,
-          user,
-          where: whereClause,
-          ...(filePath && { filePath }),
-          ...(overwriteExistingFiles && { overwriteExistingFiles }),
-          ...(locale && { locale }),
-          ...(fallbackLocale && { fallbackLocale }),
-          ...(selectClause && { select: selectClause }),
-        }
-
-        if (verboseLogs) {
-          payload.logger.info(`[payload-mcp] Updating multiple documents with where clause`)
-        }
-        const result = await payload.update({
-          ...updateOptions,
-          data: parsedData,
-        } as any)
-
-        const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }
-        const docs = bulkResult.docs || []
-        const errors = bulkResult.errors || []
-
-        if (verboseLogs) {
-          payload.logger.info(
-            `[payload-mcp] Successfully updated ${docs.length} documents, ${errors.length} errors`,
-          )
-        }
-
-        let responseText = `Multiple documents updated in collection "${collectionSlug}"!
-Updated: ${docs.length} documents
-Errors: ${errors.length}
----`
-
-        if (docs.length > 0) {
-          responseText += `\n\nUpdated documents:
-\`\`\`json
-${JSON.stringify(docs)}
-\`\`\``
-        }
-
-        if (errors.length > 0) {
-          responseText += `\n\nErrors:
-\`\`\`json
-${JSON.stringify(errors)}
-\`\`\``
-        }
-
-        const response = {
-          content: [
-            {
-              type: 'text' as const,
-              text: responseText,
-            },
-          ],
-        }
-
-        return (collections?.[collectionSlug]?.overrideResponse?.(
-          response,
-          { docs, errors },
-          req,
-        ) || response) as {
-          content: Array<{
-            text: string
-            type: 'text'
-          }>
-        }
-      }
-    } catch (error) {
-      const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-      payload.logger.error(
-        `[payload-mcp] Error updating resource in ${collectionSlug}: ${errorMessage}`,
-      )
-
-      const response = {
-        content: [
-          {
-            type: 'text' as const,
-            text: `Error updating resource in collection "${collectionSlug}": ${errorMessage}`,
-          },
-        ],
-      }
-
-      return (collections?.[collectionSlug]?.overrideResponse?.(response, {}, req) || response) as {
-        content: Array<{
-          text: string
-          type: 'text'
-        }>
-      }
-    }
-  }
-
-  if (collections?.[collectionSlug]?.enabled) {
-    const convertedFields = convertCollectionSchemaToZod(schema)
-
-    // Create a new schema that combines the converted fields with update-specific parameters
-    // Use .partial() to make all fields optional for partial updates
-    const updateResourceSchema = z.object({
-      ...convertedFields.partial().shape,
-      id: z.union([z.string(), z.number()]).optional().describe('The ID of the document to update'),
-      depth: z
-        .number()
-        .optional()
-        .default(0)
-        .describe('How many levels deep to populate relationships'),
-      draft: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe('Whether to update the document as a draft'),
-      fallbackLocale: z
-        .string()
-        .optional()
-        .describe('Optional: fallback locale code to use when requested locale is not available'),
-      filePath: z.string().optional().describe('File path for file uploads'),
-      locale: z
-        .string()
-        .optional()
-        .describe(
-          'Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale',
-        ),
-      overrideLock: z
-        .boolean()
-        .optional()
-        .default(true)
-        .describe('Whether to override document locks'),
-      overwriteExistingFiles: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe('Whether to overwrite existing files'),
-      select: z
-        .string()
-        .optional()
-        .describe(
-          'Optional: define exactly which fields you\'d like to return in the response (JSON), e.g., \'{"title": "My Post"}\'',
-        ),
-      where: z
-        .string()
-        .optional()
-        .describe('JSON string for where clause to update multiple documents'),
-    })
-
-    server.registerTool(
-      `update${collectionSlug.charAt(0).toUpperCase() + toCamelCase(collectionSlug).slice(1)}`,
-      {
-        description: `${collections?.[collectionSlug]?.description || toolSchemas.updateResource.description.trim()}`,
-        inputSchema: updateResourceSchema.shape,
-      },
-      async (params: Record<string, unknown>) => {
-        const {
-          id,
-          depth,
-          draft,
-          fallbackLocale,
-          filePath,
-          locale,
-          overrideLock,
-          overwriteExistingFiles,
-          select,
-          where,
-          ...fieldData
-        } = params
-        // Convert field data back to JSON string format expected by the tool
-        const data = JSON.stringify(fieldData)
-        return await tool(
-          data,
-          id as number | string | undefined,
-          where as string | undefined,
-          draft as boolean,
-          depth as number,
-          overrideLock as boolean,
-          filePath as string | undefined,
-          overwriteExistingFiles as boolean,
-          locale as string | undefined,
-          fallbackLocale as string | undefined,
-          select as string | undefined,
-        )
-      },
-    )
-  }
-}