@payloadcms/plugin-mcp 3.73.0-internal.783bc97 → 3.73.0-internal.dd5902a

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

@@ -1,6 +1,6 @@
 import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
 import type { JSONSchema4 } from 'json-schema'
-import type { PayloadRequest, TypedUser } from 'payload'
+import type { PayloadRequest, SelectType, TypedUser } from 'payload'
 
 import { z } from 'zod'
 
@@ -25,6 +25,7 @@ export const updateGlobalTool = (
     depth: number = 0,
     locale?: string,
     fallbackLocale?: string,
+    select?: string,
   ): Promise<{
     content: Array<{
       text: string
@@ -62,6 +63,24 @@ export const updateGlobalTool = (
         }
       }
 
+      let selectClause: SelectType | undefined
+      if (select) {
+        try {
+          selectClause = JSON.parse(select) as SelectType
+        } catch (_parseError) {
+          payload.logger.warn(`[payload-mcp] Invalid select clause JSON for global: ${select}`)
+          const response = {
+            content: [{ type: 'text' as const, text: 'Error: Invalid JSON in select clause' }],
+          }
+          return (globals?.[globalSlug]?.overrideResponse?.(response, {}, req) || response) as {
+            content: Array<{
+              text: string
+              type: 'text'
+            }>
+          }
+        }
+      }
+
       const updateOptions: Parameters<typeof payload.updateGlobal>[0] = {
         slug: globalSlug,
         data: parsedData,
@@ -77,6 +96,9 @@ export const updateGlobalTool = (
       if (fallbackLocale) {
         updateOptions.fallbackLocale = fallbackLocale
       }
+      if (selectClause) {
+        updateOptions.select = selectClause
+      }
 
       const result = await payload.updateGlobal(updateOptions)
 
@@ -146,6 +168,12 @@ ${JSON.stringify(result, null, 2)}
         .describe(
           'Optional: locale code to update data in (e.g., "en", "es"). Use "all" to update all locales for localized fields',
         ),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          'Optional: define exactly which fields you\'d like to return in the response (JSON), e.g., \'{"siteName": "My Site"}\'',
+        ),
     })
 
     server.tool(
@@ -153,7 +181,7 @@ ${JSON.stringify(result, null, 2)}
       `${toolSchemas.updateGlobal.description.trim()}\n\n${globals?.[globalSlug]?.description || ''}`,
       updateGlobalSchema.shape,
       async (params: Record<string, unknown>) => {
-        const { depth, draft, fallbackLocale, locale, ...rest } = params
+        const { depth, draft, fallbackLocale, locale, select, ...rest } = params
         const data = JSON.stringify(rest)
         return await tool(
           data,
@@ -161,6 +189,7 @@ ${JSON.stringify(result, null, 2)}
           depth as number,
           locale as string,
           fallbackLocale as string,
+          select as string | undefined,
         )
       },
     )

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

@@ -1,6 +1,6 @@
 import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
 import type { JSONSchema4 } from 'json-schema'
-import type { PayloadRequest, TypedUser } from 'payload'
+import type { PayloadRequest, SelectType, TypedUser } from 'payload'
 
 import { z } from 'zod'
 
@@ -24,6 +24,7 @@ export const createResourceTool = (
     draft: boolean,
     locale?: string,
     fallbackLocale?: string,
+    select?: string,
   ): Promise<{
     content: Array<{
       text: string
@@ -55,6 +56,25 @@ export const createResourceTool = (
         }
       }
 
+      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'
+            }>
+          }
+        }
+      }
+
       // Create the resource
       const result = await payload.create({
         collection: collectionSlug,
@@ -66,6 +86,7 @@ export const createResourceTool = (
         user,
         ...(locale && { locale }),
         ...(fallbackLocale && { fallbackLocale }),
+        ...(selectClause && { select: selectClause }),
       })
 
       if (verboseLogs) {
@@ -147,6 +168,12 @@ ${JSON.stringify(result, null, 2)}
         .describe(
           'Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale',
         ),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          'Optional: define exactly which fields you\'d like to create (JSON), e.g., \'{"title": "My Post"}\'',
+        ),
     })
 
     server.tool(
@@ -154,7 +181,7 @@ ${JSON.stringify(result, null, 2)}
       `${collections?.[collectionSlug]?.description || toolSchemas.createResource.description.trim()}`,
       createResourceSchema.shape,
       async (params: Record<string, unknown>) => {
-        const { depth, draft, fallbackLocale, locale, ...fieldData } = params
+        const { depth, draft, fallbackLocale, locale, select, ...fieldData } = params
         const data = JSON.stringify(fieldData)
         return await tool(
           data,
@@ -162,6 +189,7 @@ ${JSON.stringify(result, null, 2)}
           draft as boolean,
           locale as string | undefined,
           fallbackLocale as string | undefined,
+          select as string | undefined,
         )
       },
     )

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

