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

package/dist/mcp/builtin/collections/deleteTool.js

@@ -0,0 +1,117 @@
+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 = {};
+        if (where) {
+            try {
+                whereClause = JSON.parse(where);
+            } catch  {
+                logger.warn(`Invalid where clause JSON: ${where}`);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Error: Invalid JSON in where clause'
+                        }
+                    ]
+                };
+            }
+        }
+        const deleteOptions = {
+            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);
+        if (id) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Document deleted successfully from collection "${collectionSlug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                    }
+                ],
+                doc: result
+            };
+        }
+        const bulkResult = result;
+        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
+            }
+        };
+    } 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}`
+                }
+            ]
+        };
+    }
+});
+
+//# sourceMappingURL=deleteTool.js.map

package/dist/mcp/builtin/collections/deleteTool.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION = 'Delete documents in a collection by ID or where clause.'\n\nexport const deleteCollectionTool = defineCollectionTool({\n  description: DEFAULT_DESCRIPTION,\n  input: z.object({\n    id: z\n      .union([z.string(), z.number()])\n      .describe('Optional: specific document ID to delete')\n      .optional(),\n    depth: z\n      .number()\n      .int()\n      .min(0)\n      .max(10)\n      .describe('Depth of population for relationships in response')\n      .optional()\n      .default(0),\n    fallbackLocale: z\n      .string()\n      .describe('Optional: fallback locale code to use when requested locale is not available')\n      .optional(),\n    locale: z\n      .string()\n      .describe(\n        'Optional: locale code for the operation (e.g., \"en\", \"es\"). Defaults to the default locale',\n      )\n      .optional(),\n    where: z\n      .string()\n      .describe('Optional: JSON string for where clause to delete multiple documents')\n      .optional(),\n  }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n  const payload = req.payload\n  const logger = getLogger({ payload })\n\n  const { id, depth, fallbackLocale, locale, where } = input\n\n  logger.info(\n    `Deleting document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`,\n  )\n\n  try {\n    if (!id && !where) {\n      return {\n        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n      }\n    }\n\n    let whereClause: Record<string, unknown> = {}\n    if (where) {\n      try {\n        whereClause = JSON.parse(where) as Record<string, unknown>\n      } catch {\n        logger.warn(`Invalid where clause JSON: ${where}`)\n        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n      }\n    }\n\n    const deleteOptions: Record<string, unknown> = {\n      collection: collectionSlug,\n      depth,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      ...(locale && { locale }),\n      ...(fallbackLocale && { fallbackLocale }),\n    }\n\n    if (id) {\n      deleteOptions.id = id\n    } else {\n      deleteOptions.where = whereClause\n    }\n\n    const result = await payload.delete(deleteOptions as Parameters<typeof payload.delete>[0])\n\n    if (id) {\n      return {\n        content: [\n          {\n            type: 'text',\n            text: `Document deleted successfully from collection \"${collectionSlug}\"!\\nDeleted document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n          },\n        ],\n        doc: result as Record<string, unknown>,\n      }\n    }\n\n    const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }\n    const docs = bulkResult.docs || []\n    const errors = bulkResult.errors || []\n\n    let responseText = `Document deleted successfully from collection \"${collectionSlug}\"!\\nDeleted: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n    if (docs.length > 0) {\n      responseText += `\\n\\nDeleted documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n    }\n    if (errors.length > 0) {\n      responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n    }\n\n    return {\n      content: [{ type: 'text', text: responseText }],\n      doc: { docs, errors } as unknown as Record<string, unknown>,\n    }\n  } catch (error) {\n    const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n    logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `Error deleting document from collection \"${collectionSlug}\": ${errorMessage}`,\n        },\n      ],\n    }\n  }\n})\n"],"names":["z","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","deleteCollectionTool","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","fallbackLocale","locale","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","content","type","text","whereClause","JSON","parse","warn","deleteOptions","collection","result","delete","stringify","doc","bulkResult","docs","errors","responseText","length","error","errorMessage","Error","message"],"mappings":"AAAA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBAAsB;AAE5B,OAAO,MAAMC,uBAAuBJ,qBAAqB;IACvDK,aAAaF;IACbG,OAAOP,EAAEQ,MAAM,CAAC;QACdC,IAAIT,EACDU,KAAK,CAAC;YAACV,EAAEW,MAAM;YAAIX,EAAEY,MAAM;SAAG,EAC9BC,QAAQ,CAAC,4CACTC,QAAQ;QACXC,OAAOf,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,qDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,gBAAgBpB,EACbW,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXO,QAAQrB,EACLW,MAAM,GACNE,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,OAAOtB,EACJW,MAAM,GACNE,QAAQ,CAAC,uEACTC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAElB,KAAK,EAAEmB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS1B,UAAU;QAAEyB;IAAQ;IAEnC,MAAM,EAAElB,EAAE,EAAEM,KAAK,EAAEK,cAAc,EAAEC,MAAM,EAAEC,KAAK,EAAE,GAAGf;IAErDqB,OAAOC,IAAI,CACT,CAAC,mCAAmC,EAAEJ,iBAAiBhB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,uBAAuBY,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG9I,IAAI;QACF,IAAI,CAACZ,MAAM,CAACa,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,IAAIC,cAAuC,CAAC;QAC5C,IAAIX,OAAO;YACT,IAAI;gBACFW,cAAcC,KAAKC,KAAK,CAACb;YAC3B,EAAE,OAAM;gBACNM,OAAOQ,IAAI,CAAC,CAAC,2BAA2B,EAAEd,OAAO;gBACjD,OAAO;oBAAEQ,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,MAAMK,gBAAyC;YAC7CC,YAAYb;YACZV;YACAW;YACA,GAAGvB,iBAAiBqB,cAAc;YAClC,GAAIH,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,kBAAkB;gBAAEA;YAAe,CAAC;QAC1C;QAEA,IAAIX,IAAI;YACN4B,cAAc5B,EAAE,GAAGA;QACrB,OAAO;YACL4B,cAAcf,KAAK,GAAGW;QACxB;QAEA,MAAMM,SAAS,MAAMZ,QAAQa,MAAM,CAACH;QAEpC,IAAI5B,IAAI;YACN,OAAO;gBACLqB,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAEP,eAAe,mCAAmC,EAAES,KAAKO,SAAS,CAACF,QAAQ,QAAQ,CAAC;oBAC9I;iBACD;gBACDG,KAAKH;YACP;QACF;QAEA,MAAMI,aAAaJ;QACnB,MAAMK,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,+CAA+C,EAAErB,eAAe,aAAa,EAAEmB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACzJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEZ,KAAKO,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEZ,KAAKO,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLf,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMc;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DvB,OAAOoB,KAAK,CAAC,CAAC,6BAA6B,EAAEvB,eAAe,EAAE,EAAEwB,cAAc;QAC9E,OAAO;YACLnB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAEP,eAAe,GAAG,EAAEwB,cAAc;gBACtF;aACD;QACH;IACF;AACF,GAAE"}

