@payloadcms/plugin-mcp 4.0.0-internal.40de3ec → 4.0.0-internal.4804abd

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. package/dist/defaultAccess.d.ts +3 -0
  2. package/dist/defaultAccess.d.ts.map +1 -0
  3. package/dist/defaultAccess.js +3 -0
  4. package/dist/defaultAccess.js.map +1 -0
  5. package/dist/endpoint/access.d.ts +17 -5
  6. package/dist/endpoint/access.d.ts.map +1 -1
  7. package/dist/endpoint/access.js +82 -88
  8. package/dist/endpoint/access.js.map +1 -1
  9. package/dist/endpoint/index.d.ts.map +1 -1
  10. package/dist/endpoint/index.js +11 -0
  11. package/dist/endpoint/index.js.map +1 -1
  12. package/dist/exports/client.d.ts +1 -1
  13. package/dist/exports/client.d.ts.map +1 -1
  14. package/dist/exports/client.js +1 -1
  15. package/dist/exports/client.js.map +1 -1
  16. package/dist/exports/internal.d.ts +2 -0
  17. package/dist/exports/internal.d.ts.map +1 -0
  18. package/dist/exports/internal.js +3 -0
  19. package/dist/exports/internal.js.map +1 -0
  20. package/dist/index.d.ts.map +1 -1
  21. package/dist/index.js +13 -18
  22. package/dist/index.js.map +1 -1
  23. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  24. package/dist/mcp/buildMcpServer.js +102 -71
  25. package/dist/mcp/buildMcpServer.js.map +1 -1
  26. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  27. package/dist/mcp/builtin/collections/authTools.js +44 -6
  28. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  29. package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
  30. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
  31. package/dist/mcp/builtin/collections/countTool.js +69 -0
  32. package/dist/mcp/builtin/collections/countTool.js.map +1 -0
  33. package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
  34. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
  35. package/dist/mcp/builtin/collections/countVersionsTool.js +65 -0
  36. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
  37. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  38. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  39. package/dist/mcp/builtin/collections/createTool.js +38 -42
  40. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  41. package/dist/mcp/builtin/collections/deleteTool.d.ts +1 -1
  42. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  43. package/dist/mcp/builtin/collections/deleteTool.js +14 -20
  44. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  45. package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
  46. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
  47. package/dist/mcp/builtin/collections/duplicateTool.js +97 -0
  48. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
  49. package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
  50. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
  51. package/dist/mcp/builtin/collections/findDistinctTool.js +93 -0
  52. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
  53. package/dist/mcp/builtin/collections/findTool.d.ts +1 -1
  54. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  55. package/dist/mcp/builtin/collections/findTool.js +49 -43
  56. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  57. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
  58. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
  59. package/dist/mcp/builtin/collections/findVersionByIDTool.js +84 -0
  60. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
  61. package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
  62. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
  63. package/dist/mcp/builtin/collections/findVersionsTool.js +99 -0
  64. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
  65. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +9 -0
  66. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -0
  67. package/dist/mcp/builtin/collections/formatCollectionError.js +60 -0
  68. package/dist/mcp/builtin/collections/formatCollectionError.js.map +1 -0
  69. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
  70. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
  71. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +47 -0
  72. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
  73. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
  74. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
  75. package/dist/mcp/builtin/collections/restoreVersionTool.js +82 -0
  76. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
  77. package/dist/mcp/builtin/collections/updateTool.d.ts +1 -1
  78. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  79. package/dist/mcp/builtin/collections/updateTool.js +87 -86
  80. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  81. package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
  82. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
  83. package/dist/mcp/builtin/getConfigInfoTool.js +71 -0
  84. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
  85. package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
  86. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
  87. package/dist/mcp/builtin/globals/countVersionsTool.js +65 -0
  88. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
  89. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  90. package/dist/mcp/builtin/globals/findTool.js +18 -21
  91. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  92. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
  93. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
  94. package/dist/mcp/builtin/globals/findVersionByIDTool.js +80 -0
  95. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
  96. package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
  97. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
  98. package/dist/mcp/builtin/globals/findVersionsTool.js +95 -0
  99. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
  100. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
  101. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
  102. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +47 -0
  103. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
  104. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
  105. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
  106. package/dist/mcp/builtin/globals/restoreVersionTool.js +78 -0
  107. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
  108. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  109. package/dist/mcp/builtin/globals/updateTool.js +31 -40
  110. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  111. package/dist/mcp/builtin/validateEntityData.d.ts +14 -0
  112. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -0
  113. package/dist/mcp/builtin/validateEntityData.js +82 -0
  114. package/dist/mcp/builtin/validateEntityData.js.map +1 -0
  115. package/dist/mcp/builtinTools.d.ts +144 -19
  116. package/dist/mcp/builtinTools.d.ts.map +1 -1
  117. package/dist/mcp/builtinTools.js +119 -20
  118. package/dist/mcp/builtinTools.js.map +1 -1
  119. package/dist/mcp/sanitizeMCPConfig.d.ts +0 -1
  120. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  121. package/dist/mcp/sanitizeMCPConfig.js +120 -58
  122. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  123. package/dist/stdio.d.ts +3 -2
  124. package/dist/stdio.d.ts.map +1 -1
  125. package/dist/stdio.js +27 -8
  126. package/dist/stdio.js.map +1 -1
  127. package/dist/types.d.ts +62 -108
  128. package/dist/types.d.ts.map +1 -1
  129. package/dist/types.js +4 -4
  130. package/dist/types.js.map +1 -1
  131. package/dist/utils/getPluginConfig.d.ts +1 -1
  132. package/dist/utils/getPluginConfig.js +1 -1
  133. package/dist/utils/getPluginConfig.js.map +1 -1
  134. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +11 -0
  135. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -0
  136. package/dist/utils/schemaConversion/getEntityInputSchema.js +32 -0
  137. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -0
  138. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +5 -10
  139. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -1
  140. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +15 -95
  141. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -1
  142. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +15 -40
  143. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -1
  144. package/dist/utils/whereSchema.d.ts +9 -0
  145. package/dist/utils/whereSchema.d.ts.map +1 -0
  146. package/dist/utils/whereSchema.js +13 -0
  147. package/dist/utils/whereSchema.js.map +1 -0
  148. package/package.json +8 -11
  149. package/src/defaultAccess.ts +3 -0
  150. package/src/endpoint/access.ts +88 -101
  151. package/src/endpoint/index.ts +14 -1
  152. package/src/exports/client.ts +2 -1
  153. package/src/exports/internal.ts +1 -0
  154. package/src/index.ts +8 -16
  155. package/src/mcp/buildMcpServer.ts +131 -96
  156. package/src/mcp/builtin/collections/authTools.ts +45 -9
  157. package/src/mcp/builtin/collections/countTool.ts +74 -0
  158. package/src/mcp/builtin/collections/countVersionsTool.ts +70 -0
  159. package/src/mcp/builtin/collections/createTool.ts +55 -59
  160. package/src/mcp/builtin/collections/deleteTool.ts +19 -16
  161. package/src/mcp/builtin/collections/duplicateTool.ts +135 -0
  162. package/src/mcp/builtin/collections/findDistinctTool.ts +120 -0
  163. package/src/mcp/builtin/collections/findTool.ts +63 -33
  164. package/src/mcp/builtin/collections/findVersionByIDTool.ts +110 -0
  165. package/src/mcp/builtin/collections/findVersionsTool.ts +155 -0
  166. package/src/mcp/builtin/collections/formatCollectionError.ts +84 -0
  167. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +46 -0
  168. package/src/mcp/builtin/collections/restoreVersionTool.ts +108 -0
  169. package/src/mcp/builtin/collections/updateTool.ts +111 -110
  170. package/src/mcp/builtin/getConfigInfoTool.ts +69 -0
  171. package/src/mcp/builtin/globals/countVersionsTool.ts +69 -0
  172. package/src/mcp/builtin/globals/findTool.ts +26 -17
  173. package/src/mcp/builtin/globals/findVersionByIDTool.ts +104 -0
  174. package/src/mcp/builtin/globals/findVersionsTool.ts +148 -0
  175. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +41 -0
  176. package/src/mcp/builtin/globals/restoreVersionTool.ts +100 -0
  177. package/src/mcp/builtin/globals/updateTool.ts +50 -55
  178. package/src/mcp/builtin/validateEntityData.ts +132 -0
  179. package/src/mcp/builtinTools.ts +111 -41
  180. package/src/mcp/sanitizeMCPConfig.ts +116 -78
  181. package/src/stdio.ts +23 -8
  182. package/src/types.ts +77 -112
  183. package/src/utils/getPluginConfig.ts +1 -1
  184. package/src/utils/schemaConversion/getEntityInputSchema.ts +62 -0
  185. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +12 -19
  186. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +17 -114
  187. package/src/utils/whereSchema.ts +24 -0
  188. package/dist/collection/getAccessField.d.ts +0 -12
  189. package/dist/collection/getAccessField.d.ts.map +0 -1
  190. package/dist/collection/getAccessField.js +0 -57
  191. package/dist/collection/getAccessField.js.map +0 -1
  192. package/dist/collection/index.d.ts +0 -6
  193. package/dist/collection/index.d.ts.map +0 -1
  194. package/dist/collection/index.js +0 -60
  195. package/dist/collection/index.js.map +0 -1
  196. package/dist/components/AccessField/index.client.d.ts +0 -10
  197. package/dist/components/AccessField/index.client.d.ts.map +0 -1
  198. package/dist/components/AccessField/index.client.js +0 -305
  199. package/dist/components/AccessField/index.client.js.map +0 -1
  200. package/dist/components/AccessField/index.css +0 -93
  201. package/dist/utils/schemaConversion/buildToolInput.d.ts +0 -29
  202. package/dist/utils/schemaConversion/buildToolInput.d.ts.map +0 -1
  203. package/dist/utils/schemaConversion/buildToolInput.js +0 -51
  204. package/dist/utils/schemaConversion/buildToolInput.js.map +0 -1
  205. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  206. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  207. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  208. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  209. package/src/collection/getAccessField.ts +0 -64
  210. package/src/collection/index.ts +0 -64
  211. package/src/components/AccessField/index.client.tsx +0 -344
  212. package/src/components/AccessField/index.css +0 -93
  213. package/src/utils/schemaConversion/buildToolInput.ts +0 -68
  214. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
