@payloadcms/plugin-mcp 4.0.0-internal.d28e9fb → 4.0.0-internal.fa345ef

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

@@ -0,0 +1,93 @@
+import { z } from 'zod';
+import { defaultAccess } from '../../../defaultAccess.js';
+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 distinct values for a field in any collection by passing the collection slug and field path.';
+export const findDistinctTool = defineCollectionTool({
+    access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
+    annotations: {
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: false,
+        readOnlyHint: true,
+        title: 'Find Distinct'
+    },
+    description: DEFAULT_DESCRIPTION,
+    input: z.object({
+        depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in distinct values').optional().default(0),
+        field: z.string().describe('The field path to get distinct values for'),
+        limit: z.number().int().min(1).max(100).describe('Maximum number of distinct values to return (max: 100)').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(),
+        page: z.number().int().min(1).describe('Page number for pagination').optional(),
+        populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
+        showHiddenFields: z.boolean().describe('Optional: include hidden fields in the distinct query').optional(),
+        sort: z.string().describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)').optional(),
+        trash: z.boolean().describe('Optional: include soft-deleted documents when trash is enabled on the collection').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 { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } = input;
+    logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`);
+    try {
+        const result = await payload.findDistinct({
+            collection: collectionSlug,
+            depth,
+            field,
+            req,
+            ...localAPIDefaults(authorizedMCP),
+            ...limit ? {
+                limit
+            } : {},
+            ...locale ? {
+                locale
+            } : {},
+            ...page ? {
+                page
+            } : {},
+            ...populate ? {
+                populate: populate
+            } : {},
+            ...showHiddenFields !== undefined ? {
+                showHiddenFields
+            } : {},
+            ...sort ? {
+                sort
+            } : {},
+            ...trash !== undefined ? {
+                trash
+            } : {},
+            ...where ? {
+                where
+            } : {}
+        });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `Distinct values for "${field}" in collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                }
+            ],
+            doc: result
+        };
+    } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(`Error finding distinct values in ${collectionSlug}: ${errorMessage}`);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `❌ **Error finding distinct values in collection "${collectionSlug}":** ${errorMessage}`
+                }
+            ],
+            isError: true
+        };
+    }
+});
+
+//# sourceMappingURL=findDistinctTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/findDistinctTool.ts"],"sourcesContent":["import type { PopulateType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n  'Find distinct values for a field in any collection by passing the collection slug and field path.'\n\nexport const findDistinctTool = defineCollectionTool({\n  access: (args) =>\n    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),\n  annotations: {\n    destructiveHint: false,\n    idempotentHint: true,\n    openWorldHint: false,\n    readOnlyHint: true,\n    title: 'Find Distinct',\n  },\n  description: DEFAULT_DESCRIPTION,\n  input: z.object({\n    depth: z\n      .number()\n      .int()\n      .min(0)\n      .max(10)\n      .describe('How many levels deep to populate relationships in distinct values')\n      .optional()\n      .default(0),\n    field: z.string().describe('The field path to get distinct values for'),\n    limit: z\n      .number()\n      .int()\n      .min(1)\n      .max(100)\n      .describe('Maximum number of distinct values to return (max: 100)')\n      .optional(),\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.number().int().min(1).describe('Page number for pagination').optional(),\n    populate: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: control which fields to include from populated relationship or upload documents.',\n      )\n      .optional(),\n    showHiddenFields: z\n      .boolean()\n      .describe('Optional: include hidden fields in the distinct query')\n      .optional(),\n    sort: z\n      .string()\n      .describe('Field to sort by (e.g., \"createdAt\", \"-updatedAt\" for descending)')\n      .optional(),\n    trash: z\n      .boolean()\n      .describe('Optional: include soft-deleted documents when trash is enabled on the collection')\n      .optional(),\n    where: whereSchema\n      .describe(\n        'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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  const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } = input\n\n  logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`)\n\n  try {\n    const result = await payload.findDistinct({\n      collection: collectionSlug,\n      depth,\n      field,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      ...(limit ? { limit } : {}),\n      ...(locale ? { locale } : {}),\n      ...(page ? { page } : {}),\n      ...(populate ? { populate: populate as PopulateType } : {}),\n      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),\n      ...(sort ? { sort } : {}),\n      ...(trash !== undefined ? { trash } : {}),\n      ...(where ? { where } : {}),\n    })\n\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `Distinct values for \"${field}\" in collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n        },\n      ],\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 finding distinct values in ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `❌ **Error finding distinct values in collection \"${collectionSlug}\":** ${errorMessage}`,\n        },\n      ],\n      isError: true,\n    }\n  }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","whereSchema","DEFAULT_DESCRIPTION","findDistinctTool","access","args","Boolean","permissions","collections","collectionSlug","read","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","depth","number","int","min","max","describe","optional","default","field","string","limit","locale","page","populate","record","unknown","showHiddenFields","boolean","sort","trash","where","handler","authorizedMCP","req","payload","logger","info","result","findDistinct","collection","undefined","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","isError"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,mBAAmBL,qBAAqB;IACnDM,QAAQ,CAACC,OACPR,cAAcQ,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOtB,EAAEuB,MAAM,CAAC;QACdC,OAAOxB,EACJyB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,qEACTC,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAOhC,EAAEiC,MAAM,GAAGJ,QAAQ,CAAC;QAC3BK,OAAOlC,EACJyB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJC,QAAQ,CAAC,0DACTC,QAAQ;QACXK,QAAQnC,EACLiC,MAAM,GACNJ,QAAQ,CACP,wHAEDC,QAAQ;QACXM,MAAMpC,EAAEyB,MAAM,GAAGC,GAAG,GAAGC,GAAG,CAAC,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;QAC7EO,UAAUrC,EACPsC,MAAM,CAACtC,EAAEiC,MAAM,IAAIjC,EAAEuC,OAAO,IAC5BV,QAAQ,CACP,8FAEDC,QAAQ;QACXU,kBAAkBxC,EACfyC,OAAO,GACPZ,QAAQ,CAAC,yDACTC,QAAQ;QACXY,MAAM1C,EACHiC,MAAM,GACNJ,QAAQ,CAAC,qEACTC,QAAQ;QACXa,OAAO3C,EACJyC,OAAO,GACPZ,QAAQ,CAAC,oFACTC,QAAQ;QACXc,OAAOvC,YACJwB,QAAQ,CACP,oJAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEjC,cAAc,EAAES,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS9C,UAAU;QAAE6C;IAAQ;IACnC,MAAM,EAAExB,KAAK,EAAEQ,KAAK,EAAEE,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEG,gBAAgB,EAAEE,IAAI,EAAEC,KAAK,EAAEC,KAAK,EAAE,GAAGtB;IAE9F2B,OAAOC,IAAI,CAAC,CAAC,uCAAuC,EAAErC,eAAe,SAAS,EAAEmB,OAAO;IAEvF,IAAI;QACF,MAAMmB,SAAS,MAAMH,QAAQI,YAAY,CAAC;YACxCC,YAAYxC;YACZW;YACAQ;YACAe;YACA,GAAG3C,iBAAiB0C,cAAc;YAClC,GAAIZ,QAAQ;gBAAEA;YAAM,IAAI,CAAC,CAAC;YAC1B,GAAIC,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIC,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIC,WAAW;gBAAEA,UAAUA;YAAyB,IAAI,CAAC,CAAC;YAC1D,GAAIG,qBAAqBc,YAAY;gBAAEd;YAAiB,IAAI,CAAC,CAAC;YAC9D,GAAIE,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIC,UAAUW,YAAY;gBAAEX;YAAM,IAAI,CAAC,CAAC;YACxC,GAAIC,QAAQ;gBAAEA;YAAM,IAAI,CAAC,CAAC;QAC5B;QAEA,OAAO;YACLW,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,qBAAqB,EAAEzB,MAAM,iBAAiB,EAAEnB,eAAe,gBAAgB,EAAE6C,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBAC1H;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,iCAAiC,EAAEhD,eAAe,EAAE,EAAEiD,cAAc;QAClF,OAAO;YACLP,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,iDAAiD,EAAE5C,eAAe,KAAK,EAAEiD,cAAc;gBAChG;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}

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