package/dist/mcp/builtin/collections/findTool.d.ts

@@ -0,0 +1,2 @@
+export declare const findCollectionTool: import("../../../types.js").CollectionTool;
+//# sourceMappingURL=findTool.d.ts.map

package/dist/mcp/builtin/collections/findTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,kBAAkB,4CA+K7B,CAAA"}

package/dist/mcp/builtin/collections/findTool.js

@@ -0,0 +1,159 @@
+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 = {};
+        if (where) {
+            try {
+                whereClause = JSON.parse(where);
+            } catch  {
+                logger.warn(`Invalid where clause JSON: ${where}`);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Error: Invalid JSON in where clause'
+                        }
+                    ]
+                };
+            }
+        }
+        let selectClause;
+        if (select) {
+            try {
+                selectClause = JSON.parse(select);
+            } 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
+                };
+            } 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 = {
+            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;
+        }
+        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
+        };
+    } 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}`
+                }
+            ]
+        };
+    }
+});
+
+//# sourceMappingURL=findTool.js.map

package/dist/mcp/builtin/collections/findTool.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION =\n  'Find documents in a collection by ID or where clause using Find or FindByID.'\n\nexport const findCollectionTool = defineCollectionTool({\n  description: DEFAULT_DESCRIPTION,\n  input: z.object({\n    id: z\n      .union([z.string(), z.number()])\n      .describe(\n        'Optional: specific document ID to retrieve. If not provided, returns all documents',\n      )\n      .optional(),\n    depth: z\n      .number()\n      .int()\n      .min(0)\n      .max(10)\n      .describe('How many levels deep to populate relationships (default: 0)')\n      .optional()\n      .default(0),\n    draft: z\n      .boolean()\n      .describe(\n        'Optional: whether the document should be queried from the versions table/collection or not.',\n      )\n      .optional(),\n    fallbackLocale: z\n      .string()\n      .describe('Optional: fallback locale code to use when requested locale is not available')\n      .optional(),\n    limit: z\n      .number()\n      .int()\n      .min(1)\n      .max(100)\n      .describe('Maximum number of documents to return (default: 10, max: 100)')\n      .optional()\n      .default(10),\n    locale: z\n      .string()\n      .describe(\n        'Optional: locale code to retrieve data in (e.g., \"en\", \"es\"). Use \"all\" to retrieve all locales for localized fields',\n      )\n      .optional(),\n    page: z\n      .number()\n      .int()\n      .min(1)\n      .describe('Page number for pagination (default: 1)')\n      .optional()\n      .default(1),\n    select: z\n      .string()\n      .describe(\n        \"Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\\\"title\\\": true}'\",\n      )\n      .optional(),\n    sort: z\n      .string()\n      .describe('Field to sort by (e.g., \"createdAt\", \"-updatedAt\" for descending)')\n      .optional(),\n    where: z\n      .string()\n      .describe(\n        'Optional JSON string for where clause filtering (e.g., \\'{\"title\": {\"contains\": \"test\"}}\\')',\n      )\n      .optional(),\n  }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n  const payload = req.payload\n  const logger = getLogger({ payload })\n\n  const { id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where } = input\n\n  logger.info(\n    `Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,\n  )\n\n  try {\n    let whereClause: Record<string, unknown> = {}\n    if (where) {\n      try {\n        whereClause = JSON.parse(where) as Record<string, unknown>\n      } catch {\n        logger.warn(`Invalid where clause JSON: ${where}`)\n        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n      }\n    }\n\n    let selectClause: SelectType | undefined\n    if (select) {\n      try {\n        selectClause = JSON.parse(select) as SelectType\n      } catch {\n        logger.warn(`Invalid select clause JSON: ${select}`)\n        return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }\n      }\n    }\n\n    if (id) {\n      try {\n        const doc = await payload.findByID({\n          id,\n          collection: collectionSlug,\n          depth,\n          req,\n          ...localAPIDefaults(authorizedMCP),\n          ...(selectClause && { select: selectClause }),\n          ...(locale && { locale }),\n          ...(fallbackLocale && { fallbackLocale }),\n          ...(draft !== undefined && { draft }),\n        })\n\n        return {\n          content: [\n            {\n              type: 'text',\n              text: `Document from collection \"${collectionSlug}\":\\n${JSON.stringify(doc)}`,\n            },\n          ],\n          doc: doc as Record<string, unknown>,\n        }\n      } catch {\n        logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`)\n        return {\n          content: [\n            {\n              type: 'text',\n              text: `Error: Document with ID \"${id}\" not found in collection \"${collectionSlug}\"`,\n            },\n          ],\n        }\n      }\n    }\n\n    const findOptions: Parameters<typeof payload.find>[0] = {\n      collection: collectionSlug,\n      depth,\n      limit,\n      page,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      ...(selectClause && { select: selectClause }),\n      ...(locale && { locale }),\n      ...(fallbackLocale && { fallbackLocale }),\n      ...(draft !== undefined && { draft }),\n    }\n\n    if (sort) {\n      findOptions.sort = sort\n    }\n    if (Object.keys(whereClause).length > 0) {\n      findOptions.where = whereClause as Parameters<typeof payload.find>[0]['where']\n    }\n\n    const result = await payload.find(findOptions)\n\n    let responseText = `Collection: \"${collectionSlug}\"\\nTotal: ${result.totalDocs} documents\\nPage: ${result.page} of ${result.totalPages}\\n`\n    for (const doc of result.docs) {\n      responseText += `\\n\\`\\`\\`json\\n${JSON.stringify(doc)}\\n\\`\\`\\``\n    }\n\n    return {\n      content: [{ type: 'text', text: responseText }],\n      doc: result as unknown as Record<string, unknown>,\n    }\n  } catch (error) {\n    const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n    logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `❌ **Error reading documents from collection \"${collectionSlug}\":** ${errorMessage}`,\n        },\n      ],\n    }\n  }\n})\n"],"names":["z","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","findCollectionTool","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","draft","boolean","fallbackLocale","limit","locale","page","select","sort","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","whereClause","JSON","parse","warn","content","type","text","selectClause","doc","findByID","collection","undefined","stringify","findOptions","Object","keys","length","result","find","responseText","totalDocs","totalPages","docs","error","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBJ,qBAAqB;IACrDK,aAAaF;IACbG,OAAOP,EAAEQ,MAAM,CAAC;QACdC,IAAIT,EACDU,KAAK,CAAC;YAACV,EAAEW,MAAM;YAAIX,EAAEY,MAAM;SAAG,EAC9BC,QAAQ,CACP,sFAEDC,QAAQ;QACXC,OAAOf,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,+DACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOpB,EACJqB,OAAO,GACPR,QAAQ,CACP,+FAEDC,QAAQ;QACXQ,gBAAgBtB,EACbW,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,OAAOvB,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJL,QAAQ,CAAC,iEACTC,QAAQ,GACRK,OAAO,CAAC;QACXK,QAAQxB,EACLW,MAAM,GACNE,QAAQ,CACP,wHAEDC,QAAQ;QACXW,MAAMzB,EACHY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJJ,QAAQ,CAAC,2CACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,QAAQ1B,EACLW,MAAM,GACNE,QAAQ,CACP,gHAEDC,QAAQ;QACXa,MAAM3B,EACHW,MAAM,GACNE,QAAQ,CAAC,qEACTC,QAAQ;QACXc,OAAO5B,EACJW,MAAM,GACNE,QAAQ,CACP,+FAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAExB,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAShC,UAAU;QAAE+B;IAAQ;IAEnC,MAAM,EAAExB,EAAE,EAAEM,KAAK,EAAEK,KAAK,EAAEE,cAAc,EAAEC,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,KAAK,EAAE,GAAGrB;IAEvF2B,OAAOC,IAAI,CACT,CAAC,kCAAkC,EAAEJ,iBAAiBtB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,GAAG,SAAS,EAAEc,MAAM,QAAQ,EAAEE,OAAOD,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG3J,IAAI;QACF,IAAIY,cAAuC,CAAC;QAC5C,IAAIR,OAAO;YACT,IAAI;gBACFQ,cAAcC,KAAKC,KAAK,CAACV;YAC3B,EAAE,OAAM;gBACNM,OAAOK,IAAI,CAAC,CAAC,2BAA2B,EAAEX,OAAO;gBACjD,OAAO;oBAAEY,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,IAAIC;QACJ,IAAIjB,QAAQ;YACV,IAAI;gBACFiB,eAAeN,KAAKC,KAAK,CAACZ;YAC5B,EAAE,OAAM;gBACNQ,OAAOK,IAAI,CAAC,CAAC,4BAA4B,EAAEb,QAAQ;gBACnD,OAAO;oBAAEc,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAIjC,IAAI;YACN,IAAI;gBACF,MAAMmC,MAAM,MAAMX,QAAQY,QAAQ,CAAC;oBACjCpC;oBACAqC,YAAYf;oBACZhB;oBACAiB;oBACA,GAAG7B,iBAAiB2B,cAAc;oBAClC,GAAIa,gBAAgB;wBAAEjB,QAAQiB;oBAAa,CAAC;oBAC5C,GAAInB,UAAU;wBAAEA;oBAAO,CAAC;oBACxB,GAAIF,kBAAkB;wBAAEA;oBAAe,CAAC;oBACxC,GAAIF,UAAU2B,aAAa;wBAAE3B;oBAAM,CAAC;gBACtC;gBAEA,OAAO;oBACLoB,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,0BAA0B,EAAEX,eAAe,IAAI,EAAEM,KAAKW,SAAS,CAACJ,MAAM;wBAC/E;qBACD;oBACDA,KAAKA;gBACP;YACF,EAAE,OAAM;gBACNV,OAAOK,IAAI,CAAC,CAAC,4BAA4B,EAAE9B,GAAG,gBAAgB,EAAEsB,gBAAgB;gBAChF,OAAO;oBACLS,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,yBAAyB,EAAEjC,GAAG,2BAA2B,EAAEsB,eAAe,CAAC,CAAC;wBACrF;qBACD;gBACH;YACF;QACF;QAEA,MAAMkB,cAAkD;YACtDH,YAAYf;YACZhB;YACAQ;YACAE;YACAO;YACA,GAAG7B,iBAAiB2B,cAAc;YAClC,GAAIa,gBAAgB;gBAAEjB,QAAQiB;YAAa,CAAC;YAC5C,GAAInB,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAIF,kBAAkB;gBAAEA;YAAe,CAAC;YACxC,GAAIF,UAAU2B,aAAa;gBAAE3B;YAAM,CAAC;QACtC;QAEA,IAAIO,MAAM;YACRsB,YAAYtB,IAAI,GAAGA;QACrB;QACA,IAAIuB,OAAOC,IAAI,CAACf,aAAagB,MAAM,GAAG,GAAG;YACvCH,YAAYrB,KAAK,GAAGQ;QACtB;QAEA,MAAMiB,SAAS,MAAMpB,QAAQqB,IAAI,CAACL;QAElC,IAAIM,eAAe,CAAC,aAAa,EAAExB,eAAe,UAAU,EAAEsB,OAAOG,SAAS,CAAC,kBAAkB,EAAEH,OAAO5B,IAAI,CAAC,IAAI,EAAE4B,OAAOI,UAAU,CAAC,EAAE,CAAC;QAC1I,KAAK,MAAMb,OAAOS,OAAOK,IAAI,CAAE;YAC7BH,gBAAgB,CAAC,cAAc,EAAElB,KAAKW,SAAS,CAACJ,KAAK,QAAQ,CAAC;QAChE;QAEA,OAAO;YACLJ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMa;gBAAa;aAAE;YAC/CX,KAAKS;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D5B,OAAOyB,KAAK,CAAC,CAAC,wCAAwC,EAAE5B,eAAe,EAAE,EAAE6B,cAAc;QACzF,OAAO;YACLpB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEX,eAAe,KAAK,EAAE6B,cAAc;gBAC5F;aACD;QACH;IACF;AACF,GAAE"}

package/dist/mcp/builtin/collections/updateTool.d.ts

@@ -0,0 +1,2 @@
+export declare const updateCollectionTool: import("../../../types.js").CollectionTool;
+//# sourceMappingURL=updateTool.d.ts.map

package/dist/mcp/builtin/collections/updateTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,oBAAoB,4CAgM/B,CAAA"}

package/dist/mcp/builtin/collections/updateTool.js

@@ -0,0 +1,191 @@
+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 = {};
+        if (where) {
+            try {
+                whereClause = JSON.parse(where);
+            } catch  {
+                logger.error(`Invalid where clause JSON: ${where}`);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Error: Invalid JSON in where clause'
+                        }
+                    ]
+                };
+            }
+        }
+        let selectClause;
+        if (select) {
+            try {
+                selectClause = JSON.parse(select);
+            } 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);
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                    }
+                ],
+                doc: result
+            };
+        }
+        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);
+        const bulkResult = result;
+        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
+            }
+        };
+    } 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}`
+                }
+            ]
+        };
+    }
+});
+
+//# sourceMappingURL=updateTool.js.map

package/dist/mcp/builtin/collections/updateTool.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n  getCollectionVirtualFieldNames,\n  stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { buildToolInput } from '../../../utils/schemaConversion/buildToolInput.js'\nimport { sanitizeEntitySchema } from '../../../utils/schemaConversion/sanitizeEntitySchema.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\n\nconst DEFAULT_DESCRIPTION = 'Update documents in a collection by ID or where clause.'\n\nexport const updateCollectionTool = defineCollectionTool({\n  description: DEFAULT_DESCRIPTION,\n  input: ({ collectionSchema }) => {\n    const partialSchema = sanitizeEntitySchema(collectionSchema)\n\n    // Collection updates do not require all required fields to be passed => delete .required.\n    //\n    // Local API equivalent: packages/payload/src/collections/operations/local/update.ts#BaseOptions#data:\n    // data: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>\n    delete partialSchema.required\n\n    return buildToolInput({\n      controls: {\n        id: z\n          .union([z.string(), z.number()])\n          .describe('The ID of the document to update')\n          .optional(),\n        depth: z\n          .number()\n          .describe('How many levels deep to populate relationships')\n          .optional()\n          .default(0),\n        draft: z\n          .boolean()\n          .describe('Whether to update the document as a draft')\n          .optional()\n          .default(false),\n        fallbackLocale: z\n          .string()\n          .describe('Optional: fallback locale code to use when requested locale is not available')\n          .optional(),\n        filePath: z.string().describe('File path for file uploads').optional(),\n        locale: z\n          .string()\n          .describe(\n            'Optional: locale code to update the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n          )\n          .optional(),\n        overrideLock: z\n          .boolean()\n          .describe('Whether to override document locks')\n          .optional()\n          .default(true),\n        overwriteExistingFiles: z\n          .boolean()\n          .describe('Whether to overwrite existing files')\n          .optional()\n          .default(false),\n        select: z\n          .string()\n          .describe(\n            'Optional: define exactly which fields you\\'d like to return in the response (JSON), e.g., \\'{\"title\": \"My Post\"}\\'',\n          )\n          .optional(),\n        where: z\n          .string()\n          .describe('JSON string for where clause to update multiple documents')\n          .optional(),\n      },\n      dataDescription: 'The fields to update',\n      dataSchema: partialSchema,\n    })\n  },\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n  const payload = req.payload\n  const logger = getLogger({ payload })\n\n  const {\n    id,\n    data,\n    depth,\n    draft,\n    fallbackLocale,\n    filePath,\n    locale,\n    overrideLock,\n    overwriteExistingFiles,\n    select,\n    where,\n  } = input\n\n  logger.info(\n    `Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,\n  )\n\n  try {\n    if (!id && !where) {\n      return {\n        content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n      }\n    }\n\n    let parsedData = transformPointDataToPayload(data)\n    const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n    parsedData = stripVirtualFields(parsedData, virtualFieldNames)\n\n    let whereClause: Record<string, unknown> = {}\n    if (where) {\n      try {\n        whereClause = JSON.parse(where) as Record<string, unknown>\n      } catch {\n        logger.error(`Invalid where clause JSON: ${where}`)\n        return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n      }\n    }\n\n    let selectClause: SelectType | undefined\n    if (select) {\n      try {\n        selectClause = JSON.parse(select) as SelectType\n      } catch {\n        logger.warn(`Invalid select clause JSON: ${select}`)\n        return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }\n      }\n    }\n\n    if (id) {\n      const updateOptions = {\n        id,\n        collection: collectionSlug,\n        data: parsedData,\n        depth,\n        draft,\n        overrideLock,\n        req,\n        ...localAPIDefaults(authorizedMCP),\n        ...(filePath ? { filePath } : {}),\n        ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n        ...(locale ? { locale } : {}),\n        ...(fallbackLocale ? { fallbackLocale } : {}),\n        ...(selectClause ? { select: selectClause } : {}),\n      }\n\n      const result = await payload.update(updateOptions as any)\n\n      return {\n        content: [\n          {\n            type: 'text',\n            text: `Document updated successfully in collection \"${collectionSlug}\"!\\nUpdated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n          },\n        ],\n        doc: result as Record<string, unknown>,\n      }\n    }\n\n    const updateOptions = {\n      collection: collectionSlug,\n      data: parsedData,\n      depth,\n      draft,\n      overrideLock,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      where: whereClause,\n      ...(filePath ? { filePath } : {}),\n      ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n      ...(locale ? { locale } : {}),\n      ...(fallbackLocale ? { fallbackLocale } : {}),\n      ...(selectClause ? { select: selectClause } : {}),\n    }\n\n    const result = await payload.update(updateOptions as any)\n\n    const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }\n    const docs = bulkResult.docs || []\n    const errors = bulkResult.errors || []\n\n    let responseText = `Multiple documents updated in collection \"${collectionSlug}\"!\\nUpdated: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n    if (docs.length > 0) {\n      responseText += `\\n\\nUpdated documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n    }\n    if (errors.length > 0) {\n      responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n    }\n\n    return {\n      content: [{ type: 'text', text: responseText }],\n      doc: { docs, errors } as unknown as Record<string, unknown>,\n    }\n  } catch (error) {\n    const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n    logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `Error updating document in collection \"${collectionSlug}\": ${errorMessage}`,\n        },\n      ],\n    }\n  }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","buildToolInput","sanitizeEntitySchema","transformPointDataToPayload","DEFAULT_DESCRIPTION","updateCollectionTool","description","input","collectionSchema","partialSchema","required","controls","id","union","string","number","describe","optional","depth","default","draft","boolean","fallbackLocale","filePath","locale","overrideLock","overwriteExistingFiles","select","where","dataDescription","dataSchema","handler","authorizedMCP","collectionSlug","req","payload","logger","data","info","content","type","text","parsedData","virtualFieldNames","config","whereClause","JSON","parse","error","selectClause","warn","updateOptions","collection","result","update","stringify","doc","bulkResult","docs","errors","responseText","length","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,cAAc,QAAQ,oDAAmD;AAClF,SAASC,oBAAoB,QAAQ,0DAAyD;AAC9F,SAASC,2BAA2B,QAAQ,gDAA+C;AAE3F,MAAMC,sBAAsB;AAE5B,OAAO,MAAMC,uBAAuBT,qBAAqB;IACvDU,aAAaF;IACbG,OAAO,CAAC,EAAEC,gBAAgB,EAAE;QAC1B,MAAMC,gBAAgBP,qBAAqBM;QAE3C,0FAA0F;QAC1F,EAAE;QACF,sGAAsG;QACtG,2DAA2D;QAC3D,OAAOC,cAAcC,QAAQ;QAE7B,OAAOT,eAAe;YACpBU,UAAU;gBACRC,IAAIjB,EACDkB,KAAK,CAAC;oBAAClB,EAAEmB,MAAM;oBAAInB,EAAEoB,MAAM;iBAAG,EAC9BC,QAAQ,CAAC,oCACTC,QAAQ;gBACXC,OAAOvB,EACJoB,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRE,OAAO,CAAC;gBACXC,OAAOzB,EACJ0B,OAAO,GACPL,QAAQ,CAAC,6CACTC,QAAQ,GACRE,OAAO,CAAC;gBACXG,gBAAgB3B,EACbmB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;gBACXM,UAAU5B,EAAEmB,MAAM,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;gBACpEO,QAAQ7B,EACLmB,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;gBACXQ,cAAc9B,EACX0B,OAAO,GACPL,QAAQ,CAAC,sCACTC,QAAQ,GACRE,OAAO,CAAC;gBACXO,wBAAwB/B,EACrB0B,OAAO,GACPL,QAAQ,CAAC,uCACTC,QAAQ,GACRE,OAAO,CAAC;gBACXQ,QAAQhC,EACLmB,MAAM,GACNE,QAAQ,CACP,sHAEDC,QAAQ;gBACXW,OAAOjC,EACJmB,MAAM,GACNE,QAAQ,CAAC,6DACTC,QAAQ;YACb;YACAY,iBAAiB;YACjBC,YAAYrB;QACd;IACF;AACF,GAAGsB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAE1B,KAAK,EAAE2B,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASvC,UAAU;QAAEsC;IAAQ;IAEnC,MAAM,EACJvB,EAAE,EACFyB,IAAI,EACJnB,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,MAAM,EACNC,KAAK,EACN,GAAGrB;IAEJ6B,OAAOE,IAAI,CACT,CAAC,iCAAiC,EAAEL,iBAAiBrB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEQ,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACZ,MAAM,CAACgB,OAAO;YACjB,OAAO;gBACLW,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,IAAIC,aAAavC,4BAA4BkC;QAC7C,MAAMM,oBAAoB7C,+BAA+BqC,QAAQS,MAAM,EAAEX;QACzES,aAAa3C,mBAAmB2C,YAAYC;QAE5C,IAAIE,cAAuC,CAAC;QAC5C,IAAIjB,OAAO;YACT,IAAI;gBACFiB,cAAcC,KAAKC,KAAK,CAACnB;YAC3B,EAAE,OAAM;gBACNQ,OAAOY,KAAK,CAAC,CAAC,2BAA2B,EAAEpB,OAAO;gBAClD,OAAO;oBAAEW,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,IAAIQ;QACJ,IAAItB,QAAQ;YACV,IAAI;gBACFsB,eAAeH,KAAKC,KAAK,CAACpB;YAC5B,EAAE,OAAM;gBACNS,OAAOc,IAAI,CAAC,CAAC,4BAA4B,EAAEvB,QAAQ;gBACnD,OAAO;oBAAEY,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAI7B,IAAI;YACN,MAAMuC,gBAAgB;gBACpBvC;gBACAwC,YAAYnB;gBACZI,MAAMK;gBACNxB;gBACAE;gBACAK;gBACAS;gBACA,GAAGlC,iBAAiBgC,cAAc;gBAClC,GAAIT,WAAW;oBAAEA;gBAAS,IAAI,CAAC,CAAC;gBAChC,GAAIG,yBAAyB;oBAAEA;gBAAuB,IAAI,CAAC,CAAC;gBAC5D,GAAIF,SAAS;oBAAEA;gBAAO,IAAI,CAAC,CAAC;gBAC5B,GAAIF,iBAAiB;oBAAEA;gBAAe,IAAI,CAAC,CAAC;gBAC5C,GAAI2B,eAAe;oBAAEtB,QAAQsB;gBAAa,IAAI,CAAC,CAAC;YAClD;YAEA,MAAMI,SAAS,MAAMlB,QAAQmB,MAAM,CAACH;YAEpC,OAAO;gBACLZ,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAER,eAAe,mCAAmC,EAAEa,KAAKS,SAAS,CAACF,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDG,KAAKH;YACP;QACF;QAEA,MAAMF,gBAAgB;YACpBC,YAAYnB;YACZI,MAAMK;YACNxB;YACAE;YACAK;YACAS;YACA,GAAGlC,iBAAiBgC,cAAc;YAClCJ,OAAOiB;YACP,GAAItB,WAAW;gBAAEA;YAAS,IAAI,CAAC,CAAC;YAChC,GAAIG,yBAAyB;gBAAEA;YAAuB,IAAI,CAAC,CAAC;YAC5D,GAAIF,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAI2B,eAAe;gBAAEtB,QAAQsB;YAAa,IAAI,CAAC,CAAC;QAClD;QAEA,MAAMI,SAAS,MAAMlB,QAAQmB,MAAM,CAACH;QAEpC,MAAMM,aAAaJ;QACnB,MAAMK,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,0CAA0C,EAAE3B,eAAe,aAAa,EAAEyB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACpJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEd,KAAKS,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEd,KAAKS,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLpB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMmB;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOX,OAAO;QACd,MAAMc,eAAed,iBAAiBe,QAAQf,MAAMgB,OAAO,GAAG;QAC9D5B,OAAOY,KAAK,CAAC,CAAC,2BAA2B,EAAEf,eAAe,EAAE,EAAE6B,cAAc;QAC5E,OAAO;YACLvB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,uCAAuC,EAAER,eAAe,GAAG,EAAE6B,cAAc;gBACpF;aACD;QACH;IACF;AACF,GAAE"}

package/dist/mcp/builtin/globals/findTool.d.ts

@@ -0,0 +1,2 @@
+export declare const findGlobalTool: import("../../../types.js").GlobalTool;
+//# sourceMappingURL=findTool.d.ts.map

package/dist/mcp/builtin/globals/findTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,cAAc,wCAqFzB,CAAA"}

package/dist/mcp/builtin/globals/findTool.js

@@ -0,0 +1,76 @@
+import { z } from 'zod';
+import { defineGlobalTool } from '../../../defineTool.js';
+import { getLogger } from '../../../utils/getLogger.js';
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
+const DEFAULT_DESCRIPTION = 'Find a Payload global singleton configuration.';
+export const findGlobalTool = defineGlobalTool({
+    description: DEFAULT_DESCRIPTION,
+    input: z.object({
+        depth: z.number().int().min(0).max(10).describe('Depth of population for relationships').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 to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields').optional(),
+        select: z.string().describe("Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'").optional()
+    })
+}).handler(async ({ authorizedMCP, globalSlug, input, req })=>{
+    const payload = req.payload;
+    const logger = getLogger({
+        payload
+    });
+    const { depth, fallbackLocale, locale, select } = input;
+    logger.info(`Reading global: ${globalSlug}, depth: ${depth}${locale ? `, locale: ${locale}` : ''}`);
+    try {
+        const findOptions = {
+            slug: globalSlug,
+            depth,
+            ...localAPIDefaults(authorizedMCP)
+        };
+        let selectClause;
+        if (select) {
+            try {
+                selectClause = JSON.parse(select);
+            } catch  {
+                logger.warn(`Invalid select clause JSON for global: ${select}`);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: 'Error: Invalid JSON in select clause'
+                        }
+                    ]
+                };
+            }
+        }
+        if (locale) {
+            findOptions.locale = locale;
+        }
+        if (fallbackLocale) {
+            findOptions.fallbackLocale = fallbackLocale;
+        }
+        if (selectClause) {
+            findOptions.select = selectClause;
+        }
+        const result = await payload.findGlobal(findOptions);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `Global "${globalSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                }
+            ],
+            doc: result
+        };
+    } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(`Error reading global ${globalSlug}: ${errorMessage}`);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `❌ **Error reading global "${globalSlug}":** ${errorMessage}`
+                }
+            ]
+        };
+    }
+});
+
+//# sourceMappingURL=findTool.js.map