@payloadcms/plugin-mcp 4.0.0-internal.bc5cf8c → 4.0.0-internal.bf4bcce

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 (204) hide show
  1. package/LICENSE.md +1 -1
  2. package/dist/defaultAccess.d.ts.map +1 -1
  3. package/dist/defineTool.d.ts +8 -8
  4. package/dist/defineTool.d.ts.map +1 -1
  5. package/dist/endpoint/access.d.ts +2 -7
  6. package/dist/endpoint/access.d.ts.map +1 -1
  7. package/dist/endpoint/access.js +17 -14
  8. package/dist/endpoint/access.js.map +1 -1
  9. package/dist/endpoint/index.d.ts +1 -1
  10. package/dist/endpoint/index.d.ts.map +1 -1
  11. package/dist/endpoint/index.js +91 -16
  12. package/dist/endpoint/index.js.map +1 -1
  13. package/dist/endpoint/oauth.d.ts +27 -0
  14. package/dist/endpoint/oauth.d.ts.map +1 -0
  15. package/dist/endpoint/oauth.js +61 -0
  16. package/dist/endpoint/oauth.js.map +1 -0
  17. package/dist/index.d.ts +3 -2
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +9 -2
  20. package/dist/index.js.map +1 -1
  21. package/dist/mcp/buildMcpServer.d.ts +6 -6
  22. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  23. package/dist/mcp/buildMcpServer.js +68 -34
  24. package/dist/mcp/buildMcpServer.js.map +1 -1
  25. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  26. package/dist/mcp/builtin/collections/authTools.js +80 -56
  27. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  28. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  29. package/dist/mcp/builtin/collections/countTool.js +10 -16
  30. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  31. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/countVersionsTool.js +10 -15
  33. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  34. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  35. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  36. package/dist/mcp/builtin/collections/createTool.js +104 -54
  37. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  38. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  39. package/dist/mcp/builtin/collections/deleteTool.js +45 -45
  40. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  41. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  42. package/dist/mcp/builtin/collections/duplicateTool.js +32 -39
  43. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  44. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  45. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  46. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  47. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  48. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  49. package/dist/mcp/builtin/collections/findDistinctTool.js +12 -28
  50. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  51. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  52. package/dist/mcp/builtin/collections/findTool.js +29 -48
  53. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  54. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  55. package/dist/mcp/builtin/collections/findVersionByIDTool.js +18 -28
  56. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  57. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  58. package/dist/mcp/builtin/collections/findVersionsTool.js +17 -32
  59. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  60. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  61. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +68 -12
  62. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  63. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  64. package/dist/mcp/builtin/collections/restoreVersionTool.js +15 -28
  65. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  66. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  67. package/dist/mcp/builtin/collections/updateTool.js +67 -87
  68. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  69. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  70. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  71. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  72. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  73. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  74. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  75. package/dist/mcp/builtin/formatEntityError.js +55 -0
  76. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  77. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  78. package/dist/mcp/builtin/getConfigInfoTool.js +5 -7
  79. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  80. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  81. package/dist/mcp/builtin/globals/countVersionsTool.js +10 -15
  82. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  83. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  84. package/dist/mcp/builtin/globals/findTool.js +12 -18
  85. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  86. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  87. package/dist/mcp/builtin/globals/findVersionByIDTool.js +14 -26
  88. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  89. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  90. package/dist/mcp/builtin/globals/findVersionsTool.js +14 -31
  91. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  92. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  93. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +46 -12
  94. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  95. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  96. package/dist/mcp/builtin/globals/restoreVersionTool.js +16 -24
  97. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  98. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  99. package/dist/mcp/builtin/globals/updateTool.js +28 -37
  100. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  101. package/dist/mcp/builtinTools.d.ts +6 -0
  102. package/dist/mcp/builtinTools.d.ts.map +1 -1
  103. package/dist/mcp/builtinTools.js +9 -3
  104. package/dist/mcp/builtinTools.js.map +1 -1
  105. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  106. package/dist/mcp/sanitizeMCPConfig.js +6 -1
  107. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  108. package/dist/stdio.d.ts +3 -4
  109. package/dist/stdio.d.ts.map +1 -1
  110. package/dist/stdio.js +65 -45
  111. package/dist/stdio.js.map +1 -1
  112. package/dist/types.d.ts +94 -16
  113. package/dist/types.d.ts.map +1 -1
  114. package/dist/types.js +2 -4
  115. package/dist/types.js.map +1 -1
  116. package/dist/utils/camelCase.d.ts.map +1 -1
  117. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  118. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  119. package/package.json +9 -13
  120. package/src/endpoint/access.ts +14 -14
  121. package/src/endpoint/index.ts +79 -14
  122. package/src/endpoint/oauth.ts +72 -0
  123. package/src/index.ts +11 -4
  124. package/src/mcp/buildMcpServer.ts +80 -50
  125. package/src/mcp/builtin/collections/authTools.ts +80 -69
  126. package/src/mcp/builtin/collections/countTool.ts +10 -23
  127. package/src/mcp/builtin/collections/countVersionsTool.ts +10 -20
  128. package/src/mcp/builtin/collections/createTool.ts +110 -77
  129. package/src/mcp/builtin/collections/deleteTool.ts +36 -65
  130. package/src/mcp/builtin/collections/duplicateTool.ts +36 -87
  131. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  132. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  133. package/src/mcp/builtin/collections/findDistinctTool.ts +12 -65
  134. package/src/mcp/builtin/collections/findTool.ts +25 -108
  135. package/src/mcp/builtin/collections/findVersionByIDTool.ts +16 -60
  136. package/src/mcp/builtin/collections/findVersionsTool.ts +15 -87
  137. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +60 -15
  138. package/src/mcp/builtin/collections/restoreVersionTool.ts +15 -58
  139. package/src/mcp/builtin/collections/updateTool.ts +63 -101
  140. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  141. package/src/mcp/builtin/formatEntityError.ts +77 -0
  142. package/src/mcp/builtin/getConfigInfoTool.ts +4 -5
  143. package/src/mcp/builtin/globals/countVersionsTool.ts +10 -19
  144. package/src/mcp/builtin/globals/findTool.ts +14 -53
  145. package/src/mcp/builtin/globals/findVersionByIDTool.ts +14 -54
  146. package/src/mcp/builtin/globals/findVersionsTool.ts +15 -94
  147. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +41 -9
  148. package/src/mcp/builtin/globals/restoreVersionTool.ts +15 -47
  149. package/src/mcp/builtin/globals/updateTool.ts +39 -62
  150. package/src/mcp/builtinTools.ts +9 -2
  151. package/src/mcp/sanitizeMCPConfig.ts +6 -1
  152. package/src/stdio.ts +63 -45
  153. package/src/types.ts +95 -16
  154. package/dist/@types/assets.d.js +0 -2
  155. package/dist/@types/assets.d.js.map +0 -1
  156. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +0 -9
  157. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +0 -1
  158. package/dist/mcp/builtin/collections/formatCollectionError.js +0 -60
  159. package/dist/mcp/builtin/collections/formatCollectionError.js.map +0 -1
  160. package/dist/mcp/builtin/validateEntityData.d.ts +0 -14
  161. package/dist/mcp/builtin/validateEntityData.d.ts.map +0 -1
  162. package/dist/mcp/builtin/validateEntityData.js +0 -82
  163. package/dist/mcp/builtin/validateEntityData.js.map +0 -1
  164. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  165. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  166. package/dist/utils/getVirtualFieldNames.js +0 -35
  167. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  168. package/dist/utils/localAPIDefaults.d.ts +0 -20
  169. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  170. package/dist/utils/localAPIDefaults.js +0 -19
  171. package/dist/utils/localAPIDefaults.js.map +0 -1
  172. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -11
  173. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  174. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -34
  175. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  176. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  177. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  178. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  179. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  180. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -15
  181. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  182. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -464
  183. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  184. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -158
  185. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  186. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  187. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  188. package/dist/utils/transformPointDataToPayload.js +0 -28
  189. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  190. package/dist/utils/whereSchema.d.ts +0 -9
  191. package/dist/utils/whereSchema.d.ts.map +0 -1
  192. package/dist/utils/whereSchema.js +0 -13
  193. package/dist/utils/whereSchema.js.map +0 -1
  194. package/src/@types/assets.d.ts +0 -3
  195. package/src/mcp/builtin/collections/formatCollectionError.ts +0 -84
  196. package/src/mcp/builtin/validateEntityData.ts +0 -132
  197. package/src/utils/getVirtualFieldNames.ts +0 -53
  198. package/src/utils/localAPIDefaults.ts +0 -22
  199. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -78
  200. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
  201. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -103
  202. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -529
  203. package/src/utils/transformPointDataToPayload.ts +0 -40
  204. package/src/utils/whereSchema.ts +0 -24