@@ -0,0 +1,2 @@
+export declare const findDocumentsTool: 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":"AAaA,eAAO,MAAM,iBAAiB,4CA2M5B,CAAA"}

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

@@ -0,0 +1,165 @@
+import { z } from 'zod';
+import { defaultAccess } from '../../../defaultAccess.js';
+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({
+    access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
+    annotations: {
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: false,
+        readOnlyHint: true,
+        title: 'Find Documents'
+    },
+    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(),
+        joins: z.union([
+            z.record(z.string(), z.unknown()),
+            z.literal(false)
+        ]).describe('Optional: configure join field queries, or pass false to disable all join fields.').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),
+        pagination: z.boolean().describe('Optional: set to false to skip the count query overhead').optional(),
+        populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
+        select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}').optional(),
+        sort: z.string().describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)').optional(),
+        trash: z.boolean().describe('Optional: include soft-deleted documents when trash is enabled on the collection').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, joins, limit, locale, page, pagination, populate, select, sort, trash, where } = input;
+    logger.info(`Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`);
+    try {
+        if (id) {
+            try {
+                const doc = await payload.findByID({
+                    id,
+                    collection: collectionSlug,
+                    depth,
+                    req,
+                    ...localAPIDefaults(authorizedMCP),
+                    ...select && {
+                        select: select
+                    },
+                    ...populate && {
+                        populate: populate
+                    },
+                    ...joins !== undefined && {
+                        joins: joins
+                    },
+                    ...locale && {
+                        locale
+                    },
+                    ...fallbackLocale && {
+                        fallbackLocale
+                    },
+                    ...draft !== undefined && {
+                        draft
+                    },
+                    ...trash !== undefined && {
+                        trash
+                    }
+                });
+                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),
+            ...select && {
+                select: select
+            },
+            ...populate && {
+                populate: populate
+            },
+            ...joins !== undefined && {
+                joins: joins
+            },
+            ...locale && {
+                locale
+            },
+            ...fallbackLocale && {
+                fallbackLocale
+            },
+            ...draft !== undefined && {
+                draft
+            },
+            ...pagination !== undefined && {
+                pagination
+            },
+            ...trash !== undefined && {
+                trash
+            }
+        };
+        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
+        };
+    } 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 { JoinQuery, PopulateType, SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n  'Find documents in any collection by passing the collection slug and optional ID or where clause.'\n\nexport const findDocumentsTool = defineCollectionTool({\n  access: (args) =>\n    defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),\n  annotations: {\n    destructiveHint: false,\n    idempotentHint: true,\n    openWorldHint: false,\n    readOnlyHint: true,\n    title: 'Find Documents',\n  },\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    joins: z\n      .union([z.record(z.string(), z.unknown()), z.literal(false)])\n      .describe('Optional: configure join field queries, or pass false to disable all join fields.')\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    pagination: z\n      .boolean()\n      .describe('Optional: set to false to skip the count query overhead')\n      .optional(),\n    populate: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: control which fields to include from populated relationship or upload documents.',\n      )\n      .optional(),\n    select: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: define exactly which fields you\\'d like to return in the response, 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    trash: z\n      .boolean()\n      .describe('Optional: include soft-deleted documents when trash is enabled on the collection')\n      .optional(),\n    where: whereSchema\n      .describe(\n        'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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 {\n    id,\n    depth,\n    draft,\n    fallbackLocale,\n    joins,\n    limit,\n    locale,\n    page,\n    pagination,\n    populate,\n    select,\n    sort,\n    trash,\n    where,\n  } = 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    if (id) {\n      try {\n        const doc = await payload.findByID({\n          id,\n          collection: collectionSlug,\n          depth,\n          req,\n          ...localAPIDefaults(authorizedMCP),\n          ...(select && { select: select as SelectType }),\n          ...(populate && { populate: populate as PopulateType }),\n          ...(joins !== undefined && { joins: joins as JoinQuery }),\n          ...(locale && { locale }),\n          ...(fallbackLocale && { fallbackLocale }),\n          ...(draft !== undefined && { draft }),\n          ...(trash !== undefined && { trash }),\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      ...(select && { select: select as SelectType }),\n      ...(populate && { populate: populate as PopulateType }),\n      ...(joins !== undefined && { joins: joins as JoinQuery }),\n      ...(locale && { locale }),\n      ...(fallbackLocale && { fallbackLocale }),\n      ...(draft !== undefined && { draft }),\n      ...(pagination !== undefined && { pagination }),\n      ...(trash !== undefined && { trash }),\n    }\n\n    if (sort) {\n      findOptions.sort = sort\n    }\n    if (where) {\n      findOptions.where = 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","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","whereSchema","DEFAULT_DESCRIPTION","findDocumentsTool","access","args","Boolean","permissions","collections","collectionSlug","read","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","draft","boolean","fallbackLocale","joins","record","unknown","literal","limit","locale","page","pagination","populate","select","sort","trash","where","handler","authorizedMCP","req","payload","logger","info","doc","findByID","collection","undefined","content","type","text","JSON","stringify","warn","findOptions","result","find","responseText","totalDocs","totalPages","docs","error","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,oBAAoBL,qBAAqB;IACpDM,QAAQ,CAACC,OACPR,cAAcQ,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOtB,EAAEuB,MAAM,CAAC;QACdC,IAAIxB,EACDyB,KAAK,CAAC;YAACzB,EAAE0B,MAAM;YAAI1B,EAAE2B,MAAM;SAAG,EAC9BC,QAAQ,CACP,sFAEDC,QAAQ;QACXC,OAAO9B,EACJ2B,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,+DACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOnC,EACJoC,OAAO,GACPR,QAAQ,CACP,+FAEDC,QAAQ;QACXQ,gBAAgBrC,EACb0B,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,OAAOtC,EACJyB,KAAK,CAAC;YAACzB,EAAEuC,MAAM,CAACvC,EAAE0B,MAAM,IAAI1B,EAAEwC,OAAO;YAAKxC,EAAEyC,OAAO,CAAC;SAAO,EAC3Db,QAAQ,CAAC,qFACTC,QAAQ;QACXa,OAAO1C,EACJ2B,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJL,QAAQ,CAAC,iEACTC,QAAQ,GACRK,OAAO,CAAC;QACXS,QAAQ3C,EACL0B,MAAM,GACNE,QAAQ,CACP,wHAEDC,QAAQ;QACXe,MAAM5C,EACH2B,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJJ,QAAQ,CAAC,2CACTC,QAAQ,GACRK,OAAO,CAAC;QACXW,YAAY7C,EACToC,OAAO,GACPR,QAAQ,CAAC,2DACTC,QAAQ;QACXiB,UAAU9C,EACPuC,MAAM,CAACvC,EAAE0B,MAAM,IAAI1B,EAAEwC,OAAO,IAC5BZ,QAAQ,CACP,8FAEDC,QAAQ;QACXkB,QAAQ/C,EACLuC,MAAM,CAACvC,EAAE0B,MAAM,IAAI1B,EAAEwC,OAAO,IAC5BZ,QAAQ,CACP,sGAEDC,QAAQ;QACXmB,MAAMhD,EACH0B,MAAM,GACNE,QAAQ,CAAC,qEACTC,QAAQ;QACXoB,OAAOjD,EACJoC,OAAO,GACPR,QAAQ,CAAC,oFACTC,QAAQ;QACXqB,OAAO7C,YACJuB,QAAQ,CACP,oJAEDC,QAAQ;IACb;AACF,GAAGsB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEvC,cAAc,EAAES,KAAK,EAAE+B,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASpD,UAAU;QAAEmD;IAAQ;IAEnC,MAAM,EACJ9B,EAAE,EACFM,KAAK,EACLK,KAAK,EACLE,cAAc,EACdC,KAAK,EACLI,KAAK,EACLC,MAAM,EACNC,IAAI,EACJC,UAAU,EACVC,QAAQ,EACRC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,KAAK,EACN,GAAG5B;IAEJiC,OAAOC,IAAI,CACT,CAAC,kCAAkC,EAAE3C,iBAAiBW,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,GAAG,SAAS,EAAEkB,MAAM,QAAQ,EAAEE,OAAOD,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG3J,IAAI;QACF,IAAInB,IAAI;YACN,IAAI;gBACF,MAAMiC,MAAM,MAAMH,QAAQI,QAAQ,CAAC;oBACjClC;oBACAmC,YAAY9C;oBACZiB;oBACAuB;oBACA,GAAGjD,iBAAiBgD,cAAc;oBAClC,GAAIL,UAAU;wBAAEA,QAAQA;oBAAqB,CAAC;oBAC9C,GAAID,YAAY;wBAAEA,UAAUA;oBAAyB,CAAC;oBACtD,GAAIR,UAAUsB,aAAa;wBAAEtB,OAAOA;oBAAmB,CAAC;oBACxD,GAAIK,UAAU;wBAAEA;oBAAO,CAAC;oBACxB,GAAIN,kBAAkB;wBAAEA;oBAAe,CAAC;oBACxC,GAAIF,UAAUyB,aAAa;wBAAEzB;oBAAM,CAAC;oBACpC,GAAIc,UAAUW,aAAa;wBAAEX;oBAAM,CAAC;gBACtC;gBAEA,OAAO;oBACLY,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,0BAA0B,EAAElD,eAAe,IAAI,EAAEmD,KAAKC,SAAS,CAACR,MAAM;wBAC/E;qBACD;oBACDA,KAAKA;gBACP;YACF,EAAE,OAAM;gBACNF,OAAOW,IAAI,CAAC,CAAC,4BAA4B,EAAE1C,GAAG,gBAAgB,EAAEX,gBAAgB;gBAChF,OAAO;oBACLgD,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,yBAAyB,EAAEvC,GAAG,2BAA2B,EAAEX,eAAe,CAAC,CAAC;wBACrF;qBACD;gBACH;YACF;QACF;QAEA,MAAMsD,cAAkD;YACtDR,YAAY9C;YACZiB;YACAY;YACAE;YACAS;YACA,GAAGjD,iBAAiBgD,cAAc;YAClC,GAAIL,UAAU;gBAAEA,QAAQA;YAAqB,CAAC;YAC9C,GAAID,YAAY;gBAAEA,UAAUA;YAAyB,CAAC;YACtD,GAAIR,UAAUsB,aAAa;gBAAEtB,OAAOA;YAAmB,CAAC;YACxD,GAAIK,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAIN,kBAAkB;gBAAEA;YAAe,CAAC;YACxC,GAAIF,UAAUyB,aAAa;gBAAEzB;YAAM,CAAC;YACpC,GAAIU,eAAee,aAAa;gBAAEf;YAAW,CAAC;YAC9C,GAAII,UAAUW,aAAa;gBAAEX;YAAM,CAAC;QACtC;QAEA,IAAID,MAAM;YACRmB,YAAYnB,IAAI,GAAGA;QACrB;QACA,IAAIE,OAAO;YACTiB,YAAYjB,KAAK,GAAGA;QACtB;QAEA,MAAMkB,SAAS,MAAMd,QAAQe,IAAI,CAACF;QAElC,IAAIG,eAAe,CAAC,aAAa,EAAEzD,eAAe,UAAU,EAAEuD,OAAOG,SAAS,CAAC,kBAAkB,EAAEH,OAAOxB,IAAI,CAAC,IAAI,EAAEwB,OAAOI,UAAU,CAAC,EAAE,CAAC;QAC1I,KAAK,MAAMf,OAAOW,OAAOK,IAAI,CAAE;YAC7BH,gBAAgB,CAAC,cAAc,EAAEN,KAAKC,SAAS,CAACR,KAAK,QAAQ,CAAC;QAChE;QAEA,OAAO;YACLI,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMO;gBAAa;aAAE;YAC/Cb,KAAKW;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DtB,OAAOmB,KAAK,CAAC,CAAC,wCAAwC,EAAE7D,eAAe,EAAE,EAAE8D,cAAc;QACzF,OAAO;YACLd,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAElD,eAAe,KAAK,EAAE8D,cAAc;gBAC5F;aACD;QACH;IACF;AACF,GAAE"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"findVersionByIDTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findVersionByIDTool.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,mBAAmB,4CAiG9B,CAAA"}

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

@@ -0,0 +1,84 @@
+import { z } from 'zod';
+import { defaultAccess } from '../../../defaultAccess.js';
+import { defineCollectionTool } from '../../../defineTool.js';
+import { getLogger } from '../../../utils/getLogger.js';
+import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
+const DEFAULT_DESCRIPTION = 'Find a specific document version in any version-enabled collection by passing the collection slug and version ID.';
+export const findVersionByIDTool = defineCollectionTool({
+    access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
+    annotations: {
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: false,
+        readOnlyHint: true,
+        title: 'Find Version By ID'
+    },
+    description: DEFAULT_DESCRIPTION,
+    input: z.object({
+        id: z.string().describe('The ID of the version to retrieve'),
+        depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in the version document').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(),
+        populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
+        select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"version.title": true}').optional(),
+        showHiddenFields: z.boolean().describe('Optional: include hidden fields in the returned version document').optional(),
+        trash: z.boolean().describe('Optional: include soft-deleted version documents when trash is enabled').optional()
+    })
+}).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
+    const payload = req.payload;
+    const logger = getLogger({
+        payload
+    });
+    const { id, depth, fallbackLocale, locale, populate, select, showHiddenFields, trash } = input;
+    logger.info(`Finding version in collection: ${collectionSlug} with ID: ${id}`);
+    try {
+        const result = await payload.findVersionByID({
+            id,
+            collection: collectionSlug,
+            depth,
+            req,
+            ...localAPIDefaults(authorizedMCP),
+            ...fallbackLocale ? {
+                fallbackLocale
+            } : {},
+            ...locale ? {
+                locale
+            } : {},
+            ...populate ? {
+                populate: populate
+            } : {},
+            ...select ? {
+                select: select
+            } : {},
+            ...showHiddenFields !== undefined ? {
+                showHiddenFields
+            } : {},
+            ...trash !== undefined ? {
+                trash
+            } : {}
+        });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `Version "${id}" from collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                }
+            ],
+            doc: result
+        };
+    } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(`Error finding version ${id} in ${collectionSlug}: ${errorMessage}`);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `❌ **Error finding version "${id}" in collection "${collectionSlug}":** ${errorMessage}`
+                }
+            ],
+            isError: true
+        };
+    }
+});
+
+//# sourceMappingURL=findVersionByIDTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/findVersionByIDTool.ts"],"sourcesContent":["import type { PopulateType, SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION =\n  'Find a specific document version in any version-enabled collection by passing the collection slug and version ID.'\n\nexport const findVersionByIDTool = defineCollectionTool({\n  access: (args) =>\n    defaultAccess(args) &&\n    Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),\n  annotations: {\n    destructiveHint: false,\n    idempotentHint: true,\n    openWorldHint: false,\n    readOnlyHint: true,\n    title: 'Find Version By ID',\n  },\n  description: DEFAULT_DESCRIPTION,\n  input: z.object({\n    id: z.string().describe('The ID of the version to retrieve'),\n    depth: z\n      .number()\n      .int()\n      .min(0)\n      .max(10)\n      .describe('How many levels deep to populate relationships in the version document')\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 to retrieve data in (e.g., \"en\", \"es\"). Use \"all\" to retrieve all locales for localized fields',\n      )\n      .optional(),\n    populate: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: control which fields to include from populated relationship or upload documents.',\n      )\n      .optional(),\n    select: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: define exactly which fields you\\'d like to return in the response, e.g., {\"version.title\": true}',\n      )\n      .optional(),\n    showHiddenFields: z\n      .boolean()\n      .describe('Optional: include hidden fields in the returned version document')\n      .optional(),\n    trash: z\n      .boolean()\n      .describe('Optional: include soft-deleted version documents when trash is enabled')\n      .optional(),\n  }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n  const payload = req.payload\n  const logger = getLogger({ payload })\n  const { id, depth, fallbackLocale, locale, populate, select, showHiddenFields, trash } = input\n\n  logger.info(`Finding version in collection: ${collectionSlug} with ID: ${id}`)\n\n  try {\n    const result = await payload.findVersionByID({\n      id,\n      collection: collectionSlug,\n      depth,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      ...(fallbackLocale ? { fallbackLocale } : {}),\n      ...(locale ? { locale } : {}),\n      ...(populate ? { populate: populate as PopulateType } : {}),\n      ...(select ? { select: select as SelectType } : {}),\n      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),\n      ...(trash !== undefined ? { trash } : {}),\n    })\n\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `Version \"${id}\" from collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n        },\n      ],\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 finding version ${id} in ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `❌ **Error finding version \"${id}\" in collection \"${collectionSlug}\":** ${errorMessage}`,\n        },\n      ],\n      isError: true,\n    }\n  }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","findVersionByIDTool","access","args","Boolean","permissions","collections","collectionSlug","readVersions","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","string","describe","depth","number","int","min","max","optional","default","fallbackLocale","locale","populate","record","unknown","select","showHiddenFields","boolean","trash","handler","authorizedMCP","req","payload","logger","info","result","findVersionByID","collection","undefined","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","isError"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,sBAAsBJ,qBAAqB;IACtDK,QAAQ,CAACC,OACPP,cAAcO,SACdC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IAChEC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOrB,EAAEsB,MAAM,CAAC;QACdC,IAAIvB,EAAEwB,MAAM,GAAGC,QAAQ,CAAC;QACxBC,OAAO1B,EACJ2B,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,0EACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,gBAAgBjC,EACbwB,MAAM,GACNC,QAAQ,CAAC,gFACTM,QAAQ;QACXG,QAAQlC,EACLwB,MAAM,GACNC,QAAQ,CACP,wHAEDM,QAAQ;QACXI,UAAUnC,EACPoC,MAAM,CAACpC,EAAEwB,MAAM,IAAIxB,EAAEqC,OAAO,IAC5BZ,QAAQ,CACP,8FAEDM,QAAQ;QACXO,QAAQtC,EACLoC,MAAM,CAACpC,EAAEwB,MAAM,IAAIxB,EAAEqC,OAAO,IAC5BZ,QAAQ,CACP,8GAEDM,QAAQ;QACXQ,kBAAkBvC,EACfwC,OAAO,GACPf,QAAQ,CAAC,oEACTM,QAAQ;QACXU,OAAOzC,EACJwC,OAAO,GACPf,QAAQ,CAAC,0EACTM,QAAQ;IACb;AACF,GAAGW,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAE/B,cAAc,EAAES,KAAK,EAAEuB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS3C,UAAU;QAAE0C;IAAQ;IACnC,MAAM,EAAEtB,EAAE,EAAEG,KAAK,EAAEO,cAAc,EAAEC,MAAM,EAAEC,QAAQ,EAAEG,MAAM,EAAEC,gBAAgB,EAAEE,KAAK,EAAE,GAAGpB;IAEzFyB,OAAOC,IAAI,CAAC,CAAC,+BAA+B,EAAEnC,eAAe,UAAU,EAAEW,IAAI;IAE7E,IAAI;QACF,MAAMyB,SAAS,MAAMH,QAAQI,eAAe,CAAC;YAC3C1B;YACA2B,YAAYtC;YACZc;YACAkB;YACA,GAAGxC,iBAAiBuC,cAAc;YAClC,GAAIV,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIC,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIC,WAAW;gBAAEA,UAAUA;YAAyB,IAAI,CAAC,CAAC;YAC1D,GAAIG,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;YAClD,GAAIC,qBAAqBY,YAAY;gBAAEZ;YAAiB,IAAI,CAAC,CAAC;YAC9D,GAAIE,UAAUU,YAAY;gBAAEV;YAAM,IAAI,CAAC,CAAC;QAC1C;QAEA,OAAO;YACLW,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,SAAS,EAAE/B,GAAG,mBAAmB,EAAEX,eAAe,gBAAgB,EAAE2C,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBAC7G;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,sBAAsB,EAAEnC,GAAG,IAAI,EAAEX,eAAe,EAAE,EAAE+C,cAAc;QAChF,OAAO;YACLP,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,2BAA2B,EAAE/B,GAAG,iBAAiB,EAAEX,eAAe,KAAK,EAAE+C,cAAc;gBAChG;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"findVersionsTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findVersionsTool.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,gBAAgB,4CA6I3B,CAAA"}

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

@@ -0,0 +1,99 @@
+import { z } from 'zod';
+import { defaultAccess } from '../../../defaultAccess.js';
+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 document versions in any version-enabled collection by passing the collection slug and optional where clause.';
+export const findVersionsTool = defineCollectionTool({
+    access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
+    annotations: {
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: false,
+        readOnlyHint: true,
+        title: 'Find Versions'
+    },
+    description: DEFAULT_DESCRIPTION,
+    input: z.object({
+        depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in version documents').optional().default(0),
+        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 versions 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),
+        pagination: z.boolean().describe('Optional: set to false to skip the count query overhead').optional(),
+        populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
+        select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"version.title": true}').optional(),
+        showHiddenFields: z.boolean().describe('Optional: include hidden fields in returned version documents').optional(),
+        sort: z.string().describe('Field to sort by (e.g., "-updatedAt", "-version.updatedAt" for descending)').optional(),
+        trash: z.boolean().describe('Optional: include versions for soft-deleted documents when trash is enabled').optional(),
+        where: whereSchema.describe('Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.title":{"contains":"test"}}').optional()
+    })
+}).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
+    const payload = req.payload;
+    const logger = getLogger({
+        payload
+    });
+    const { depth, fallbackLocale, limit, locale, page, pagination, populate, select, showHiddenFields, sort, trash, where } = input;
+    logger.info(`Finding versions in collection: ${collectionSlug}, limit: ${limit}, page: ${page}`);
+    try {
+        const result = await payload.findVersions({
+            collection: collectionSlug,
+            depth,
+            limit,
+            page,
+            req,
+            ...localAPIDefaults(authorizedMCP),
+            ...fallbackLocale ? {
+                fallbackLocale
+            } : {},
+            ...locale ? {
+                locale
+            } : {},
+            ...pagination !== undefined ? {
+                pagination
+            } : {},
+            ...populate ? {
+                populate: populate
+            } : {},
+            ...select ? {
+                select: select
+            } : {},
+            ...showHiddenFields !== undefined ? {
+                showHiddenFields
+            } : {},
+            ...sort ? {
+                sort
+            } : {},
+            ...trash !== undefined ? {
+                trash
+            } : {},
+            ...where ? {
+                where
+            } : {}
+        });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `Versions for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
+                }
+            ],
+            doc: result
+        };
+    } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(`Error finding versions in ${collectionSlug}: ${errorMessage}`);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `❌ **Error finding versions in collection "${collectionSlug}":** ${errorMessage}`
+                }
+            ],
+            isError: true
+        };
+    }
+});
+
+//# sourceMappingURL=findVersionsTool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/mcp/builtin/collections/findVersionsTool.ts"],"sourcesContent":["import type { PopulateType, SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n  'Find document versions in any version-enabled collection by passing the collection slug and optional where clause.'\n\nexport const findVersionsTool = defineCollectionTool({\n  access: (args) =>\n    defaultAccess(args) &&\n    Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),\n  annotations: {\n    destructiveHint: false,\n    idempotentHint: true,\n    openWorldHint: false,\n    readOnlyHint: true,\n    title: 'Find Versions',\n  },\n  description: DEFAULT_DESCRIPTION,\n  input: z.object({\n    depth: z\n      .number()\n      .int()\n      .min(0)\n      .max(10)\n      .describe('How many levels deep to populate relationships in version documents')\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    limit: z\n      .number()\n      .int()\n      .min(1)\n      .max(100)\n      .describe('Maximum number of versions 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    pagination: z\n      .boolean()\n      .describe('Optional: set to false to skip the count query overhead')\n      .optional(),\n    populate: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: control which fields to include from populated relationship or upload documents.',\n      )\n      .optional(),\n    select: z\n      .record(z.string(), z.unknown())\n      .describe(\n        'Optional: define exactly which fields you\\'d like to return in the response, e.g., {\"version.title\": true}',\n      )\n      .optional(),\n    showHiddenFields: z\n      .boolean()\n      .describe('Optional: include hidden fields in returned version documents')\n      .optional(),\n    sort: z\n      .string()\n      .describe('Field to sort by (e.g., \"-updatedAt\", \"-version.updatedAt\" for descending)')\n      .optional(),\n    trash: z\n      .boolean()\n      .describe('Optional: include versions for soft-deleted documents when trash is enabled')\n      .optional(),\n    where: whereSchema\n      .describe(\n        'Optional: where clause for filtering versions. Version document fields are usually under \"version\". Example: {\"version.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  const {\n    depth,\n    fallbackLocale,\n    limit,\n    locale,\n    page,\n    pagination,\n    populate,\n    select,\n    showHiddenFields,\n    sort,\n    trash,\n    where,\n  } = input\n\n  logger.info(`Finding versions in collection: ${collectionSlug}, limit: ${limit}, page: ${page}`)\n\n  try {\n    const result = await payload.findVersions({\n      collection: collectionSlug,\n      depth,\n      limit,\n      page,\n      req,\n      ...localAPIDefaults(authorizedMCP),\n      ...(fallbackLocale ? { fallbackLocale } : {}),\n      ...(locale ? { locale } : {}),\n      ...(pagination !== undefined ? { pagination } : {}),\n      ...(populate ? { populate: populate as PopulateType } : {}),\n      ...(select ? { select: select as SelectType } : {}),\n      ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),\n      ...(sort ? { sort } : {}),\n      ...(trash !== undefined ? { trash } : {}),\n      ...(where ? { where } : {}),\n    })\n\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `Versions for collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n        },\n      ],\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 finding versions in ${collectionSlug}: ${errorMessage}`)\n    return {\n      content: [\n        {\n          type: 'text',\n          text: `❌ **Error finding versions in collection \"${collectionSlug}\":** ${errorMessage}`,\n        },\n      ],\n      isError: true,\n    }\n  }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","whereSchema","DEFAULT_DESCRIPTION","findVersionsTool","access","args","Boolean","permissions","collections","collectionSlug","readVersions","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","depth","number","int","min","max","describe","optional","default","fallbackLocale","string","limit","locale","page","pagination","boolean","populate","record","unknown","select","showHiddenFields","sort","trash","where","handler","authorizedMCP","req","payload","logger","info","result","findVersions","collection","undefined","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","isError"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,mBAAmBL,qBAAqB;IACnDM,QAAQ,CAACC,OACPR,cAAcQ,SACdC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IAChEC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOtB,EAAEuB,MAAM,CAAC;QACdC,OAAOxB,EACJyB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,uEACTC,QAAQ,GACRC,OAAO,CAAC;QACXC,gBAAgBhC,EACbiC,MAAM,GACNJ,QAAQ,CAAC,gFACTC,QAAQ;QACXI,OAAOlC,EACJyB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJC,QAAQ,CAAC,gEACTC,QAAQ,GACRC,OAAO,CAAC;QACXI,QAAQnC,EACLiC,MAAM,GACNJ,QAAQ,CACP,wHAEDC,QAAQ;QACXM,MAAMpC,EACHyB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJE,QAAQ,CAAC,2CACTC,QAAQ,GACRC,OAAO,CAAC;QACXM,YAAYrC,EACTsC,OAAO,GACPT,QAAQ,CAAC,2DACTC,QAAQ;QACXS,UAAUvC,EACPwC,MAAM,CAACxC,EAAEiC,MAAM,IAAIjC,EAAEyC,OAAO,IAC5BZ,QAAQ,CACP,8FAEDC,QAAQ;QACXY,QAAQ1C,EACLwC,MAAM,CAACxC,EAAEiC,MAAM,IAAIjC,EAAEyC,OAAO,IAC5BZ,QAAQ,CACP,8GAEDC,QAAQ;QACXa,kBAAkB3C,EACfsC,OAAO,GACPT,QAAQ,CAAC,iEACTC,QAAQ;QACXc,MAAM5C,EACHiC,MAAM,GACNJ,QAAQ,CAAC,8EACTC,QAAQ;QACXe,OAAO7C,EACJsC,OAAO,GACPT,QAAQ,CAAC,+EACTC,QAAQ;QACXgB,OAAOzC,YACJwB,QAAQ,CACP,sJAEDC,QAAQ;IACb;AACF,GAAGiB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEnC,cAAc,EAAES,KAAK,EAAE2B,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAShD,UAAU;QAAE+C;IAAQ;IACnC,MAAM,EACJ1B,KAAK,EACLQ,cAAc,EACdE,KAAK,EACLC,MAAM,EACNC,IAAI,EACJC,UAAU,EACVE,QAAQ,EACRG,MAAM,EACNC,gBAAgB,EAChBC,IAAI,EACJC,KAAK,EACLC,KAAK,EACN,GAAGxB;IAEJ6B,OAAOC,IAAI,CAAC,CAAC,gCAAgC,EAAEvC,eAAe,SAAS,EAAEqB,MAAM,QAAQ,EAAEE,MAAM;IAE/F,IAAI;QACF,MAAMiB,SAAS,MAAMH,QAAQI,YAAY,CAAC;YACxCC,YAAY1C;YACZW;YACAU;YACAE;YACAa;YACA,GAAG7C,iBAAiB4C,cAAc;YAClC,GAAIhB,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIG,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIE,eAAemB,YAAY;gBAAEnB;YAAW,IAAI,CAAC,CAAC;YAClD,GAAIE,WAAW;gBAAEA,UAAUA;YAAyB,IAAI,CAAC,CAAC;YAC1D,GAAIG,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;YAClD,GAAIC,qBAAqBa,YAAY;gBAAEb;YAAiB,IAAI,CAAC,CAAC;YAC9D,GAAIC,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIC,UAAUW,YAAY;gBAAEX;YAAM,IAAI,CAAC,CAAC;YACxC,GAAIC,QAAQ;gBAAEA;YAAM,IAAI,CAAC,CAAC;QAC5B;QAEA,OAAO;YACLW,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yBAAyB,EAAE9C,eAAe,gBAAgB,EAAE+C,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBACrG;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,0BAA0B,EAAElD,eAAe,EAAE,EAAEmD,cAAc;QAC3E,OAAO;YACLP,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,0CAA0C,EAAE9C,eAAe,KAAK,EAAEmD,cAAc;gBACzF;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}

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

@@ -0,0 +1,9 @@
+import type { CollectionSlug, PayloadRequest } from 'payload';
+import type { MCPToolResponse } from '../../../types.js';
+export declare const formatCollectionError: ({ action, collectionSlug, error, req, }: {
+    action: "creating" | "duplicating" | "updating";
+    collectionSlug: CollectionSlug;
+    error: unknown;
+    req: PayloadRequest;
+}) => MCPToolResponse;
+//# sourceMappingURL=formatCollectionError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"formatCollectionError.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/formatCollectionError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAgCxD,eAAO,MAAM,qBAAqB,GAAI,yCAKnC;IACD,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,UAAU,CAAA;IAC/C,cAAc,EAAE,cAAc,CAAA;IAC9B,KAAK,EAAE,OAAO,CAAA;IACd,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,eAuCH,CAAA"}

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

@@ -0,0 +1,60 @@
+import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js';
+const getValidationErrors = (error)=>{
+    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, message)=>{
+    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 })=>{
+    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
+            }
+        } : {}
+    };
+};
+
+//# sourceMappingURL=formatCollectionError.js.map