@@ -0,0 +1,65 @@
1
+ import { z } from 'zod';
2
+ import { defaultAccess } from '../../../defaultAccess.js';
3
+ import { defineCollectionTool } from '../../../defineTool.js';
4
+ import { getLogger } from '../../../utils/getLogger.js';
5
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
6
+ import { whereSchema } from '../../../utils/whereSchema.js';
7
+ const DEFAULT_DESCRIPTION = 'Count document versions in any version-enabled collection by passing the collection slug and optional where clause.';
8
+ export const countVersionsTool = defineCollectionTool({
9
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
10
+ annotations: {
11
+ destructiveHint: false,
12
+ idempotentHint: true,
13
+ openWorldHint: false,
14
+ readOnlyHint: true,
15
+ title: 'Count Versions'
16
+ },
17
+ description: DEFAULT_DESCRIPTION,
18
+ input: z.object({
19
+ locale: z.string().describe('Optional: locale code to count versions in').optional(),
20
+ where: whereSchema.describe('Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.title":{"contains":"test"}}').optional()
21
+ })
22
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
23
+ const payload = req.payload;
24
+ const logger = getLogger({
25
+ payload
26
+ });
27
+ const { locale, where } = input;
28
+ logger.info(`Counting versions in collection: ${collectionSlug}`);
29
+ try {
30
+ const result = await payload.countVersions({
31
+ collection: collectionSlug,
32
+ req,
33
+ ...localAPIDefaults(authorizedMCP),
34
+ ...locale ? {
35
+ locale
36
+ } : {},
37
+ ...where ? {
38
+ where
39
+ } : {}
40
+ });
41
+ return {
42
+ content: [
43
+ {
44
+ type: 'text',
45
+ text: `Collection "${collectionSlug}" contains ${result.totalDocs} matching versions.\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
46
+ }
47
+ ],
48
+ doc: result
49
+ };
50
+ } catch (error) {
51
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
52
+ logger.error(`Error counting versions in ${collectionSlug}: ${errorMessage}`);
53
+ return {
54
+ content: [
55
+ {
56
+ type: 'text',
57
+ text: `❌ **Error counting versions in collection "${collectionSlug}":** ${errorMessage}`
58
+ }
59
+ ],
60
+ isError: true
61
+ };
62
+ }
63
+ });
64
+
65
+ //# sourceMappingURL=countVersionsTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/countVersionsTool.ts"],"sourcesContent":["import { 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 'Count document versions in any version-enabled collection by passing the collection slug and optional where clause.'\n\nexport const countVersionsTool = 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: 'Count Versions',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n locale: z.string().describe('Optional: locale code to count versions in').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 { locale, where } = input\n\n logger.info(`Counting versions in collection: ${collectionSlug}`)\n\n try {\n const result = await payload.countVersions({\n collection: collectionSlug,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale ? { locale } : {}),\n ...(where ? { where } : {}),\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Collection \"${collectionSlug}\" contains ${result.totalDocs} matching versions.\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error counting versions in ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `❌ **Error counting versions in collection \"${collectionSlug}\":** ${errorMessage}`,\n },\n ],\n isError: true,\n }\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","whereSchema","DEFAULT_DESCRIPTION","countVersionsTool","access","args","Boolean","permissions","collections","collectionSlug","readVersions","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","locale","string","describe","optional","where","handler","authorizedMCP","req","payload","logger","info","result","countVersions","collection","content","type","text","totalDocs","JSON","stringify","doc","error","errorMessage","Error","message","isError"],"mappings":"AAAA,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,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,QAAQxB,EAAEyB,MAAM,GAAGC,QAAQ,CAAC,8CAA8CC,QAAQ;QAClFC,OAAOvB,YACJqB,QAAQ,CACP,sJAEDC,QAAQ;IACb;AACF,GAAGE,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEjB,cAAc,EAAES,KAAK,EAAES,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS9B,UAAU;QAAE6B;IAAQ;IACnC,MAAM,EAAER,MAAM,EAAEI,KAAK,EAAE,GAAGN;IAE1BW,OAAOC,IAAI,CAAC,CAAC,iCAAiC,EAAErB,gBAAgB;IAEhE,IAAI;QACF,MAAMsB,SAAS,MAAMH,QAAQI,aAAa,CAAC;YACzCC,YAAYxB;YACZkB;YACA,GAAG3B,iBAAiB0B,cAAc;YAClC,GAAIN,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAII,QAAQ;gBAAEA;YAAM,IAAI,CAAC,CAAC;QAC5B;QAEA,OAAO;YACLU,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,YAAY,EAAE3B,eAAe,WAAW,EAAEsB,OAAOM,SAAS,CAAC,iCAAiC,EAAEC,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBACvI;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,2BAA2B,EAAEhC,eAAe,EAAE,EAAEiC,cAAc;QAC5E,OAAO;YACLR,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,2CAA2C,EAAE3B,eAAe,KAAK,EAAEiC,cAAc;gBAC1F;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}
@@ -1,2 +1,2 @@
1
- export declare const createCollectionTool: import("../../../types.js").CollectionTool;
1
+ export declare const createDocumentTool: import("../../../types.js").CollectionTool;
2
2
  //# sourceMappingURL=createTool.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,oBAAoB,4CAkG/B,CAAA"}
1
+ {"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,kBAAkB,4CA4F7B,CAAA"}
@@ -1,25 +1,31 @@
1
1
  import { z } from 'zod';
2
+ import { defaultAccess } from '../../../defaultAccess.js';
2
3
  import { defineCollectionTool } from '../../../defineTool.js';
3
4
  import { getLogger } from '../../../utils/getLogger.js';
4
5
  import { getCollectionVirtualFieldNames, stripVirtualFields } from '../../../utils/getVirtualFieldNames.js';
5
6
  import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
6
- import { buildToolInput } from '../../../utils/schemaConversion/buildToolInput.js';
7
- import { sanitizeEntitySchema } from '../../../utils/schemaConversion/sanitizeEntitySchema.js';
8
7
  import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
9
- const DEFAULT_DESCRIPTION = 'Create a document in a collection.';
10
- export const createCollectionTool = defineCollectionTool({
8
+ import { validateCollectionData } from '../validateEntityData.js';
9
+ import { formatCollectionError } from './formatCollectionError.js';
10
+ const DEFAULT_DESCRIPTION = 'Create a document in any collection by passing the collection slug and data.';
11
+ export const createDocumentTool = defineCollectionTool({
12
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
13
+ annotations: {
14
+ destructiveHint: false,
15
+ idempotentHint: false,
16
+ openWorldHint: false,
17
+ readOnlyHint: false,
18
+ title: 'Create Document'
19
+ },
11
20
  description: DEFAULT_DESCRIPTION,
12
- input: ({ collectionSchema })=>buildToolInput({
13
- controls: {
14
- depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in response').optional().default(0),
15
- draft: z.boolean().describe('Whether to create the document as a draft').optional().default(false),
16
- fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
17
- locale: z.string().describe('Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
18
- select: z.string().describe('Optional: define exactly which fields you\'d like to create (JSON), e.g., \'{"title": "My Post"}\'').optional()
19
- },
20
- dataDescription: 'The document fields to create',
21
- dataSchema: sanitizeEntitySchema(collectionSchema)
22
- })
21
+ input: z.object({
22
+ data: z.record(z.string(), z.unknown()).describe('The document fields to create'),
23
+ depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in response').optional().default(0),
24
+ draft: z.boolean().describe('Whether to create the document as a draft').optional().default(false),
25
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
26
+ locale: z.string().describe('Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
27
+ select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return, e.g., {"title": true}').optional()
28
+ })
23
29
  }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
24
30
  const payload = req.payload;
25
31
  const logger = getLogger({
@@ -28,25 +34,17 @@ export const createCollectionTool = defineCollectionTool({
28
34
  const { data, depth, draft, fallbackLocale, locale, select } = input;
29
35
  logger.info(`Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`);
30
36
  try {
31
- let parsedData = transformPointDataToPayload(data);
32
37
  const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
33
- parsedData = stripVirtualFields(parsedData, virtualFieldNames);
34
- let selectClause;
35
- if (select) {
36
- try {
37
- selectClause = JSON.parse(select);
38
- } catch {
39
- logger.warn(`Invalid select clause JSON: ${select}`);
40
- return {
41
- content: [
42
- {
43
- type: 'text',
44
- text: 'Error: Invalid JSON in select clause'
45
- }
46
- ]
47
- };
48
- }
38
+ const inputData = stripVirtualFields(data, virtualFieldNames);
39
+ const validationError = validateCollectionData({
40
+ collectionSlug,
41
+ data: inputData,
42
+ req
43
+ });
44
+ if (validationError) {
45
+ return validationError;
49
46
  }
47
+ const parsedData = transformPointDataToPayload(inputData);
50
48
  const result = await payload.create({
51
49
  collection: collectionSlug,
52
50
  data: parsedData,
@@ -60,8 +58,8 @@ export const createCollectionTool = defineCollectionTool({
60
58
  ...fallbackLocale ? {
61
59
  fallbackLocale
62
60
  } : {},
63
- ...selectClause ? {
64
- select: selectClause
61
+ ...select ? {
62
+ select: select
65
63
  } : {}
66
64
  });
67
65
  logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`);
@@ -77,14 +75,12 @@ export const createCollectionTool = defineCollectionTool({
77
75
  } catch (error) {
78
76
  const errorMessage = error instanceof Error ? error.message : 'Unknown error';
79
77
  logger.error(`Error creating document in ${collectionSlug}: ${errorMessage}`);
80
- return {
81
- content: [
82
- {
83
- type: 'text',
84
- text: `Error creating document in collection "${collectionSlug}": ${errorMessage}`
85
- }
86
- ]
87
- };
78
+ return formatCollectionError({
79
+ action: 'creating',
80
+ collectionSlug,
81
+ error,
82
+ req
83
+ });
88
84
  }
89
85
  });
90
86
 
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/createTool.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 = 'Create a document in a collection.'\n\nexport const createCollectionTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: ({ collectionSchema }) =>\n buildToolInput({\n controls: {\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships in response')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to create 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 locale: z\n .string()\n .describe(\n 'Optional: locale code to create the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n select: z\n .string()\n .describe(\n 'Optional: define exactly which fields you\\'d like to create (JSON), e.g., \\'{\"title\": \"My Post\"}\\'',\n )\n .optional(),\n },\n dataDescription: 'The document fields to create',\n dataSchema: sanitizeEntitySchema(collectionSchema),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { data, depth, draft, fallbackLocale, locale, select } = input\n\n logger.info(\n `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,\n )\n\n try {\n let parsedData = transformPointDataToPayload(data)\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n parsedData = stripVirtualFields(parsedData, virtualFieldNames)\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 const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(selectClause ? { select: selectClause } : {}),\n })\n\n logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document created successfully in collection \"${collectionSlug}\"!\\nCreated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error creating document in ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `Error creating document in collection \"${collectionSlug}\": ${errorMessage}`,\n },\n ],\n }\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","buildToolInput","sanitizeEntitySchema","transformPointDataToPayload","DEFAULT_DESCRIPTION","createCollectionTool","description","input","collectionSchema","controls","depth","number","int","min","max","describe","optional","default","draft","boolean","fallbackLocale","string","locale","select","dataDescription","dataSchema","handler","authorizedMCP","collectionSlug","req","payload","logger","data","info","parsedData","virtualFieldNames","config","selectClause","JSON","parse","warn","content","type","text","result","create","collection","id","stringify","doc","error","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,GAC1BP,eAAe;YACbQ,UAAU;gBACRC,OAAOf,EACJgB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,8DACTC,QAAQ,GACRC,OAAO,CAAC;gBACXC,OAAOvB,EACJwB,OAAO,GACPJ,QAAQ,CAAC,6CACTC,QAAQ,GACRC,OAAO,CAAC;gBACXG,gBAAgBzB,EACb0B,MAAM,GACNN,QAAQ,CAAC,gFACTC,QAAQ;gBACXM,QAAQ3B,EACL0B,MAAM,GACNN,QAAQ,CACP,sGAEDC,QAAQ;gBACXO,QAAQ5B,EACL0B,MAAM,GACNN,QAAQ,CACP,sGAEDC,QAAQ;YACb;YACAQ,iBAAiB;YACjBC,YAAYvB,qBAAqBM;QACnC;AACJ,GAAGkB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAErB,KAAK,EAAEsB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASlC,UAAU;QAAEiC;IAAQ;IAEnC,MAAM,EAAEE,IAAI,EAAEtB,KAAK,EAAEQ,KAAK,EAAEE,cAAc,EAAEE,MAAM,EAAEC,MAAM,EAAE,GAAGhB;IAE/DwB,OAAOE,IAAI,CACT,CAAC,iCAAiC,EAAEL,iBAAiBN,SAAS,CAAC,cAAc,EAAEA,QAAQ,GAAG,IAAI;IAGhG,IAAI;QACF,IAAIY,aAAa/B,4BAA4B6B;QAC7C,MAAMG,oBAAoBrC,+BAA+BgC,QAAQM,MAAM,EAAER;QACzEM,aAAanC,mBAAmBmC,YAAYC;QAE5C,IAAIE;QACJ,IAAId,QAAQ;YACV,IAAI;gBACFc,eAAeC,KAAKC,KAAK,CAAChB;YAC5B,EAAE,OAAM;gBACNQ,OAAOS,IAAI,CAAC,CAAC,4BAA4B,EAAEjB,QAAQ;gBACnD,OAAO;oBAAEkB,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,MAAMC,SAAS,MAAMd,QAAQe,MAAM,CAAC;YAClCC,YAAYlB;YACZI,MAAME;YACNxB;YACAQ;YACAW;YACA,GAAG7B,iBAAiB2B,cAAc;YAClC,GAAIL,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIiB,eAAe;gBAAEd,QAAQc;YAAa,IAAI,CAAC,CAAC;QAClD;QAEAN,OAAOE,IAAI,CAAC,CAAC,iCAAiC,EAAEL,eAAe,UAAU,EAAEgB,OAAOG,EAAE,EAAE;QAEtF,OAAO;YACLN,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEf,eAAe,mCAAmC,EAAEU,KAAKU,SAAS,CAACJ,QAAQ,QAAQ,CAAC;gBAC5I;aACD;YACDK,KAAKL;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DtB,OAAOmB,KAAK,CAAC,CAAC,2BAA2B,EAAEtB,eAAe,EAAE,EAAEuB,cAAc;QAC5E,OAAO;YACLV,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,uCAAuC,EAAEf,eAAe,GAAG,EAAEuB,cAAc;gBACpF;aACD;QACH;IACF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"sourcesContent":["import type { 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 {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Create a document in any collection by passing the collection slug and data.'\n\nexport const createDocumentTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),\n annotations: {\n destructiveHint: false,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Create Document',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n data: z.record(z.string(), z.unknown()).describe('The document fields to create'),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships in response')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to create 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 locale: z\n .string()\n .describe(\n 'Optional: locale code to create the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\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, e.g., {\"title\": true}',\n )\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { data, depth, draft, fallbackLocale, locale, select } = input\n\n logger.info(\n `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,\n )\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({ collectionSlug, data: inputData, req })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n\n const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document created successfully in collection \"${collectionSlug}\"!\\nCreated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error creating document in ${collectionSlug}: ${errorMessage}`)\n return formatCollectionError({ action: 'creating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","transformPointDataToPayload","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","createDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","create","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","data","record","string","unknown","describe","depth","number","int","min","max","optional","default","draft","boolean","fallbackLocale","locale","select","handler","authorizedMCP","req","payload","logger","info","virtualFieldNames","config","inputData","validationError","parsedData","result","collection","id","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBT,qBAAqB;IACrDU,QAAQ,CAACC,OACPZ,cAAcY,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,OAAO1B,EAAE2B,MAAM,CAAC;QACdC,MAAM5B,EAAE6B,MAAM,CAAC7B,EAAE8B,MAAM,IAAI9B,EAAE+B,OAAO,IAAIC,QAAQ,CAAC;QACjDC,OAAOjC,EACJkC,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,8DACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAOxC,EACJyC,OAAO,GACPT,QAAQ,CAAC,6CACTM,QAAQ,GACRC,OAAO,CAAC;QACXG,gBAAgB1C,EACb8B,MAAM,GACNE,QAAQ,CAAC,gFACTM,QAAQ;QACXK,QAAQ3C,EACL8B,MAAM,GACNE,QAAQ,CACP,sGAEDM,QAAQ;QACXM,QAAQ5C,EACL6B,MAAM,CAAC7B,EAAE8B,MAAM,IAAI9B,EAAE+B,OAAO,IAC5BC,QAAQ,CACP,sFAEDM,QAAQ;IACb;AACF,GAAGO,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAE7B,cAAc,EAAES,KAAK,EAAEqB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS9C,UAAU;QAAE6C;IAAQ;IAEnC,MAAM,EAAEpB,IAAI,EAAEK,KAAK,EAAEO,KAAK,EAAEE,cAAc,EAAEC,MAAM,EAAEC,MAAM,EAAE,GAAGlB;IAE/DuB,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEjC,iBAAiB0B,SAAS,CAAC,cAAc,EAAEA,QAAQ,GAAG,IAAI;IAGhG,IAAI;QACF,MAAMQ,oBAAoB/C,+BAA+B4C,QAAQI,MAAM,EAAEnC;QACzE,MAAMoC,YAAYhD,mBAAmBuB,MAAMuB;QAC3C,MAAMG,kBAAkB9C,uBAAuB;YAAES;YAAgBW,MAAMyB;YAAWN;QAAI;QAEtF,IAAIO,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAMC,aAAahD,4BAA4B8C;QAE/C,MAAMG,SAAS,MAAMR,QAAQ9B,MAAM,CAAC;YAClCuC,YAAYxC;YACZW,MAAM2B;YACNtB;YACAO;YACAO;YACA,GAAGzC,iBAAiBwC,cAAc;YAClC,GAAIH,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAID,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIE,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEAK,OAAOC,IAAI,CAAC,CAAC,iCAAiC,EAAEjC,eAAe,UAAU,EAAEuC,OAAOE,EAAE,EAAE;QAEtF,OAAO;YACLC,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAE5C,eAAe,mCAAmC,EAAE6C,KAAKC,SAAS,CAACP,QAAQ,QAAQ,CAAC;gBAC5I;aACD;YACDQ,KAAKR;QACP;IACF,EAAE,OAAOS,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DnB,OAAOgB,KAAK,CAAC,CAAC,2BAA2B,EAAEhD,eAAe,EAAE,EAAEiD,cAAc;QAC5E,OAAOzD,sBAAsB;YAAE4D,QAAQ;YAAYpD;YAAgBgD;YAAOlB;QAAI;IAChF;AACF,GAAE"}
@@ -1,2 +1,2 @@
1
- export declare const deleteCollectionTool: import("../../../types.js").CollectionTool;
1
+ export declare const deleteDocumentsTool: import("../../../types.js").CollectionTool;
2
2
  //# sourceMappingURL=deleteTool.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,oBAAoB,4CAkH/B,CAAA"}
1
+ {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,mBAAmB,4CAkH9B,CAAA"}
@@ -1,9 +1,19 @@
1
1
  import { z } from 'zod';
2
+ import { defaultAccess } from '../../../defaultAccess.js';
2
3
  import { defineCollectionTool } from '../../../defineTool.js';
3
4
  import { getLogger } from '../../../utils/getLogger.js';
4
5
  import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
- const DEFAULT_DESCRIPTION = 'Delete documents in a collection by ID or where clause.';
6
- export const deleteCollectionTool = defineCollectionTool({
6
+ import { whereSchema } from '../../../utils/whereSchema.js';
7
+ const DEFAULT_DESCRIPTION = 'Delete documents in any collection by passing the collection slug and ID or where clause.';
8
+ export const deleteDocumentsTool = defineCollectionTool({
9
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.delete),
10
+ annotations: {
11
+ destructiveHint: true,
12
+ idempotentHint: false,
13
+ openWorldHint: false,
14
+ readOnlyHint: false,
15
+ title: 'Delete Documents'
16
+ },
7
17
  description: DEFAULT_DESCRIPTION,
8
18
  input: z.object({
9
19
  id: z.union([
@@ -13,7 +23,7 @@ export const deleteCollectionTool = defineCollectionTool({
13
23
  depth: z.number().int().min(0).max(10).describe('Depth of population for relationships in response').optional().default(0),
14
24
  fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
15
25
  locale: z.string().describe('Optional: locale code for the operation (e.g., "en", "es"). Defaults to the default locale').optional(),
16
- where: z.string().describe('Optional: JSON string for where clause to delete multiple documents').optional()
26
+ where: whereSchema.describe('Optional: where clause to delete multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}').optional()
17
27
  })
18
28
  }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
19
29
  const payload = req.payload;
@@ -33,22 +43,6 @@ export const deleteCollectionTool = defineCollectionTool({
33
43
  ]
34
44
  };
35
45
  }
36
- let whereClause = {};
37
- if (where) {
38
- try {
39
- whereClause = JSON.parse(where);
40
- } catch {
41
- logger.warn(`Invalid where clause JSON: ${where}`);
42
- return {
43
- content: [
44
- {
45
- type: 'text',
46
- text: 'Error: Invalid JSON in where clause'
47
- }
48
- ]
49
- };
50
- }
51
- }
52
46
  const deleteOptions = {
53
47
  collection: collectionSlug,
54
48
  depth,
@@ -64,7 +58,7 @@ export const deleteCollectionTool = defineCollectionTool({
64
58
  if (id) {
65
59
  deleteOptions.id = id;
66
60
  } else {
67
- deleteOptions.where = whereClause;
61
+ deleteOptions.where = where;
68
62
  }
69
63
  const result = await payload.delete(deleteOptions);
70
64
  if (id) {
@@ -1 +1 @@
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"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"sourcesContent":["import { 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 'Delete documents in any collection by passing the collection slug and ID or where clause.'\n\nexport const deleteDocumentsTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.delete),\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Delete Documents',\n },\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: whereSchema\n .describe(\n 'Optional: where clause to delete multiple documents. 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 { 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 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 = where\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","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","whereSchema","DEFAULT_DESCRIPTION","deleteDocumentsTool","access","args","Boolean","permissions","collections","collectionSlug","delete","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","fallbackLocale","locale","where","handler","authorizedMCP","req","payload","logger","info","content","type","text","deleteOptions","collection","result","JSON","stringify","doc","bulkResult","docs","errors","responseText","length","error","errorMessage","Error","message"],"mappings":"AAAA,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,sBAAsBL,qBAAqB;IACtDM,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,CAAC,4CACTC,QAAQ;QACXC,OAAO9B,EACJ2B,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,qDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,gBAAgBnC,EACb0B,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXO,QAAQpC,EACL0B,MAAM,GACNE,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,OAAOhC,YACJuB,QAAQ,CACP,mKAEDC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAE1B,cAAc,EAAES,KAAK,EAAEkB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASvC,UAAU;QAAEsC;IAAQ;IAEnC,MAAM,EAAEjB,EAAE,EAAEM,KAAK,EAAEK,cAAc,EAAEC,MAAM,EAAEC,KAAK,EAAE,GAAGf;IAErDoB,OAAOC,IAAI,CACT,CAAC,mCAAmC,EAAE9B,iBAAiBW,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,uBAAuBY,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG9I,IAAI;QACF,IAAI,CAACZ,MAAM,CAACa,OAAO;YACjB,OAAO;gBACLO,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,gBAAyC;YAC7CC,YAAYnC;YACZiB;YACAU;YACA,GAAGpC,iBAAiBmC,cAAc;YAClC,GAAIH,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,kBAAkB;gBAAEA;YAAe,CAAC;QAC1C;QAEA,IAAIX,IAAI;YACNuB,cAAcvB,EAAE,GAAGA;QACrB,OAAO;YACLuB,cAAcV,KAAK,GAAGA;QACxB;QAEA,MAAMY,SAAS,MAAMR,QAAQ3B,MAAM,CAACiC;QAEpC,IAAIvB,IAAI;YACN,OAAO;gBACLoB,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAEjC,eAAe,mCAAmC,EAAEqC,KAAKC,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,EAAE3C,eAAe,aAAa,EAAEyC,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACzJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEN,KAAKC,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEN,KAAKC,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLX,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMU;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DnB,OAAOgB,KAAK,CAAC,CAAC,6BAA6B,EAAE7C,eAAe,EAAE,EAAE8C,cAAc;QAC9E,OAAO;YACLf,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAEjC,eAAe,GAAG,EAAE8C,cAAc;gBACtF;aACD;QACH;IACF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const duplicateDocumentTool: import("../../../types.js").CollectionTool;
2
+ //# sourceMappingURL=duplicateTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"duplicateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/duplicateTool.ts"],"names":[],"mappings":"AAkBA,eAAO,MAAM,qBAAqB,4CAoHhC,CAAA"}
@@ -0,0 +1,97 @@
1
+ import { z } from 'zod';
2
+ import { defaultAccess } from '../../../defaultAccess.js';
3
+ import { defineCollectionTool } from '../../../defineTool.js';
4
+ import { getLogger } from '../../../utils/getLogger.js';
5
+ import { getCollectionVirtualFieldNames, stripVirtualFields } from '../../../utils/getVirtualFieldNames.js';
6
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
7
+ import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
8
+ import { formatCollectionError } from './formatCollectionError.js';
9
+ const DEFAULT_DESCRIPTION = 'Duplicate a document in any collection by passing the collection slug and source document ID.';
10
+ export const duplicateDocumentTool = defineCollectionTool({
11
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
12
+ annotations: {
13
+ destructiveHint: false,
14
+ idempotentHint: false,
15
+ openWorldHint: false,
16
+ readOnlyHint: false,
17
+ title: 'Duplicate Document'
18
+ },
19
+ description: DEFAULT_DESCRIPTION,
20
+ input: z.object({
21
+ id: z.union([
22
+ z.string(),
23
+ z.number()
24
+ ]).describe('The ID of the document to duplicate'),
25
+ data: z.record(z.string(), z.unknown()).describe('Optional: fields to override on the duplicated document').optional(),
26
+ depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in response').optional().default(0),
27
+ draft: z.boolean().describe('Whether to create the duplicate as a draft').optional().default(false),
28
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
29
+ locale: z.string().describe('Optional: locale code to duplicate in (e.g., "en", "es"). Defaults to the default locale').optional(),
30
+ populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
31
+ 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(),
32
+ selectedLocales: z.array(z.string()).describe('Optional: localized field locales to include in the duplicated document').optional(),
33
+ showHiddenFields: z.boolean().describe('Optional: include hidden fields in the duplicated document response').optional()
34
+ })
35
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
36
+ const payload = req.payload;
37
+ const logger = getLogger({
38
+ payload
39
+ });
40
+ const { id, data, depth, draft, fallbackLocale, locale, populate, select, selectedLocales, showHiddenFields } = input;
41
+ logger.info(`Duplicating document in collection: ${collectionSlug} with ID: ${id}`);
42
+ try {
43
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
44
+ const inputData = data ? stripVirtualFields(data, virtualFieldNames) : undefined;
45
+ const parsedData = inputData ? transformPointDataToPayload(inputData) : undefined;
46
+ const result = await payload.duplicate({
47
+ id,
48
+ collection: collectionSlug,
49
+ depth,
50
+ draft,
51
+ req,
52
+ ...localAPIDefaults(authorizedMCP),
53
+ ...parsedData ? {
54
+ data: parsedData
55
+ } : {},
56
+ ...locale ? {
57
+ locale
58
+ } : {},
59
+ ...fallbackLocale ? {
60
+ fallbackLocale
61
+ } : {},
62
+ ...populate ? {
63
+ populate: populate
64
+ } : {},
65
+ ...select ? {
66
+ select: select
67
+ } : {},
68
+ ...selectedLocales ? {
69
+ selectedLocales
70
+ } : {},
71
+ ...showHiddenFields !== undefined ? {
72
+ showHiddenFields
73
+ } : {}
74
+ });
75
+ logger.info(`Successfully duplicated document in ${collectionSlug} from ID: ${id}`);
76
+ return {
77
+ content: [
78
+ {
79
+ type: 'text',
80
+ text: `Document duplicated successfully in collection "${collectionSlug}"!\nDuplicated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
81
+ }
82
+ ],
83
+ doc: result
84
+ };
85
+ } catch (error) {
86
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
87
+ logger.error(`Error duplicating document in ${collectionSlug}: ${errorMessage}`);
88
+ return formatCollectionError({
89
+ action: 'duplicating',
90
+ collectionSlug,
91
+ error,
92
+ req
93
+ });
94
+ }
95
+ });
96
+
97
+ //# sourceMappingURL=duplicateTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/duplicateTool.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 {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Duplicate a document in any collection by passing the collection slug and source document ID.'\n\nexport const duplicateDocumentTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),\n annotations: {\n destructiveHint: false,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Duplicate Document',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z.union([z.string(), z.number()]).describe('The ID of the document to duplicate'),\n data: z\n .record(z.string(), z.unknown())\n .describe('Optional: fields to override on the duplicated document')\n .optional(),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships in response')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to create the duplicate 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 locale: z\n .string()\n .describe(\n 'Optional: locale code to duplicate in (e.g., \"en\", \"es\"). Defaults to the default locale',\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., {\"title\": true}',\n )\n .optional(),\n selectedLocales: z\n .array(z.string())\n .describe('Optional: localized field locales to include in the duplicated document')\n .optional(),\n showHiddenFields: z\n .boolean()\n .describe('Optional: include hidden fields in the duplicated document response')\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n const {\n id,\n data,\n depth,\n draft,\n fallbackLocale,\n locale,\n populate,\n select,\n selectedLocales,\n showHiddenFields,\n } = input\n\n logger.info(`Duplicating document in collection: ${collectionSlug} with ID: ${id}`)\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = data ? stripVirtualFields(data, virtualFieldNames) : undefined\n const parsedData = inputData ? transformPointDataToPayload(inputData) : undefined\n\n const result = await payload.duplicate({\n id,\n collection: collectionSlug,\n depth,\n draft,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(parsedData ? { data: parsedData } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(populate ? { populate: populate as PopulateType } : {}),\n ...(select ? { select: select as SelectType } : {}),\n ...(selectedLocales ? { selectedLocales } : {}),\n ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),\n })\n\n logger.info(`Successfully duplicated document in ${collectionSlug} from ID: ${id}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document duplicated successfully in collection \"${collectionSlug}\"!\\nDuplicated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error duplicating document in ${collectionSlug}: ${errorMessage}`)\n return formatCollectionError({ action: 'duplicating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","transformPointDataToPayload","formatCollectionError","DEFAULT_DESCRIPTION","duplicateDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","create","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","data","record","unknown","optional","depth","int","min","max","default","draft","boolean","fallbackLocale","locale","populate","select","selectedLocales","array","showHiddenFields","handler","authorizedMCP","req","payload","logger","info","virtualFieldNames","config","inputData","undefined","parsedData","result","duplicate","collection","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,wBAAwBR,qBAAqB;IACxDS,QAAQ,CAACC,OACPX,cAAcW,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,OAAOzB,EAAE0B,MAAM,CAAC;QACdC,IAAI3B,EAAE4B,KAAK,CAAC;YAAC5B,EAAE6B,MAAM;YAAI7B,EAAE8B,MAAM;SAAG,EAAEC,QAAQ,CAAC;QAC/CC,MAAMhC,EACHiC,MAAM,CAACjC,EAAE6B,MAAM,IAAI7B,EAAEkC,OAAO,IAC5BH,QAAQ,CAAC,2DACTI,QAAQ;QACXC,OAAOpC,EACJ8B,MAAM,GACNO,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJR,QAAQ,CAAC,8DACTI,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOzC,EACJ0C,OAAO,GACPX,QAAQ,CAAC,8CACTI,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgB3C,EACb6B,MAAM,GACNE,QAAQ,CAAC,gFACTI,QAAQ;QACXS,QAAQ5C,EACL6B,MAAM,GACNE,QAAQ,CACP,4FAEDI,QAAQ;QACXU,UAAU7C,EACPiC,MAAM,CAACjC,EAAE6B,MAAM,IAAI7B,EAAEkC,OAAO,IAC5BH,QAAQ,CACP,8FAEDI,QAAQ;QACXW,QAAQ9C,EACLiC,MAAM,CAACjC,EAAE6B,MAAM,IAAI7B,EAAEkC,OAAO,IAC5BH,QAAQ,CACP,sGAEDI,QAAQ;QACXY,iBAAiB/C,EACdgD,KAAK,CAAChD,EAAE6B,MAAM,IACdE,QAAQ,CAAC,2EACTI,QAAQ;QACXc,kBAAkBjD,EACf0C,OAAO,GACPX,QAAQ,CAAC,uEACTI,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEnC,cAAc,EAAES,KAAK,EAAE2B,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASnD,UAAU;QAAEkD;IAAQ;IACnC,MAAM,EACJ1B,EAAE,EACFK,IAAI,EACJI,KAAK,EACLK,KAAK,EACLE,cAAc,EACdC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,eAAe,EACfE,gBAAgB,EACjB,GAAGxB;IAEJ6B,OAAOC,IAAI,CAAC,CAAC,oCAAoC,EAAEvC,eAAe,UAAU,EAAEW,IAAI;IAElF,IAAI;QACF,MAAM6B,oBAAoBpD,+BAA+BiD,QAAQI,MAAM,EAAEzC;QACzE,MAAM0C,YAAY1B,OAAO3B,mBAAmB2B,MAAMwB,qBAAqBG;QACvE,MAAMC,aAAaF,YAAYnD,4BAA4BmD,aAAaC;QAExE,MAAME,SAAS,MAAMR,QAAQS,SAAS,CAAC;YACrCnC;YACAoC,YAAY/C;YACZoB;YACAK;YACAW;YACA,GAAG9C,iBAAiB6C,cAAc;YAClC,GAAIS,aAAa;gBAAE5B,MAAM4B;YAAW,IAAI,CAAC,CAAC;YAC1C,GAAIhB,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAID,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIE,WAAW;gBAAEA,UAAUA;YAAyB,IAAI,CAAC,CAAC;YAC1D,GAAIC,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;YAClD,GAAIC,kBAAkB;gBAAEA;YAAgB,IAAI,CAAC,CAAC;YAC9C,GAAIE,qBAAqBU,YAAY;gBAAEV;YAAiB,IAAI,CAAC,CAAC;QAChE;QAEAK,OAAOC,IAAI,CAAC,CAAC,oCAAoC,EAAEvC,eAAe,UAAU,EAAEW,IAAI;QAElF,OAAO;YACLqC,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,gDAAgD,EAAElD,eAAe,sCAAsC,EAAEmD,KAAKC,SAAS,CAACP,QAAQ,QAAQ,CAAC;gBAClJ;aACD;YACDQ,KAAKR;QACP;IACF,EAAE,OAAOS,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DnB,OAAOgB,KAAK,CAAC,CAAC,8BAA8B,EAAEtD,eAAe,EAAE,EAAEuD,cAAc;QAC/E,OAAO/D,sBAAsB;YAAEkE,QAAQ;YAAe1D;YAAgBsD;YAAOlB;QAAI;IACnF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const findDistinctTool: import("../../../types.js").CollectionTool;
2
+ //# sourceMappingURL=findDistinctTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"findDistinctTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findDistinctTool.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,gBAAgB,4CA0G3B,CAAA"}
@@ -0,0 +1,93 @@
1
+ import { z } from 'zod';
2
+ import { defaultAccess } from '../../../defaultAccess.js';
3
+ import { defineCollectionTool } from '../../../defineTool.js';
4
+ import { getLogger } from '../../../utils/getLogger.js';
5
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
6
+ import { whereSchema } from '../../../utils/whereSchema.js';
7
+ const DEFAULT_DESCRIPTION = 'Find distinct values for a field in any collection by passing the collection slug and field path.';
8
+ export const findDistinctTool = defineCollectionTool({
9
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
10
+ annotations: {
11
+ destructiveHint: false,
12
+ idempotentHint: true,
13
+ openWorldHint: false,
14
+ readOnlyHint: true,
15
+ title: 'Find Distinct'
16
+ },
17
+ description: DEFAULT_DESCRIPTION,
18
+ input: z.object({
19
+ depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in distinct values').optional().default(0),
20
+ field: z.string().describe('The field path to get distinct values for'),
21
+ limit: z.number().int().min(1).max(100).describe('Maximum number of distinct values to return (max: 100)').optional(),
22
+ 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(),
23
+ page: z.number().int().min(1).describe('Page number for pagination').optional(),
24
+ populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
25
+ showHiddenFields: z.boolean().describe('Optional: include hidden fields in the distinct query').optional(),
26
+ sort: z.string().describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)').optional(),
27
+ trash: z.boolean().describe('Optional: include soft-deleted documents when trash is enabled on the collection').optional(),
28
+ where: whereSchema.describe('Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}').optional()
29
+ })
30
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
31
+ const payload = req.payload;
32
+ const logger = getLogger({
33
+ payload
34
+ });
35
+ const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } = input;
36
+ logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`);
37
+ try {
38
+ const result = await payload.findDistinct({
39
+ collection: collectionSlug,
40
+ depth,
41
+ field,
42
+ req,
43
+ ...localAPIDefaults(authorizedMCP),
44
+ ...limit ? {
45
+ limit
46
+ } : {},
47
+ ...locale ? {
48
+ locale
49
+ } : {},
50
+ ...page ? {
51
+ page
52
+ } : {},
53
+ ...populate ? {
54
+ populate: populate
55
+ } : {},
56
+ ...showHiddenFields !== undefined ? {
57
+ showHiddenFields
58
+ } : {},
59
+ ...sort ? {
60
+ sort
61
+ } : {},
62
+ ...trash !== undefined ? {
63
+ trash
64
+ } : {},
65
+ ...where ? {
66
+ where
67
+ } : {}
68
+ });
69
+ return {
70
+ content: [
71
+ {
72
+ type: 'text',
73
+ text: `Distinct values for "${field}" in collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
74
+ }
75
+ ],
76
+ doc: result
77
+ };
78
+ } catch (error) {
79
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
80
+ logger.error(`Error finding distinct values in ${collectionSlug}: ${errorMessage}`);
81
+ return {
82
+ content: [
83
+ {
84
+ type: 'text',
85
+ text: `❌ **Error finding distinct values in collection "${collectionSlug}":** ${errorMessage}`
86
+ }
87
+ ],
88
+ isError: true
89
+ };
90
+ }
91
+ });
92
+
93
+ //# sourceMappingURL=findDistinctTool.js.map