@@ -1,10 +1,11 @@
1
+ import { getAccessResults, getCollectionInputSchema, getCollectionSchemaInputSchema } from 'payload';
2
+ import { getLLMInstructions } from 'payload/internal';
1
3
  import { defaultAccess } from '../../../defaultAccess.js';
2
4
  import { defineCollectionTool } from '../../../defineTool.js';
3
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js';
4
5
  export const getCollectionSchemaTool = defineCollectionTool({
5
6
  access: (args)=>{
6
- const permissions = args.permissions?.collections?.[args.collectionSlug];
7
- return defaultAccess(args) && Boolean(permissions?.create || permissions?.delete || permissions?.read || permissions?.update);
7
+ const permissions = args.permissions?.collections?.[args.slug];
8
+ return defaultAccess(args) && Boolean(permissions?.create || permissions?.update);
8
9
  },
9
10
  annotations: {
10
11
  destructiveHint: false,
@@ -13,33 +14,88 @@ export const getCollectionSchemaTool = defineCollectionTool({
13
14
  readOnlyHint: true,
14
15
  title: 'Get Collection Schema'
15
16
  },
16
- description: 'Get the input schema for creating or updating documents in a collection.'
17
- }).handler(({ collectionSlug, req })=>{
18
- const inputSchema = getCollectionInputSchema({
19
- collectionSlug,
17
+ description: 'Get the input schema and LLM instructions before creating or updating documents in a collection.',
18
+ input: getCollectionSchemaInputSchema
19
+ }).handler(async ({ slug, authorizedMCP, req })=>{
20
+ const permissions = authorizedMCP.overrideAccess ? null : (await getAccessResults({
20
21
  req
22
+ })).collections?.[slug];
23
+ if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {
24
+ return {
25
+ content: [
26
+ {
27
+ type: 'text',
28
+ text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${slug}"`
29
+ }
30
+ ],
31
+ isError: true
32
+ };
33
+ }
34
+ const inputSchema = getCollectionInputSchema({
35
+ collectionSlug: slug,
36
+ req,
37
+ ...permissions ? {
38
+ permissions
39
+ } : {}
21
40
  });
22
41
  if (!inputSchema) {
23
42
  return {
24
43
  content: [
25
44
  {
26
45
  type: 'text',
27
- text: `Error: Collection "${collectionSlug}" not found`
46
+ text: `Error: Collection "${slug}" not found`
28
47
  }
29
48
  ],
30
49
  isError: true
31
50
  };
32
51
  }
52
+ const uploadConfig = req.payload.collections[slug]?.config.upload;
53
+ const maxFileSize = req.payload.config.upload.limits?.fileSize;
54
+ const upload = uploadConfig ? {
55
+ enabled: true,
56
+ filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,
57
+ mimeTypes: uploadConfig.mimeTypes ?? [
58
+ '*/*'
59
+ ],
60
+ sources: [
61
+ ...uploadConfig.pasteURL !== false ? [
62
+ 'externalURL'
63
+ ] : [],
64
+ 'base64',
65
+ 'uploadReference'
66
+ ],
67
+ ...typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? {
68
+ maxFileSize
69
+ } : {}
70
+ } : {
71
+ enabled: false
72
+ };
73
+ const instructions = await getLLMInstructions({
74
+ slug,
75
+ type: 'collection',
76
+ overrideAccess: authorizedMCP.overrideAccess,
77
+ req
78
+ });
33
79
  return {
34
80
  content: [
35
81
  {
36
82
  type: 'text',
37
- text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``
38
- }
83
+ text: `Schema for collection "${slug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``
84
+ },
85
+ ...instructions ? [
86
+ {
87
+ type: 'text',
88
+ text: instructions
89
+ }
90
+ ] : []
39
91
  ],
40
92
  structuredContent: {
41
- collectionSlug,
42
- schema: inputSchema
93
+ slug,
94
+ schema: inputSchema,
95
+ upload,
96
+ ...instructions ? {
97
+ instructions
98
+ } : {}
43
99
  }
44
100
  };
45
101
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n access: (args) => {\n const permissions = args.permissions?.collections?.[args.collectionSlug]\n\n return (\n defaultAccess(args) &&\n Boolean(\n permissions?.create || permissions?.delete || permissions?.read || permissions?.update,\n )\n )\n },\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Get Collection Schema',\n },\n description: 'Get the input schema for creating or updating documents in a collection.',\n}).handler(({ collectionSlug, req }) => {\n const inputSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${collectionSlug}\" not found` }],\n isError: true,\n }\n }\n\n return {\n content: [\n {\n type: 'text',\n text: `Schema for collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(inputSchema)}\\n\\`\\`\\``,\n },\n ],\n structuredContent: {\n collectionSlug,\n schema: inputSchema,\n },\n }\n})\n"],"names":["defaultAccess","defineCollectionTool","getCollectionInputSchema","getCollectionSchemaTool","access","args","permissions","collections","collectionSlug","Boolean","create","delete","read","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","handler","req","inputSchema","content","type","text","isError","JSON","stringify","structuredContent","schema"],"mappings":"AAAA,SAASA,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,wBAAwB,QAAQ,0DAAyD;AAElG,OAAO,MAAMC,0BAA0BF,qBAAqB;IAC1DG,QAAQ,CAACC;QACP,MAAMC,cAAcD,KAAKC,WAAW,EAAEC,aAAa,CAACF,KAAKG,cAAc,CAAC;QAExE,OACER,cAAcK,SACdI,QACEH,aAAaI,UAAUJ,aAAaK,UAAUL,aAAaM,QAAQN,aAAaO;IAGtF;IACAC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAa;AACf,GAAGC,OAAO,CAAC,CAAC,EAAEb,cAAc,EAAEc,GAAG,EAAE;IACjC,MAAMC,cAAcrB,yBAAyB;QAAEM;QAAgBc;IAAI;IAEnE,IAAI,CAACC,aAAa;QAChB,OAAO;YACLC,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,mBAAmB,EAAElB,eAAe,WAAW,CAAC;gBAAC;aAAE;YACpFmB,SAAS;QACX;IACF;IAEA,OAAO;QACLH,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,uBAAuB,EAAElB,eAAe,gBAAgB,EAAEoB,KAAKC,SAAS,CAACN,aAAa,QAAQ,CAAC;YACxG;SACD;QACDO,mBAAmB;YACjBtB;YACAuB,QAAQR;QACV;IACF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { getAccessResults, getCollectionInputSchema, getCollectionSchemaInputSchema } from 'payload'\nimport { getLLMInstructions } from 'payload/internal'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n access: (args) => {\n const permissions = args.permissions?.collections?.[args.slug]\n\n return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)\n },\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Get Collection Schema',\n },\n description:\n 'Get the input schema and LLM instructions before creating or updating documents in a collection.',\n input: getCollectionSchemaInputSchema,\n}).handler(async ({ slug, authorizedMCP, req }) => {\n const permissions = authorizedMCP.overrideAccess\n ? null\n : (await getAccessResults({ req })).collections?.[slug]\n\n if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {\n return {\n content: [\n {\n type: 'text',\n text: `Error: MCP access to \"getCollectionSchema\" is not enabled for collection \"${slug}\"`,\n },\n ],\n isError: true,\n }\n }\n\n const inputSchema = getCollectionInputSchema({\n collectionSlug: slug,\n req,\n ...(permissions ? { permissions } : {}),\n })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${slug}\" not found` }],\n isError: true,\n }\n }\n\n const uploadConfig = req.payload.collections[slug]?.config.upload\n const maxFileSize = req.payload.config.upload.limits?.fileSize\n const upload = uploadConfig\n ? {\n enabled: true,\n filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,\n mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],\n sources: [\n ...(uploadConfig.pasteURL !== false ? ['externalURL'] : []),\n 'base64',\n 'uploadReference',\n ],\n ...(typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? { maxFileSize } : {}),\n }\n : { enabled: false }\n\n const instructions = await getLLMInstructions({\n slug,\n type: 'collection',\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Schema for collection \"${slug}\":\\n\\`\\`\\`json\\n${JSON.stringify(inputSchema)}\\n\\`\\`\\`\\nUpload configuration:\\n\\`\\`\\`json\\n${JSON.stringify(upload)}\\n\\`\\`\\``,\n },\n ...(instructions ? [{ type: 'text' as const, text: instructions }] : []),\n ],\n structuredContent: {\n slug,\n schema: inputSchema,\n upload,\n ...(instructions ? { instructions } : {}),\n },\n }\n})\n"],"names":["getAccessResults","getCollectionInputSchema","getCollectionSchemaInputSchema","getLLMInstructions","defaultAccess","defineCollectionTool","getCollectionSchemaTool","access","args","permissions","collections","slug","Boolean","create","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","handler","authorizedMCP","req","overrideAccess","content","type","text","isError","inputSchema","collectionSlug","uploadConfig","payload","config","upload","maxFileSize","limits","fileSize","enabled","filesRequiredOnCreate","mimeTypes","sources","pasteURL","Number","isFinite","instructions","JSON","stringify","structuredContent","schema"],"mappings":"AAAA,SAASA,gBAAgB,EAAEC,wBAAwB,EAAEC,8BAA8B,QAAQ,UAAS;AACpG,SAASC,kBAAkB,QAAQ,mBAAkB;AAErD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAE7D,OAAO,MAAMC,0BAA0BD,qBAAqB;IAC1DE,QAAQ,CAACC;QACP,MAAMC,cAAcD,KAAKC,WAAW,EAAEC,aAAa,CAACF,KAAKG,IAAI,CAAC;QAE9D,OAAOP,cAAcI,SAASI,QAAQH,aAAaI,UAAUJ,aAAaK;IAC5E;IACAC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aACE;IACFC,OAAOpB;AACT,GAAGqB,OAAO,CAAC,OAAO,EAAEZ,IAAI,EAAEa,aAAa,EAAEC,GAAG,EAAE;IAC5C,MAAMhB,cAAce,cAAcE,cAAc,GAC5C,OACA,AAAC,CAAA,MAAM1B,iBAAiB;QAAEyB;IAAI,EAAC,EAAGf,WAAW,EAAE,CAACC,KAAK;IAEzD,IAAI,CAACa,cAAcE,cAAc,IAAI,CAACjB,aAAaI,UAAU,CAACJ,aAAaK,QAAQ;QACjF,OAAO;YACLa,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,0EAA0E,EAAElB,KAAK,CAAC,CAAC;gBAC5F;aACD;YACDmB,SAAS;QACX;IACF;IAEA,MAAMC,cAAc9B,yBAAyB;QAC3C+B,gBAAgBrB;QAChBc;QACA,GAAIhB,cAAc;YAAEA;QAAY,IAAI,CAAC,CAAC;IACxC;IAEA,IAAI,CAACsB,aAAa;QAChB,OAAO;YACLJ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,mBAAmB,EAAElB,KAAK,WAAW,CAAC;gBAAC;aAAE;YAC1EmB,SAAS;QACX;IACF;IAEA,MAAMG,eAAeR,IAAIS,OAAO,CAACxB,WAAW,CAACC,KAAK,EAAEwB,OAAOC;IAC3D,MAAMC,cAAcZ,IAAIS,OAAO,CAACC,MAAM,CAACC,MAAM,CAACE,MAAM,EAAEC;IACtD,MAAMH,SAASH,eACX;QACEO,SAAS;QACTC,uBAAuBR,aAAaQ,qBAAqB,KAAK;QAC9DC,WAAWT,aAAaS,SAAS,IAAI;YAAC;SAAM;QAC5CC,SAAS;eACHV,aAAaW,QAAQ,KAAK,QAAQ;gBAAC;aAAc,GAAG,EAAE;YAC1D;YACA;SACD;QACD,GAAI,OAAOP,gBAAgB,YAAYQ,OAAOC,QAAQ,CAACT,eAAe;YAAEA;QAAY,IAAI,CAAC,CAAC;IAC5F,IACA;QAAEG,SAAS;IAAM;IAErB,MAAMO,eAAe,MAAM5C,mBAAmB;QAC5CQ;QACAiB,MAAM;QACNF,gBAAgBF,cAAcE,cAAc;QAC5CD;IACF;IAEA,OAAO;QACLE,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,uBAAuB,EAAElB,KAAK,gBAAgB,EAAEqC,KAAKC,SAAS,CAAClB,aAAa,6CAA6C,EAAEiB,KAAKC,SAAS,CAACb,QAAQ,QAAQ,CAAC;YACpK;eACIW,eAAe;gBAAC;oBAAEnB,MAAM;oBAAiBC,MAAMkB;gBAAa;aAAE,GAAG,EAAE;SACxE;QACDG,mBAAmB;YACjBvC;YACAwC,QAAQpB;YACRK;YACA,GAAIW,eAAe;gBAAEA;YAAa,IAAI,CAAC,CAAC;QAC1C;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"restoreVersionTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/restoreVersionTool.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,kBAAkB,4CA+F7B,CAAA"}
1
+ {"version":3,"file":"restoreVersionTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/restoreVersionTool.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,kBAAkB,4CAuD7B,CAAA"}
@@ -1,11 +1,10 @@
1
- import { z } from 'zod';
1
+ import { restoreVersionInputSchema } from 'payload';
2
2
  import { defaultAccess } from '../../../defaultAccess.js';
3
3
  import { defineCollectionTool } from '../../../defineTool.js';
4
4
  import { getLogger } from '../../../utils/getLogger.js';
5
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
6
5
  const DEFAULT_DESCRIPTION = 'Restore a document from a previous version in any version-enabled collection.';
7
6
  export const restoreVersionTool = defineCollectionTool({
8
- access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
7
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
9
8
  annotations: {
10
9
  destructiveHint: true,
11
10
  idempotentHint: false,
@@ -14,64 +13,52 @@ export const restoreVersionTool = defineCollectionTool({
14
13
  title: 'Restore Version'
15
14
  },
16
15
  description: DEFAULT_DESCRIPTION,
17
- input: z.object({
18
- id: z.string().describe('The ID of the version to restore'),
19
- depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in response').optional().default(0),
20
- draft: z.boolean().describe('Whether to restore the version as a draft').optional().default(false),
21
- fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
22
- locale: z.string().describe('Optional: locale code to restore in (e.g., "en", "es")').optional(),
23
- populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
24
- 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(),
25
- showHiddenFields: z.boolean().describe('Optional: include hidden fields in the restored document response').optional()
26
- })
27
- }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
16
+ input: restoreVersionInputSchema
17
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
28
18
  const payload = req.payload;
29
19
  const logger = getLogger({
30
20
  payload
31
21
  });
32
- const { id, depth, draft, fallbackLocale, locale, populate, select, showHiddenFields } = input;
33
- logger.info(`Restoring version in collection: ${collectionSlug} with ID: ${id}`);
22
+ const { id, depth, draft, fallbackLocale, locale, populate, select } = input;
23
+ logger.info(`Restoring version in collection: ${slug} with ID: ${id}`);
34
24
  try {
35
25
  const result = await payload.restoreVersion({
36
- id,
37
- collection: collectionSlug,
26
+ id: String(id),
27
+ collection: slug,
38
28
  depth,
39
29
  draft,
30
+ overrideAccess: authorizedMCP.overrideAccess,
40
31
  req,
41
- ...localAPIDefaults(authorizedMCP),
42
- ...fallbackLocale ? {
32
+ ...fallbackLocale !== undefined ? {
43
33
  fallbackLocale
44
34
  } : {},
45
35
  ...locale ? {
46
36
  locale
47
37
  } : {},
48
38
  ...populate ? {
49
- populate: populate
39
+ populate
50
40
  } : {},
51
41
  ...select ? {
52
- select: select
53
- } : {},
54
- ...showHiddenFields !== undefined ? {
55
- showHiddenFields
42
+ select
56
43
  } : {}
57
44
  });
58
45
  return {
59
46
  content: [
60
47
  {
61
48
  type: 'text',
62
- text: `Version "${id}" restored successfully in collection "${collectionSlug}"!\nRestored document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
49
+ text: `Version "${id}" restored successfully in collection "${slug}"!\nRestored document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
63
50
  }
64
51
  ],
65
52
  doc: result
66
53
  };
67
54
  } catch (error) {
68
55
  const errorMessage = error instanceof Error ? error.message : 'Unknown error';
69
- logger.error(`Error restoring version ${id} in ${collectionSlug}: ${errorMessage}`);
56
+ logger.error(`Error restoring version ${id} in ${slug}: ${errorMessage}`);
70
57
  return {
71
58
  content: [
72
59
  {
73
60
  type: 'text',
74
- text: `❌ **Error restoring version "${id}" in collection "${collectionSlug}":** ${errorMessage}`
61
+ text: `❌ **Error restoring version "${id}" in collection "${slug}":** ${errorMessage}`
75
62
  }
76
63
  ],
77
64
  isError: true
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/restoreVersionTool.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 'Restore a document from a previous version in any version-enabled collection.'\n\nexport const restoreVersionTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Restore Version',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z.string().describe('The ID of the version to restore'),\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 restore the version 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('Optional: locale code to restore in (e.g., \"en\", \"es\")')\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 showHiddenFields: z\n .boolean()\n .describe('Optional: include hidden fields in the restored document response')\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n const { id, depth, draft, fallbackLocale, locale, populate, select, showHiddenFields } = input\n\n logger.info(`Restoring version in collection: ${collectionSlug} with ID: ${id}`)\n\n try {\n const result = await payload.restoreVersion({\n id,\n collection: collectionSlug,\n depth,\n draft,\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 })\n\n return {\n content: [\n {\n type: 'text',\n text: `Version \"${id}\" restored successfully in collection \"${collectionSlug}\"!\\nRestored 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 restoring version ${id} in ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `❌ **Error restoring version \"${id}\" in collection \"${collectionSlug}\":** ${errorMessage}`,\n },\n ],\n isError: true,\n }\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","restoreVersionTool","access","args","Boolean","permissions","collections","collectionSlug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","string","describe","depth","number","int","min","max","optional","default","draft","boolean","fallbackLocale","locale","populate","record","unknown","select","showHiddenFields","handler","authorizedMCP","req","payload","logger","info","result","restoreVersion","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,qBAAqBJ,qBAAqB;IACrDK,QAAQ,CAACC,OACPP,cAAcO,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,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,8DACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAOjC,EACJkC,OAAO,GACPT,QAAQ,CAAC,6CACTM,QAAQ,GACRC,OAAO,CAAC;QACXG,gBAAgBnC,EACbwB,MAAM,GACNC,QAAQ,CAAC,gFACTM,QAAQ;QACXK,QAAQpC,EACLwB,MAAM,GACNC,QAAQ,CAAC,0DACTM,QAAQ;QACXM,UAAUrC,EACPsC,MAAM,CAACtC,EAAEwB,MAAM,IAAIxB,EAAEuC,OAAO,IAC5Bd,QAAQ,CACP,8FAEDM,QAAQ;QACXS,QAAQxC,EACLsC,MAAM,CAACtC,EAAEwB,MAAM,IAAIxB,EAAEuC,OAAO,IAC5Bd,QAAQ,CACP,sGAEDM,QAAQ;QACXU,kBAAkBzC,EACfkC,OAAO,GACPT,QAAQ,CAAC,qEACTM,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,KAAK,EAAEE,cAAc,EAAEC,MAAM,EAAEC,QAAQ,EAAEG,MAAM,EAAEC,gBAAgB,EAAE,GAAGpB;IAEzFyB,OAAOC,IAAI,CAAC,CAAC,iCAAiC,EAAEnC,eAAe,UAAU,EAAEW,IAAI;IAE/E,IAAI;QACF,MAAMyB,SAAS,MAAMH,QAAQI,cAAc,CAAC;YAC1C1B;YACA2B,YAAYtC;YACZc;YACAO;YACAW;YACA,GAAGxC,iBAAiBuC,cAAc;YAClC,GAAIR,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,qBAAqBU,YAAY;gBAAEV;YAAiB,IAAI,CAAC,CAAC;QAChE;QAEA,OAAO;YACLW,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,SAAS,EAAE/B,GAAG,uCAAuC,EAAEX,eAAe,oCAAoC,EAAE2C,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBACrJ;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,wBAAwB,EAAEnC,GAAG,IAAI,EAAEX,eAAe,EAAE,EAAE+C,cAAc;QAClF,OAAO;YACLP,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6BAA6B,EAAE/B,GAAG,iBAAiB,EAAEX,eAAe,KAAK,EAAE+C,cAAc;gBAClG;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/restoreVersionTool.ts"],"sourcesContent":["import { restoreVersionInputSchema } from 'payload'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Restore a document from a previous version in any version-enabled collection.'\n\nexport const restoreVersionTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Restore Version',\n },\n description: DEFAULT_DESCRIPTION,\n input: restoreVersionInputSchema,\n}).handler(async ({ slug, authorizedMCP, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n const { id, depth, draft, fallbackLocale, locale, populate, select } = input\n\n logger.info(`Restoring version in collection: ${slug} with ID: ${id}`)\n\n try {\n const result = await payload.restoreVersion({\n id: String(id),\n collection: slug,\n depth,\n draft,\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),\n ...(locale ? { locale } : {}),\n ...(populate ? { populate } : {}),\n ...(select ? { select } : {}),\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Version \"${id}\" restored successfully in collection \"${slug}\"!\\nRestored 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 restoring version ${id} in ${slug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `❌ **Error restoring version \"${id}\" in collection \"${slug}\":** ${errorMessage}`,\n },\n ],\n isError: true,\n }\n }\n})\n"],"names":["restoreVersionInputSchema","defaultAccess","defineCollectionTool","getLogger","DEFAULT_DESCRIPTION","restoreVersionTool","access","args","Boolean","permissions","collections","slug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","handler","authorizedMCP","req","payload","logger","id","depth","draft","fallbackLocale","locale","populate","select","info","result","restoreVersion","String","collection","overrideAccess","undefined","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","isError"],"mappings":"AAAA,SAASA,yBAAyB,QAAQ,UAAS;AAEnD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AAEvD,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBH,qBAAqB;IACrDI,QAAQ,CAACC,OACPN,cAAcM,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,IAAI,CAAC,EAAEC;IAC7EC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOpB;AACT,GAAGqB,OAAO,CAAC,OAAO,EAAEV,IAAI,EAAEW,aAAa,EAAEF,KAAK,EAAEG,GAAG,EAAE;IACnD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAStB,UAAU;QAAEqB;IAAQ;IACnC,MAAM,EAAEE,EAAE,EAAEC,KAAK,EAAEC,KAAK,EAAEC,cAAc,EAAEC,MAAM,EAAEC,QAAQ,EAAEC,MAAM,EAAE,GAAGZ;IAEvEK,OAAOQ,IAAI,CAAC,CAAC,iCAAiC,EAAEtB,KAAK,UAAU,EAAEe,IAAI;IAErE,IAAI;QACF,MAAMQ,SAAS,MAAMV,QAAQW,cAAc,CAAC;YAC1CT,IAAIU,OAAOV;YACXW,YAAY1B;YACZgB;YACAC;YACAU,gBAAgBhB,cAAcgB,cAAc;YAC5Cf;YACA,GAAIM,mBAAmBU,YAAY;gBAAEV;YAAe,IAAI,CAAC,CAAC;YAC1D,GAAIC,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIC,WAAW;gBAAEA;YAAS,IAAI,CAAC,CAAC;YAChC,GAAIC,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;QAC9B;QAEA,OAAO;YACLQ,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,SAAS,EAAEhB,GAAG,uCAAuC,EAAEf,KAAK,oCAAoC,EAAEgC,KAAKC,SAAS,CAACV,QAAQ,QAAQ,CAAC;gBAC3I;aACD;YACDW,KAAKX;QACP;IACF,EAAE,OAAOY,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DxB,OAAOqB,KAAK,CAAC,CAAC,wBAAwB,EAAEpB,GAAG,IAAI,EAAEf,KAAK,EAAE,EAAEoC,cAAc;QACxE,OAAO;YACLP,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6BAA6B,EAAEhB,GAAG,iBAAiB,EAAEf,KAAK,KAAK,EAAEoC,cAAc;gBACxF;aACD;YACDG,SAAS;QACX;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,kBAAkB,4CA6L7B,CAAA"}
1
+ {"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,kBAAkB,4CAuJ7B,CAAA"}
@@ -1,17 +1,12 @@
1
- import { z } from 'zod';
1
+ import { getCollectionInputSchema, getCollectionVirtualFieldNames, parseDocumentID, stripVirtualFields, transformPointDataToPayload, updateDocumentInputSchema, validateCollectionData } from 'payload';
2
2
  import { defaultAccess } from '../../../defaultAccess.js';
3
3
  import { defineCollectionTool } from '../../../defineTool.js';
4
4
  import { getLogger } from '../../../utils/getLogger.js';
5
- import { getCollectionVirtualFieldNames, stripVirtualFields } from '../../../utils/getVirtualFieldNames.js';
6
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
7
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js';
8
- import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
9
- import { whereSchema } from '../../../utils/whereSchema.js';
10
- import { validateCollectionData } from '../validateEntityData.js';
11
- import { formatCollectionError } from './formatCollectionError.js';
12
- const DEFAULT_DESCRIPTION = 'Update documents in any collection by passing the collection slug and data.';
5
+ import { formatEntityError } from '../formatEntityError.js';
6
+ import { fileInputSchema, resolveFile } from './fileInput.js';
7
+ const DEFAULT_DESCRIPTION = 'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.';
13
8
  export const updateDocumentTool = defineCollectionTool({
14
- access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
9
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
15
10
  annotations: {
16
11
  destructiveHint: true,
17
12
  idempotentHint: false,
@@ -20,124 +15,108 @@ export const updateDocumentTool = defineCollectionTool({
20
15
  title: 'Update Document'
21
16
  },
22
17
  description: DEFAULT_DESCRIPTION,
23
- input: z.object({
24
- id: z.union([
25
- z.string(),
26
- z.number()
27
- ]).describe('The ID of the document to update').optional(),
28
- data: z.record(z.string(), z.unknown()).describe('The fields to update'),
29
- depth: z.number().describe('How many levels deep to populate relationships').optional().default(0),
30
- draft: z.boolean().describe('Whether to update the document as a draft').optional().default(false),
31
- fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
32
- filePath: z.string().describe('File path for file uploads').optional(),
33
- locale: z.string().describe('Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
34
- overrideLock: z.boolean().describe('Whether to override document locks').optional().default(true),
35
- overwriteExistingFiles: z.boolean().describe('Whether to overwrite existing files').optional().default(false),
36
- 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(),
37
- where: whereSchema.describe('Where clause to update multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}').optional()
18
+ input: updateDocumentInputSchema({
19
+ file: fileInputSchema
38
20
  })
39
- }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
21
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
40
22
  const payload = req.payload;
41
23
  const logger = getLogger({
42
24
  payload
43
25
  });
44
- const { id, data, depth, draft, fallbackLocale, filePath, locale, overrideLock, overwriteExistingFiles, select, where } = input;
45
- logger.info(`Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`);
26
+ const { id, data, depth, draft, fallbackLocale, file: fileInput, limit, locale, overrideLock, populate, publishAllLocales, returning, select, sort, trash, unpublishAllLocales, where } = input;
27
+ logger.info(`Updating document in collection: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`);
46
28
  try {
47
- if (!id && !where) {
48
- return {
49
- content: [
50
- {
51
- type: 'text',
52
- text: 'Error: Either id or where clause must be provided'
53
- }
54
- ]
55
- };
56
- }
57
- const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
29
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug);
58
30
  const inputData = stripVirtualFields(data, virtualFieldNames);
59
- const validationError = validateCollectionData({
60
- collectionSlug,
31
+ validateCollectionData({
32
+ slug,
61
33
  data: inputData,
62
34
  partial: true,
63
35
  req
64
36
  });
65
- if (validationError) {
66
- return validationError;
67
- }
68
37
  const parsedData = transformPointDataToPayload(inputData);
38
+ const file = await resolveFile({
39
+ slug,
40
+ input: fileInput,
41
+ req
42
+ });
69
43
  const whereClause = where ?? {};
70
- if (id) {
44
+ if (id !== undefined) {
71
45
  const result = await payload.update({
72
- id,
73
- collection: collectionSlug,
46
+ id: parseDocumentID({
47
+ id,
48
+ collectionSlug: slug,
49
+ payload
50
+ }),
51
+ collection: slug,
74
52
  data: parsedData,
75
53
  depth,
76
54
  draft,
55
+ fallbackLocale,
56
+ locale,
57
+ overrideAccess: authorizedMCP.overrideAccess,
77
58
  overrideLock,
59
+ populate,
60
+ publishAllLocales,
78
61
  req,
79
- ...localAPIDefaults(authorizedMCP),
80
- ...filePath ? {
81
- filePath
82
- } : {},
83
- ...overwriteExistingFiles ? {
84
- overwriteExistingFiles
85
- } : {},
86
- ...locale ? {
87
- locale
88
- } : {},
89
- ...fallbackLocale ? {
90
- fallbackLocale
91
- } : {},
92
- ...select ? {
93
- select: select
62
+ select: returning ? select : {
63
+ id: true
64
+ },
65
+ trash,
66
+ unpublishAllLocales,
67
+ ...file ? {
68
+ file
94
69
  } : {}
95
70
  });
71
+ const responseResult = returning ? result : {
72
+ id: result.id
73
+ };
96
74
  return {
97
75
  content: [
98
76
  {
99
77
  type: 'text',
100
- text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
78
+ text: `Document updated successfully in collection "${slug}"!\nResult:\n\`\`\`json\n${JSON.stringify(responseResult)}\n\`\`\``
101
79
  }
102
80
  ],
103
- doc: result
81
+ doc: responseResult
104
82
  };
105
83
  }
106
84
  const result = await payload.update({
107
- collection: collectionSlug,
85
+ collection: slug,
108
86
  data: parsedData,
109
87
  depth,
110
88
  draft,
89
+ fallbackLocale,
90
+ limit,
91
+ locale,
92
+ overrideAccess: authorizedMCP.overrideAccess,
111
93
  overrideLock,
94
+ populate,
95
+ publishAllLocales,
112
96
  req,
97
+ select: returning ? select : {
98
+ id: true
99
+ },
100
+ sort,
101
+ trash,
102
+ unpublishAllLocales,
113
103
  where: whereClause,
114
- ...localAPIDefaults(authorizedMCP),
115
- ...filePath ? {
116
- filePath
117
- } : {},
118
- ...overwriteExistingFiles ? {
119
- overwriteExistingFiles
120
- } : {},
121
- ...locale ? {
122
- locale
123
- } : {},
124
- ...fallbackLocale ? {
125
- fallbackLocale
126
- } : {},
127
- ...select ? {
128
- select: select
104
+ ...file ? {
105
+ file
129
106
  } : {}
130
107
  });
131
- const docs = result.docs || [];
108
+ const docs = returning ? result.docs : result.docs.map(({ id })=>({
109
+ id
110
+ }));
132
111
  const errors = result.errors || [];
133
- let responseText = `Multiple documents updated in collection "${collectionSlug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`;
112
+ let responseText = `Multiple documents updated in collection "${slug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`;
134
113
  if (docs.length > 0) {
135
114
  responseText += `\n\nUpdated documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``;
136
115
  }
137
116
  if (errors.length > 0) {
138
117
  responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``;
139
118
  const errorSchema = getCollectionInputSchema({
140
- collectionSlug,
119
+ collectionSlug: slug,
141
120
  req
142
121
  });
143
122
  if (errorSchema) {
@@ -157,7 +136,7 @@ export const updateDocumentTool = defineCollectionTool({
157
136
  isError: true,
158
137
  ...errorSchema ? {
159
138
  structuredContent: {
160
- collectionSlug,
139
+ slug,
161
140
  docs,
162
141
  errors,
163
142
  schema: errorSchema
@@ -179,10 +158,11 @@ export const updateDocumentTool = defineCollectionTool({
179
158
  };
180
159
  } catch (error) {
181
160
  const errorMessage = error instanceof Error ? error.message : 'Unknown error';
182
- logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`);
183
- return formatCollectionError({
161
+ logger.error(`Error updating document in ${slug}: ${errorMessage}`);
162
+ return formatEntityError({
163
+ slug,
184
164
  action: 'updating',
185
- collectionSlug,
165
+ entity: 'collection',
186
166
  error,
187
167
  req
188
168
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { SelectType, Where } 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 { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Update documents in any collection by passing the collection slug and data.'\n\nexport const updateDocumentTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Update 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 update').optional(),\n data: z.record(z.string(), z.unknown()).describe('The fields to update'),\n depth: z\n .number()\n .describe('How many levels deep to populate relationships')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to update the document as a draft')\n .optional()\n .default(false),\n fallbackLocale: z\n .string()\n .describe('Optional: fallback locale code to use when requested locale is not available')\n .optional(),\n filePath: z.string().describe('File path for file uploads').optional(),\n locale: z\n .string()\n .describe(\n 'Optional: locale code to update the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n overrideLock: z\n .boolean()\n .describe('Whether to override document locks')\n .optional()\n .default(true),\n overwriteExistingFiles: z\n .boolean()\n .describe('Whether to overwrite existing files')\n .optional()\n .default(false),\n select: z\n .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 where: whereSchema\n .describe(\n 'Where clause to update 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 {\n id,\n data,\n depth,\n draft,\n fallbackLocale,\n filePath,\n locale,\n overrideLock,\n overwriteExistingFiles,\n select,\n where,\n } = input\n\n logger.info(\n `Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n if (!id && !where) {\n return {\n content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n }\n }\n\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({\n collectionSlug,\n data: inputData,\n partial: true,\n req,\n })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n\n const whereClause: Where = where ?? {}\n\n if (id) {\n const result = await payload.update({\n id,\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Document updated successfully in collection \"${collectionSlug}\"!\\nUpdated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n }\n\n const result = await payload.update({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n where: whereClause,\n ...localAPIDefaults(authorizedMCP),\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n const docs = result.docs || []\n const errors = result.errors || []\n\n let responseText = `Multiple documents updated in collection \"${collectionSlug}\"!\\nUpdated: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n if (docs.length > 0) {\n responseText += `\\n\\nUpdated documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n }\n if (errors.length > 0) {\n responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n\n const errorSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (errorSchema) {\n responseText += `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(errorSchema)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n isError: true,\n ...(errorSchema\n ? {\n structuredContent: {\n collectionSlug,\n docs,\n errors,\n schema: errorSchema,\n },\n }\n : {}),\n }\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`)\n return formatCollectionError({ action: 'updating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","getCollectionInputSchema","transformPointDataToPayload","whereSchema","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","updateDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","data","record","unknown","depth","default","draft","boolean","fallbackLocale","filePath","locale","overrideLock","overwriteExistingFiles","select","where","handler","authorizedMCP","req","payload","logger","info","content","type","text","virtualFieldNames","config","inputData","validationError","partial","parsedData","whereClause","result","collection","JSON","stringify","doc","docs","errors","responseText","length","errorSchema","isError","structuredContent","schema","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,wBAAwB,QAAQ,0DAAyD;AAClG,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBX,qBAAqB;IACrDY,QAAQ,CAACC,OACPd,cAAcc,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,OAAO5B,EAAE6B,MAAM,CAAC;QACdC,IAAI9B,EAAE+B,KAAK,CAAC;YAAC/B,EAAEgC,MAAM;YAAIhC,EAAEiC,MAAM;SAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;QAC3FC,MAAMpC,EAAEqC,MAAM,CAACrC,EAAEgC,MAAM,IAAIhC,EAAEsC,OAAO,IAAIJ,QAAQ,CAAC;QACjDK,OAAOvC,EACJiC,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOzC,EACJ0C,OAAO,GACPR,QAAQ,CAAC,6CACTC,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgB3C,EACbgC,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,UAAU5C,EAAEgC,MAAM,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;QACpEU,QAAQ7C,EACLgC,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;QACXW,cAAc9C,EACX0C,OAAO,GACPR,QAAQ,CAAC,sCACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,wBAAwB/C,EACrB0C,OAAO,GACPR,QAAQ,CAAC,uCACTC,QAAQ,GACRK,OAAO,CAAC;QACXQ,QAAQhD,EACLqC,MAAM,CAACrC,EAAEgC,MAAM,IAAIhC,EAAEsC,OAAO,IAC5BJ,QAAQ,CACP,sGAEDC,QAAQ;QACXc,OAAOxC,YACJyB,QAAQ,CACP,yJAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEhC,cAAc,EAAES,KAAK,EAAEwB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASnD,UAAU;QAAEkD;IAAQ;IAEnC,MAAM,EACJvB,EAAE,EACFM,IAAI,EACJG,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,MAAM,EACNC,KAAK,EACN,GAAGrB;IAEJ0B,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEpC,iBAAiBW,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEW,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACf,MAAM,CAACmB,OAAO;YACjB,OAAO;gBACLO,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,oBAAoBvD,+BAA+BiD,QAAQO,MAAM,EAAEzC;QACzE,MAAM0C,YAAYxD,mBAAmB+B,MAAMuB;QAC3C,MAAMG,kBAAkBpD,uBAAuB;YAC7CS;YACAiB,MAAMyB;YACNE,SAAS;YACTX;QACF;QAEA,IAAIU,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAME,aAAaxD,4BAA4BqD;QAE/C,MAAMI,cAAqBhB,SAAS,CAAC;QAErC,IAAInB,IAAI;YACN,MAAMoC,SAAS,MAAMb,QAAQjC,MAAM,CAAC;gBAClCU;gBACAqC,YAAYhD;gBACZiB,MAAM4B;gBACNzB;gBACAE;gBACAK;gBACAM;gBACA,GAAG9C,iBAAiB6C,cAAc;gBAClC,GAAIP,WAAW;oBAAEA;gBAAS,IAAI,CAAC,CAAC;gBAChC,GAAIG,yBAAyB;oBAAEA;gBAAuB,IAAI,CAAC,CAAC;gBAC5D,GAAIF,SAAS;oBAAEA;gBAAO,IAAI,CAAC,CAAC;gBAC5B,GAAIF,iBAAiB;oBAAEA;gBAAe,IAAI,CAAC,CAAC;gBAC5C,GAAIK,SAAS;oBAAEA,QAAQA;gBAAqB,IAAI,CAAC,CAAC;YACpD;YAEA,OAAO;gBACLQ,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEvC,eAAe,mCAAmC,EAAEiD,KAAKC,SAAS,CAACH,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDI,KAAKJ;YACP;QACF;QAEA,MAAMA,SAAS,MAAMb,QAAQjC,MAAM,CAAC;YAClC+C,YAAYhD;YACZiB,MAAM4B;YACNzB;YACAE;YACAK;YACAM;YACAH,OAAOgB;YACP,GAAG3D,iBAAiB6C,cAAc;YAClC,GAAIP,WAAW;gBAAEA;YAAS,IAAI,CAAC,CAAC;YAChC,GAAIG,yBAAyB;gBAAEA;YAAuB,IAAI,CAAC,CAAC;YAC5D,GAAIF,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIK,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEA,MAAMuB,OAAOL,OAAOK,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASN,OAAOM,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,0CAA0C,EAAEtD,eAAe,aAAa,EAAEoD,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACpJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEL,KAAKC,SAAS,CAACE,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEL,KAAKC,SAAS,CAACG,QAAQ,QAAQ,CAAC;YAE5E,MAAMG,cAAcpE,yBAAyB;gBAAEY;gBAAgBiC;YAAI;YAEnE,IAAIuB,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEL,KAAKC,SAAS,CAACM,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLnB,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMe;oBAAa;iBAAE;gBAC/CH,KAAK;oBAAEC;oBAAMC;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB1D;wBACAoD;wBACAC;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLnB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMe;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D5B,OAAOyB,KAAK,CAAC,CAAC,2BAA2B,EAAE5D,eAAe,EAAE,EAAE6D,cAAc;QAC5E,OAAOrE,sBAAsB;YAAEwE,QAAQ;YAAYhE;YAAgB4D;YAAO3B;QAAI;IAChF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { Where } from 'payload'\n\nimport {\n getCollectionInputSchema,\n getCollectionVirtualFieldNames,\n parseDocumentID,\n stripVirtualFields,\n transformPointDataToPayload,\n updateDocumentInputSchema,\n validateCollectionData,\n} from 'payload'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { formatEntityError } from '../formatEntityError.js'\nimport { fileInputSchema, resolveFile } from './fileInput.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'\n\nexport const updateDocumentTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Update Document',\n },\n description: DEFAULT_DESCRIPTION,\n input: updateDocumentInputSchema({ file: fileInputSchema }),\n}).handler(async ({ slug, authorizedMCP, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const {\n id,\n data,\n depth,\n draft,\n fallbackLocale,\n file: fileInput,\n limit,\n locale,\n overrideLock,\n populate,\n publishAllLocales,\n returning,\n select,\n sort,\n trash,\n unpublishAllLocales,\n where,\n } = input\n\n logger.info(\n `Updating document in collection: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n validateCollectionData({\n slug,\n data: inputData,\n partial: true,\n req,\n })\n\n const parsedData = transformPointDataToPayload(inputData)\n const file = await resolveFile({ slug, input: fileInput, req })\n\n const whereClause: Where = where ?? {}\n\n if (id !== undefined) {\n const result = await payload.update({\n id: parseDocumentID({ id, collectionSlug: slug, payload }),\n collection: slug,\n data: parsedData,\n depth,\n draft,\n fallbackLocale,\n locale,\n overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n populate,\n publishAllLocales,\n req,\n select: returning ? select : { id: true },\n trash,\n unpublishAllLocales,\n ...(file ? { file } : {}),\n })\n\n const responseResult = returning ? result : { id: result.id }\n\n return {\n content: [\n {\n type: 'text',\n text: `Document updated successfully in collection \"${slug}\"!\\nResult:\\n\\`\\`\\`json\\n${JSON.stringify(responseResult)}\\n\\`\\`\\``,\n },\n ],\n doc: responseResult as Record<string, unknown>,\n }\n }\n\n const result = await payload.update({\n collection: slug,\n data: parsedData,\n depth,\n draft,\n fallbackLocale,\n limit,\n locale,\n overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n populate,\n publishAllLocales,\n req,\n select: returning ? select : { id: true },\n sort,\n trash,\n unpublishAllLocales,\n where: whereClause,\n ...(file ? { file } : {}),\n })\n\n const docs = returning ? result.docs : result.docs.map(({ id }) => ({ id }))\n const errors = result.errors || []\n\n let responseText = `Multiple documents updated in collection \"${slug}\"!\\nUpdated: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n if (docs.length > 0) {\n responseText += `\\n\\nUpdated documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n }\n if (errors.length > 0) {\n responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n\n const errorSchema = getCollectionInputSchema({ collectionSlug: slug, req })\n\n if (errorSchema) {\n responseText += `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(errorSchema)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n isError: true,\n ...(errorSchema\n ? {\n structuredContent: {\n slug,\n docs,\n errors,\n schema: errorSchema,\n },\n }\n : {}),\n }\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error updating document in ${slug}: ${errorMessage}`)\n return formatEntityError({ slug, action: 'updating', entity: 'collection', error, req })\n }\n})\n"],"names":["getCollectionInputSchema","getCollectionVirtualFieldNames","parseDocumentID","stripVirtualFields","transformPointDataToPayload","updateDocumentInputSchema","validateCollectionData","defaultAccess","defineCollectionTool","getLogger","formatEntityError","fileInputSchema","resolveFile","DEFAULT_DESCRIPTION","updateDocumentTool","access","args","Boolean","permissions","collections","slug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","file","handler","authorizedMCP","req","payload","logger","id","data","depth","draft","fallbackLocale","fileInput","limit","locale","overrideLock","populate","publishAllLocales","returning","select","sort","trash","unpublishAllLocales","where","info","virtualFieldNames","config","inputData","partial","parsedData","whereClause","undefined","result","collectionSlug","collection","overrideAccess","responseResult","content","type","text","JSON","stringify","doc","docs","map","errors","responseText","length","errorSchema","isError","structuredContent","schema","error","errorMessage","Error","message","action","entity"],"mappings":"AAEA,SACEA,wBAAwB,EACxBC,8BAA8B,EAC9BC,eAAe,EACfC,kBAAkB,EAClBC,2BAA2B,EAC3BC,yBAAyB,EACzBC,sBAAsB,QACjB,UAAS;AAEhB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,iBAAiB,QAAQ,0BAAyB;AAC3D,SAASC,eAAe,EAAEC,WAAW,QAAQ,iBAAgB;AAE7D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBN,qBAAqB;IACrDO,QAAQ,CAACC,OACPT,cAAcS,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,IAAI,CAAC,EAAEC;IAC7EC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAOxB,0BAA0B;QAAEyB,MAAMnB;IAAgB;AAC3D,GAAGoB,OAAO,CAAC,OAAO,EAAEX,IAAI,EAAEY,aAAa,EAAEH,KAAK,EAAEI,GAAG,EAAE;IACnD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS1B,UAAU;QAAEyB;IAAQ;IAEnC,MAAM,EACJE,EAAE,EACFC,IAAI,EACJC,KAAK,EACLC,KAAK,EACLC,cAAc,EACdV,MAAMW,SAAS,EACfC,KAAK,EACLC,MAAM,EACNC,YAAY,EACZC,QAAQ,EACRC,iBAAiB,EACjBC,SAAS,EACTC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,mBAAmB,EACnBC,KAAK,EACN,GAAGvB;IAEJM,OAAOkB,IAAI,CACT,CAAC,iCAAiC,EAAEjC,OAAOgB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEG,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAGnJ,IAAI;QACF,MAAMW,oBAAoBrD,+BAA+BiC,QAAQqB,MAAM,EAAEnC;QACzE,MAAMoC,YAAYrD,mBAAmBkC,MAAMiB;QAC3ChD,uBAAuB;YACrBc;YACAiB,MAAMmB;YACNC,SAAS;YACTxB;QACF;QAEA,MAAMyB,aAAatD,4BAA4BoD;QAC/C,MAAM1B,OAAO,MAAMlB,YAAY;YAAEQ;YAAMS,OAAOY;YAAWR;QAAI;QAE7D,MAAM0B,cAAqBP,SAAS,CAAC;QAErC,IAAIhB,OAAOwB,WAAW;YACpB,MAAMC,SAAS,MAAM3B,QAAQb,MAAM,CAAC;gBAClCe,IAAIlC,gBAAgB;oBAAEkC;oBAAI0B,gBAAgB1C;oBAAMc;gBAAQ;gBACxD6B,YAAY3C;gBACZiB,MAAMqB;gBACNpB;gBACAC;gBACAC;gBACAG;gBACAqB,gBAAgBhC,cAAcgC,cAAc;gBAC5CpB;gBACAC;gBACAC;gBACAb;gBACAe,QAAQD,YAAYC,SAAS;oBAAEZ,IAAI;gBAAK;gBACxCc;gBACAC;gBACA,GAAIrB,OAAO;oBAAEA;gBAAK,IAAI,CAAC,CAAC;YAC1B;YAEA,MAAMmC,iBAAiBlB,YAAYc,SAAS;gBAAEzB,IAAIyB,OAAOzB,EAAE;YAAC;YAE5D,OAAO;gBACL8B,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEhD,KAAK,yBAAyB,EAAEiD,KAAKC,SAAS,CAACL,gBAAgB,QAAQ,CAAC;oBAChI;iBACD;gBACDM,KAAKN;YACP;QACF;QAEA,MAAMJ,SAAS,MAAM3B,QAAQb,MAAM,CAAC;YAClC0C,YAAY3C;YACZiB,MAAMqB;YACNpB;YACAC;YACAC;YACAE;YACAC;YACAqB,gBAAgBhC,cAAcgC,cAAc;YAC5CpB;YACAC;YACAC;YACAb;YACAe,QAAQD,YAAYC,SAAS;gBAAEZ,IAAI;YAAK;YACxCa;YACAC;YACAC;YACAC,OAAOO;YACP,GAAI7B,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;QAC1B;QAEA,MAAM0C,OAAOzB,YAAYc,OAAOW,IAAI,GAAGX,OAAOW,IAAI,CAACC,GAAG,CAAC,CAAC,EAAErC,EAAE,EAAE,GAAM,CAAA;gBAAEA;YAAG,CAAA;QACzE,MAAMsC,SAASb,OAAOa,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,0CAA0C,EAAEvD,KAAK,aAAa,EAAEoD,KAAKI,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QAC1I,IAAIJ,KAAKI,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEN,KAAKC,SAAS,CAACE,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIE,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEN,KAAKC,SAAS,CAACI,QAAQ,QAAQ,CAAC;YAE5E,MAAMG,cAAc7E,yBAAyB;gBAAE8D,gBAAgB1C;gBAAMa;YAAI;YAEzE,IAAI4C,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEN,KAAKC,SAAS,CAACO,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLX,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMO;oBAAa;iBAAE;gBAC/CJ,KAAK;oBAAEC;oBAAME;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB3D;wBACAoD;wBACAE;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLX,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMO;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEC;gBAAME;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DjD,OAAO8C,KAAK,CAAC,CAAC,2BAA2B,EAAE7D,KAAK,EAAE,EAAE8D,cAAc;QAClE,OAAOxE,kBAAkB;YAAEU;YAAMiE,QAAQ;YAAYC,QAAQ;YAAcL;YAAOhD;QAAI;IACxF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const getUploadInstructionsTool: import("../../../types.js").CollectionTool;
2
+ //# sourceMappingURL=uploadInstructionsTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"uploadInstructionsTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/uploadInstructionsTool.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,yBAAyB,4CAyDpC,CAAA"}
@@ -0,0 +1,55 @@
1
+ import { strictObject, z } from 'payload';
2
+ import { getUploadInstructions as getPayloadUploadInstructions } from 'payload/internal';
3
+ import { defaultAccess } from '../../../defaultAccess.js';
4
+ import { defineCollectionTool } from '../../../defineTool.js';
5
+ export const getUploadInstructionsTool = defineCollectionTool({
6
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.create || args.permissions?.collections?.[args.slug]?.update),
7
+ annotations: {
8
+ destructiveHint: false,
9
+ idempotentHint: false,
10
+ openWorldHint: true,
11
+ readOnlyHint: false,
12
+ title: 'Get Upload Instructions'
13
+ },
14
+ description: 'Prepare uploads for createDocuments or updateDocument. This does not upload bytes; finish the returned action before use.',
15
+ input: strictObject({
16
+ docPrefix: z.optional(z.string()).check(z.describe('Document folder or prefix.')),
17
+ filename: z.string().check(z.describe('The original file name.')),
18
+ filesize: z.int().check(z.nonnegative(), z.describe('The file size in bytes.')),
19
+ mimeType: z.string().check(z.describe('The file MIME type.'))
20
+ })
21
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
22
+ try {
23
+ const instructions = await getPayloadUploadInstructions({
24
+ ...input,
25
+ collectionSlug: slug,
26
+ overrideAccess: authorizedMCP.overrideAccess,
27
+ req
28
+ });
29
+ const nextStep = instructions.type === 'http' ? 'Upload bytes with instructions.request. After success, pass { source: "uploadReference", file: instructions.file }.' : `Call "${instructions.name}" with file and data. After success, pass { source: "uploadReference", file: instructions.file }.`;
30
+ return {
31
+ content: [
32
+ {
33
+ type: 'text',
34
+ text: `Upload instructions for collection "${slug}":\n\`\`\`json\n${JSON.stringify(instructions)}\n\`\`\`\n${nextStep}`
35
+ }
36
+ ],
37
+ structuredContent: {
38
+ instructions
39
+ }
40
+ };
41
+ } catch (error) {
42
+ const message = error instanceof Error ? error.message : 'Unknown error';
43
+ return {
44
+ content: [
45
+ {
46
+ type: 'text',
47
+ text: `Error getting upload instructions for collection "${slug}": ${message}`
48
+ }
49
+ ],
50
+ isError: true
51
+ };
52
+ }
53
+ });
54
+
55
+ //# sourceMappingURL=uploadInstructionsTool.js.map