@@ -1,5 +1,5 @@
 import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import type { PayloadRequest, TypedUser } from 'payload'
+import type { PayloadRequest, SelectType, TypedUser } from 'payload'
 
 import type { PluginMCPServerConfig } from '../../../types.js'
 
@@ -20,6 +20,7 @@ export const findResourceTool = (
     page: number = 1,
     sort?: string,
     where?: string,
+    select?: string,
     depth: number = 0,
     locale?: string,
     fallbackLocale?: string,
@@ -62,6 +63,26 @@ export const findResourceTool = (
         }
       }
 
+      // 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 {
@@ -69,6 +90,7 @@ export const findResourceTool = (
             id,
             collection: collectionSlug,
             depth,
+            ...(selectClause && { select: selectClause }),
             overrideAccess: false,
             req,
             user,
@@ -129,6 +151,7 @@ ${JSON.stringify(doc, null, 2)}`,
         page,
         req,
         user,
+        ...(selectClause && { select: selectClause }),
         ...(locale && { locale }),
         ...(fallbackLocale && { fallbackLocale }),
         ...(draft !== undefined && { draft }),
@@ -202,8 +225,19 @@ Page: ${result.page} of ${result.totalPages}
       `find${collectionSlug.charAt(0).toUpperCase() + toCamelCase(collectionSlug).slice(1)}`,
       `${collections?.[collectionSlug]?.description || toolSchemas.findResources.description.trim()}`,
       toolSchemas.findResources.parameters.shape,
-      async ({ id, depth, draft, fallbackLocale, limit, locale, page, sort, where }) => {
-        return await tool(id, limit, page, sort, where, depth, locale, fallbackLocale, draft)
+      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,6 +1,6 @@
 import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
 import type { JSONSchema4 } from 'json-schema'
-import type { PayloadRequest, TypedUser } from 'payload'
+import type { PayloadRequest, SelectType, TypedUser } from 'payload'
 
 import { z } from 'zod'
 
@@ -29,6 +29,7 @@ export const updateResourceTool = (
     overwriteExistingFiles: boolean = false,
     locale?: string,
     fallbackLocale?: string,
+    select?: string,
   ): Promise<{
     content: Array<{
       text: string
@@ -107,6 +108,25 @@ export const updateResourceTool = (
         }
       }
 
+      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
@@ -124,6 +144,7 @@ export const updateResourceTool = (
           ...(overwriteExistingFiles && { overwriteExistingFiles }),
           ...(locale && { locale }),
           ...(fallbackLocale && { fallbackLocale }),
+          ...(selectClause && { select: selectClause }),
         }
 
         if (verboseLogs) {
@@ -174,6 +195,7 @@ ${JSON.stringify(result, null, 2)}
           ...(overwriteExistingFiles && { overwriteExistingFiles }),
           ...(locale && { locale }),
           ...(fallbackLocale && { fallbackLocale }),
+          ...(selectClause && { select: selectClause }),
         }
 
         if (verboseLogs) {
@@ -296,6 +318,12 @@ ${JSON.stringify(errors, null, 2)}
         .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()
@@ -316,6 +344,7 @@ ${JSON.stringify(errors, null, 2)}
           locale,
           overrideLock,
           overwriteExistingFiles,
+          select,
           where,
           ...fieldData
         } = params
@@ -332,6 +361,7 @@ ${JSON.stringify(errors, null, 2)}
           overwriteExistingFiles as boolean,
           locale as string | undefined,
           fallbackLocale as string | undefined,
+          select as string | undefined,
         )
       },
     )

package/src/mcp/tools/schemas.ts

@@ -22,6 +22,12 @@ export const toolSchemas = {
         .describe(
           'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
         ),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          "Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'",
+        ),
     }),
   },
 
@@ -73,6 +79,12 @@ export const toolSchemas = {
         .optional()
         .default(1)
         .describe('Page number for pagination (default: 1)'),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          "Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'",
+        ),
       sort: z
         .string()
         .optional()
@@ -113,6 +125,12 @@ export const toolSchemas = {
         .describe(
           'Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale',
         ),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          "Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'",
+        ),
     }),
   },
 
@@ -154,6 +172,12 @@ export const toolSchemas = {
         .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\": true}'",
+        ),
       where: z
         .string()
         .optional()
@@ -216,6 +240,12 @@ export const toolSchemas = {
         .describe(
           'Optional: locale code to update data in (e.g., "en", "es"). Use "all" to update all locales for localized fields',
         ),
+      select: z
+        .string()
+        .optional()
+        .describe(
+          "Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"siteName\": true}'",
+        ),
     }),
   },