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

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 (182) hide show
  1. package/bin.js +7 -0
  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 +6 -13
  8. package/dist/endpoint/access.js.map +1 -1
  9. package/dist/mcp/buildMcpServer.d.ts +1 -1
  10. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  11. package/dist/mcp/buildMcpServer.js +35 -23
  12. package/dist/mcp/buildMcpServer.js.map +1 -1
  13. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  14. package/dist/mcp/builtin/collections/authTools.js +79 -56
  15. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  16. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  17. package/dist/mcp/builtin/collections/countTool.js +10 -16
  18. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  19. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  20. package/dist/mcp/builtin/collections/countVersionsTool.js +10 -15
  21. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  22. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  23. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  24. package/dist/mcp/builtin/collections/createTool.js +104 -54
  25. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  26. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  27. package/dist/mcp/builtin/collections/deleteTool.js +45 -45
  28. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  29. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  30. package/dist/mcp/builtin/collections/duplicateTool.js +32 -39
  31. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  32. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  33. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  34. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  35. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  36. package/dist/mcp/builtin/collections/fileInput.spec.js +86 -0
  37. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  38. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  39. package/dist/mcp/builtin/collections/findDistinctTool.js +12 -28
  40. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  41. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  42. package/dist/mcp/builtin/collections/findTool.js +29 -48
  43. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  44. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/findVersionByIDTool.js +18 -28
  46. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  47. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  48. package/dist/mcp/builtin/collections/findVersionsTool.js +17 -32
  49. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  50. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  51. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +51 -11
  52. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  53. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  54. package/dist/mcp/builtin/collections/restoreVersionTool.js +15 -28
  55. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  56. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  57. package/dist/mcp/builtin/collections/updateTool.js +67 -87
  58. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  59. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  60. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  61. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  62. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  63. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  64. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  65. package/dist/mcp/builtin/formatEntityError.js +55 -0
  66. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  67. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  68. package/dist/mcp/builtin/getConfigInfoTool.js +5 -7
  69. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  70. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  71. package/dist/mcp/builtin/globals/countVersionsTool.js +10 -15
  72. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  73. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  74. package/dist/mcp/builtin/globals/findTool.js +12 -18
  75. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  76. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  77. package/dist/mcp/builtin/globals/findVersionByIDTool.js +14 -26
  78. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  79. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  80. package/dist/mcp/builtin/globals/findVersionsTool.js +14 -31
  81. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  82. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  83. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +28 -10
  84. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  85. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  86. package/dist/mcp/builtin/globals/restoreVersionTool.js +16 -24
  87. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  88. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  89. package/dist/mcp/builtin/globals/updateTool.js +28 -37
  90. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  91. package/dist/mcp/builtinTools.d.ts +6 -0
  92. package/dist/mcp/builtinTools.d.ts.map +1 -1
  93. package/dist/mcp/builtinTools.js +9 -3
  94. package/dist/mcp/builtinTools.js.map +1 -1
  95. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  96. package/dist/mcp/sanitizeMCPConfig.js +4 -1
  97. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  98. package/dist/stdio.d.ts.map +1 -1
  99. package/dist/stdio.js +2 -1
  100. package/dist/stdio.js.map +1 -1
  101. package/dist/types.d.ts +48 -11
  102. package/dist/types.d.ts.map +1 -1
  103. package/dist/types.js +2 -4
  104. package/dist/types.js.map +1 -1
  105. package/dist/utils/camelCase.d.ts.map +1 -1
  106. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  107. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  108. package/package.json +5 -7
  109. package/src/endpoint/access.ts +5 -13
  110. package/src/mcp/buildMcpServer.ts +39 -29
  111. package/src/mcp/builtin/collections/authTools.ts +77 -69
  112. package/src/mcp/builtin/collections/countTool.ts +10 -23
  113. package/src/mcp/builtin/collections/countVersionsTool.ts +10 -23
  114. package/src/mcp/builtin/collections/createTool.ts +110 -77
  115. package/src/mcp/builtin/collections/deleteTool.ts +36 -65
  116. package/src/mcp/builtin/collections/duplicateTool.ts +36 -87
  117. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  118. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  119. package/src/mcp/builtin/collections/findDistinctTool.ts +12 -64
  120. package/src/mcp/builtin/collections/findTool.ts +25 -108
  121. package/src/mcp/builtin/collections/findVersionByIDTool.ts +16 -60
  122. package/src/mcp/builtin/collections/findVersionsTool.ts +15 -87
  123. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +48 -14
  124. package/src/mcp/builtin/collections/restoreVersionTool.ts +15 -58
  125. package/src/mcp/builtin/collections/updateTool.ts +63 -101
  126. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  127. package/src/mcp/builtin/formatEntityError.ts +77 -0
  128. package/src/mcp/builtin/getConfigInfoTool.ts +4 -5
  129. package/src/mcp/builtin/globals/countVersionsTool.ts +10 -22
  130. package/src/mcp/builtin/globals/findTool.ts +14 -53
  131. package/src/mcp/builtin/globals/findVersionByIDTool.ts +14 -54
  132. package/src/mcp/builtin/globals/findVersionsTool.ts +15 -94
  133. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +30 -8
  134. package/src/mcp/builtin/globals/restoreVersionTool.ts +17 -48
  135. package/src/mcp/builtin/globals/updateTool.ts +39 -62
  136. package/src/mcp/builtinTools.ts +9 -2
  137. package/src/mcp/sanitizeMCPConfig.ts +4 -1
  138. package/src/stdio.ts +2 -1
  139. package/src/types.ts +47 -11
  140. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +0 -9
  141. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +0 -1
  142. package/dist/mcp/builtin/collections/formatCollectionError.js +0 -60
  143. package/dist/mcp/builtin/collections/formatCollectionError.js.map +0 -1
  144. package/dist/mcp/builtin/validateEntityData.d.ts +0 -14
  145. package/dist/mcp/builtin/validateEntityData.d.ts.map +0 -1
  146. package/dist/mcp/builtin/validateEntityData.js +0 -82
  147. package/dist/mcp/builtin/validateEntityData.js.map +0 -1
  148. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  149. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  150. package/dist/utils/getVirtualFieldNames.js +0 -35
  151. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  152. package/dist/utils/localAPIDefaults.d.ts +0 -20
  153. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  154. package/dist/utils/localAPIDefaults.js +0 -19
  155. package/dist/utils/localAPIDefaults.js.map +0 -1
  156. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -11
  157. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  158. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -32
  159. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  160. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -10
  161. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  162. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -384
  163. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  164. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -133
  165. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  166. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  167. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  168. package/dist/utils/transformPointDataToPayload.js +0 -28
  169. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  170. package/dist/utils/whereSchema.d.ts +0 -9
  171. package/dist/utils/whereSchema.d.ts.map +0 -1
  172. package/dist/utils/whereSchema.js +0 -13
  173. package/dist/utils/whereSchema.js.map +0 -1
  174. package/src/mcp/builtin/collections/formatCollectionError.ts +0 -84
  175. package/src/mcp/builtin/validateEntityData.ts +0 -132
  176. package/src/utils/getVirtualFieldNames.ts +0 -53
  177. package/src/utils/localAPIDefaults.ts +0 -22
  178. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -62
  179. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -96
  180. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -432
  181. package/src/utils/transformPointDataToPayload.ts +0 -40
  182. package/src/utils/whereSchema.ts +0 -24
@@ -1,83 +1,133 @@
1
- import { z } from 'zod';
1
+ import { createDocumentsInputSchema, getCollectionVirtualFieldNames, hasDraftValidationEnabled, stripVirtualFields, transformPointDataToPayload, 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 { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
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),
5
+ import { formatEntityError } from '../formatEntityError.js';
6
+ import { fileInputSchema, resolveFile } from './fileInput.js';
7
+ const DEFAULT_DESCRIPTION = 'Create one or more documents. Each can have different data or a file. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.';
8
+ export const createDocumentsTool = defineCollectionTool({
9
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.create),
13
10
  annotations: {
14
11
  destructiveHint: false,
15
12
  idempotentHint: false,
16
13
  openWorldHint: false,
17
14
  readOnlyHint: false,
18
- title: 'Create Document'
15
+ title: 'Create Documents'
19
16
  },
20
17
  description: DEFAULT_DESCRIPTION,
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()
18
+ input: createDocumentsInputSchema({
19
+ file: fileInputSchema
28
20
  })
29
- }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
21
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
30
22
  const payload = req.payload;
23
+ const collectionConfig = payload.collections[slug]?.config;
31
24
  const logger = getLogger({
32
25
  payload
33
26
  });
34
- const { data, depth, draft, fallbackLocale, locale, select } = input;
35
- logger.info(`Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`);
27
+ const { depth, documents, draft, fallbackLocale, locale, populate, publishAllLocales, returning, select } = input;
28
+ const shouldUsePartialSchema = draft === true && collectionConfig !== undefined && !hasDraftValidationEnabled(collectionConfig);
29
+ logger.info(`Creating ${documents.length} documents in collection: ${slug}`);
36
30
  try {
37
- const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
38
- const inputData = stripVirtualFields(data, virtualFieldNames);
39
- const validationError = validateCollectionData({
40
- collectionSlug,
41
- data: inputData,
42
- req
43
- });
44
- if (validationError) {
45
- return validationError;
31
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug);
32
+ const docs = [];
33
+ const errors = [];
34
+ let validationSchema;
35
+ for (const [index, document] of documents.entries()){
36
+ try {
37
+ const inputData = stripVirtualFields(document.data, virtualFieldNames);
38
+ validateCollectionData({
39
+ slug,
40
+ data: inputData,
41
+ partial: shouldUsePartialSchema,
42
+ req
43
+ });
44
+ const parsedData = transformPointDataToPayload(inputData);
45
+ const file = await resolveFile({
46
+ slug,
47
+ input: document.file,
48
+ req
49
+ });
50
+ const result = await payload.create({
51
+ collection: slug,
52
+ data: parsedData,
53
+ depth,
54
+ draft,
55
+ overrideAccess: authorizedMCP.overrideAccess,
56
+ populate,
57
+ publishAllLocales,
58
+ req,
59
+ ...file ? {
60
+ file
61
+ } : {},
62
+ ...locale ? {
63
+ locale
64
+ } : {},
65
+ ...fallbackLocale !== undefined ? {
66
+ fallbackLocale
67
+ } : {},
68
+ select: returning ? select : {
69
+ id: true
70
+ }
71
+ });
72
+ docs.push(returning ? {
73
+ doc: result,
74
+ index
75
+ } : {
76
+ id: result.id,
77
+ index
78
+ });
79
+ } catch (error) {
80
+ const message = error instanceof Error ? error.message : 'Unknown error';
81
+ const formattedError = formatEntityError({
82
+ slug,
83
+ action: 'creating',
84
+ entity: 'collection',
85
+ error,
86
+ req
87
+ });
88
+ const structuredContent = formattedError.structuredContent;
89
+ const schema = structuredContent?.schema;
90
+ const errorContent = formattedError.content[0];
91
+ const formattedMessage = errorContent?.type === 'text' ? errorContent.text.split('\n\nUse this schema')[0] ?? message : message;
92
+ if (!validationSchema && schema && typeof schema === 'object') {
93
+ validationSchema = schema;
94
+ }
95
+ logger.error(`Error creating document at index ${index} in ${slug}: ${message}`);
96
+ errors.push({
97
+ index,
98
+ message: formattedMessage
99
+ });
100
+ }
46
101
  }
47
- const parsedData = transformPointDataToPayload(inputData);
48
- const result = await payload.create({
49
- collection: collectionSlug,
50
- data: parsedData,
51
- depth,
52
- draft,
53
- req,
54
- ...localAPIDefaults(authorizedMCP),
55
- ...locale ? {
56
- locale
57
- } : {},
58
- ...fallbackLocale ? {
59
- fallbackLocale
60
- } : {},
61
- ...select ? {
62
- select: select
63
- } : {}
64
- });
65
- logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`);
102
+ const batchResult = {
103
+ docs,
104
+ errors
105
+ };
106
+ const retryMessage = errors.length > 0 ? '\nRetry failed indexes only.' : '';
107
+ const schemaMessage = validationSchema ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(validationSchema)}\n\`\`\`` : '';
108
+ const structuredContent = validationSchema ? {
109
+ ...batchResult,
110
+ schema: validationSchema
111
+ } : batchResult;
112
+ logger.info(`Created ${docs.length} of ${documents.length} documents in ${slug}`);
66
113
  return {
67
114
  content: [
68
115
  {
69
116
  type: 'text',
70
- text: `Document created successfully in collection "${collectionSlug}"!\nCreated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
117
+ text: `Created ${docs.length} of ${documents.length} documents in collection "${slug}".${retryMessage}\nResults:\n\`\`\`json\n${JSON.stringify(batchResult)}\n\`\`\`${schemaMessage}`
71
118
  }
72
119
  ],
73
- doc: result
120
+ doc: structuredContent,
121
+ isError: docs.length === 0 && errors.length > 0,
122
+ structuredContent
74
123
  };
75
124
  } catch (error) {
76
- const errorMessage = error instanceof Error ? error.message : 'Unknown error';
77
- logger.error(`Error creating document in ${collectionSlug}: ${errorMessage}`);
78
- return formatCollectionError({
125
+ const message = error instanceof Error ? error.message : 'Unknown error';
126
+ logger.error(`Error creating documents in ${slug}: ${message}`);
127
+ return formatEntityError({
128
+ slug,
79
129
  action: 'creating',
80
- collectionSlug,
130
+ entity: 'collection',
81
131
  error,
82
132
  req
83
133
  });
@@ -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 { 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
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"sourcesContent":["import {\n createDocumentsInputSchema,\n getCollectionVirtualFieldNames,\n hasDraftValidationEnabled,\n stripVirtualFields,\n transformPointDataToPayload,\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 'Create one or more documents. Each can have different data or a file. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'\n\nexport const createDocumentsTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.create),\n annotations: {\n destructiveHint: false,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Create Documents',\n },\n description: DEFAULT_DESCRIPTION,\n input: createDocumentsInputSchema({ file: fileInputSchema }),\n}).handler(async ({ slug, authorizedMCP, input, req }) => {\n const payload = req.payload\n const collectionConfig = payload.collections[slug]?.config\n const logger = getLogger({ payload })\n const {\n depth,\n documents,\n draft,\n fallbackLocale,\n locale,\n populate,\n publishAllLocales,\n returning,\n select,\n } = input\n const shouldUsePartialSchema =\n draft === true && collectionConfig !== undefined && !hasDraftValidationEnabled(collectionConfig)\n\n logger.info(`Creating ${documents.length} documents in collection: ${slug}`)\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)\n const docs: Array<\n { doc: Record<string, unknown>; index: number } | { id: number | string; index: number }\n > = []\n const errors: Array<{ index: number; message: string }> = []\n let validationSchema: Record<string, unknown> | undefined\n\n for (const [index, document] of documents.entries()) {\n try {\n const inputData = stripVirtualFields(document.data, virtualFieldNames)\n validateCollectionData({\n slug,\n data: inputData,\n partial: shouldUsePartialSchema,\n req,\n })\n\n const parsedData = transformPointDataToPayload(inputData)\n const file = await resolveFile({ slug, input: document.file, req })\n const result = await payload.create({\n collection: slug,\n data: parsedData,\n depth,\n draft,\n overrideAccess: authorizedMCP.overrideAccess,\n populate,\n publishAllLocales,\n req,\n ...(file ? { file } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),\n select: returning ? select : { id: true },\n })\n\n docs.push(\n returning ? { doc: result as Record<string, unknown>, index } : { id: result.id, index },\n )\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n const formattedError = formatEntityError({\n slug,\n action: 'creating',\n entity: 'collection',\n error,\n req,\n })\n const structuredContent = formattedError.structuredContent as\n | { schema?: unknown }\n | undefined\n const schema = structuredContent?.schema\n const errorContent = formattedError.content[0]\n const formattedMessage =\n errorContent?.type === 'text'\n ? (errorContent.text.split('\\n\\nUse this schema')[0] ?? message)\n : message\n\n if (!validationSchema && schema && typeof schema === 'object') {\n validationSchema = schema as Record<string, unknown>\n }\n\n logger.error(`Error creating document at index ${index} in ${slug}: ${message}`)\n errors.push({ index, message: formattedMessage })\n }\n }\n\n const batchResult = { docs, errors }\n const retryMessage = errors.length > 0 ? '\\nRetry failed indexes only.' : ''\n const schemaMessage = validationSchema\n ? `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(validationSchema)}\\n\\`\\`\\``\n : ''\n const structuredContent = validationSchema\n ? { ...batchResult, schema: validationSchema }\n : batchResult\n\n logger.info(`Created ${docs.length} of ${documents.length} documents in ${slug}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Created ${docs.length} of ${documents.length} documents in collection \"${slug}\".${retryMessage}\\nResults:\\n\\`\\`\\`json\\n${JSON.stringify(batchResult)}\\n\\`\\`\\`${schemaMessage}`,\n },\n ],\n doc: structuredContent as unknown as Record<string, unknown>,\n isError: docs.length === 0 && errors.length > 0,\n structuredContent,\n }\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n\n logger.error(`Error creating documents in ${slug}: ${message}`)\n return formatEntityError({ slug, action: 'creating', entity: 'collection', error, req })\n }\n})\n"],"names":["createDocumentsInputSchema","getCollectionVirtualFieldNames","hasDraftValidationEnabled","stripVirtualFields","transformPointDataToPayload","validateCollectionData","defaultAccess","defineCollectionTool","getLogger","formatEntityError","fileInputSchema","resolveFile","DEFAULT_DESCRIPTION","createDocumentsTool","access","args","Boolean","permissions","collections","slug","create","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","file","handler","authorizedMCP","req","payload","collectionConfig","config","logger","depth","documents","draft","fallbackLocale","locale","populate","publishAllLocales","returning","select","shouldUsePartialSchema","undefined","info","length","virtualFieldNames","docs","errors","validationSchema","index","document","entries","inputData","data","partial","parsedData","result","collection","overrideAccess","id","push","doc","error","message","Error","formattedError","action","entity","structuredContent","schema","errorContent","content","formattedMessage","type","text","split","batchResult","retryMessage","schemaMessage","JSON","stringify","isError"],"mappings":"AAAA,SACEA,0BAA0B,EAC1BC,8BAA8B,EAC9BC,yBAAyB,EACzBC,kBAAkB,EAClBC,2BAA2B,EAC3BC,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,sBAAsBN,qBAAqB;IACtDO,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,OAAO5B,2BAA2B;QAAE6B,MAAMnB;IAAgB;AAC5D,GAAGoB,OAAO,CAAC,OAAO,EAAEX,IAAI,EAAEY,aAAa,EAAEH,KAAK,EAAEI,GAAG,EAAE;IACnD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,mBAAmBD,QAAQf,WAAW,CAACC,KAAK,EAAEgB;IACpD,MAAMC,SAAS5B,UAAU;QAAEyB;IAAQ;IACnC,MAAM,EACJI,KAAK,EACLC,SAAS,EACTC,KAAK,EACLC,cAAc,EACdC,MAAM,EACNC,QAAQ,EACRC,iBAAiB,EACjBC,SAAS,EACTC,MAAM,EACP,GAAGjB;IACJ,MAAMkB,yBACJP,UAAU,QAAQL,qBAAqBa,aAAa,CAAC7C,0BAA0BgC;IAEjFE,OAAOY,IAAI,CAAC,CAAC,SAAS,EAAEV,UAAUW,MAAM,CAAC,0BAA0B,EAAE9B,MAAM;IAE3E,IAAI;QACF,MAAM+B,oBAAoBjD,+BAA+BgC,QAAQE,MAAM,EAAEhB;QACzE,MAAMgC,OAEF,EAAE;QACN,MAAMC,SAAoD,EAAE;QAC5D,IAAIC;QAEJ,KAAK,MAAM,CAACC,OAAOC,SAAS,IAAIjB,UAAUkB,OAAO,GAAI;YACnD,IAAI;gBACF,MAAMC,YAAYtD,mBAAmBoD,SAASG,IAAI,EAAER;gBACpD7C,uBAAuB;oBACrBc;oBACAuC,MAAMD;oBACNE,SAASb;oBACTd;gBACF;gBAEA,MAAM4B,aAAaxD,4BAA4BqD;gBAC/C,MAAM5B,OAAO,MAAMlB,YAAY;oBAAEQ;oBAAMS,OAAO2B,SAAS1B,IAAI;oBAAEG;gBAAI;gBACjE,MAAM6B,SAAS,MAAM5B,QAAQb,MAAM,CAAC;oBAClC0C,YAAY3C;oBACZuC,MAAME;oBACNvB;oBACAE;oBACAwB,gBAAgBhC,cAAcgC,cAAc;oBAC5CrB;oBACAC;oBACAX;oBACA,GAAIH,OAAO;wBAAEA;oBAAK,IAAI,CAAC,CAAC;oBACxB,GAAIY,SAAS;wBAAEA;oBAAO,IAAI,CAAC,CAAC;oBAC5B,GAAID,mBAAmBO,YAAY;wBAAEP;oBAAe,IAAI,CAAC,CAAC;oBAC1DK,QAAQD,YAAYC,SAAS;wBAAEmB,IAAI;oBAAK;gBAC1C;gBAEAb,KAAKc,IAAI,CACPrB,YAAY;oBAAEsB,KAAKL;oBAAmCP;gBAAM,IAAI;oBAAEU,IAAIH,OAAOG,EAAE;oBAAEV;gBAAM;YAE3F,EAAE,OAAOa,OAAO;gBACd,MAAMC,UAAUD,iBAAiBE,QAAQF,MAAMC,OAAO,GAAG;gBACzD,MAAME,iBAAiB7D,kBAAkB;oBACvCU;oBACAoD,QAAQ;oBACRC,QAAQ;oBACRL;oBACAnC;gBACF;gBACA,MAAMyC,oBAAoBH,eAAeG,iBAAiB;gBAG1D,MAAMC,SAASD,mBAAmBC;gBAClC,MAAMC,eAAeL,eAAeM,OAAO,CAAC,EAAE;gBAC9C,MAAMC,mBACJF,cAAcG,SAAS,SAClBH,aAAaI,IAAI,CAACC,KAAK,CAAC,sBAAsB,CAAC,EAAE,IAAIZ,UACtDA;gBAEN,IAAI,CAACf,oBAAoBqB,UAAU,OAAOA,WAAW,UAAU;oBAC7DrB,mBAAmBqB;gBACrB;gBAEAtC,OAAO+B,KAAK,CAAC,CAAC,iCAAiC,EAAEb,MAAM,IAAI,EAAEnC,KAAK,EAAE,EAAEiD,SAAS;gBAC/EhB,OAAOa,IAAI,CAAC;oBAAEX;oBAAOc,SAASS;gBAAiB;YACjD;QACF;QAEA,MAAMI,cAAc;YAAE9B;YAAMC;QAAO;QACnC,MAAM8B,eAAe9B,OAAOH,MAAM,GAAG,IAAI,iCAAiC;QAC1E,MAAMkC,gBAAgB9B,mBAClB,CAAC,2CAA2C,EAAE+B,KAAKC,SAAS,CAAChC,kBAAkB,QAAQ,CAAC,GACxF;QACJ,MAAMoB,oBAAoBpB,mBACtB;YAAE,GAAG4B,WAAW;YAAEP,QAAQrB;QAAiB,IAC3C4B;QAEJ7C,OAAOY,IAAI,CAAC,CAAC,QAAQ,EAAEG,KAAKF,MAAM,CAAC,IAAI,EAAEX,UAAUW,MAAM,CAAC,cAAc,EAAE9B,MAAM;QAEhF,OAAO;YACLyD,SAAS;gBACP;oBACEE,MAAM;oBACNC,MAAM,CAAC,QAAQ,EAAE5B,KAAKF,MAAM,CAAC,IAAI,EAAEX,UAAUW,MAAM,CAAC,0BAA0B,EAAE9B,KAAK,EAAE,EAAE+D,aAAa,wBAAwB,EAAEE,KAAKC,SAAS,CAACJ,aAAa,QAAQ,EAAEE,eAAe;gBACvL;aACD;YACDjB,KAAKO;YACLa,SAASnC,KAAKF,MAAM,KAAK,KAAKG,OAAOH,MAAM,GAAG;YAC9CwB;QACF;IACF,EAAE,OAAON,OAAO;QACd,MAAMC,UAAUD,iBAAiBE,QAAQF,MAAMC,OAAO,GAAG;QAEzDhC,OAAO+B,KAAK,CAAC,CAAC,4BAA4B,EAAEhD,KAAK,EAAE,EAAEiD,SAAS;QAC9D,OAAO3D,kBAAkB;YAAEU;YAAMoD,QAAQ;YAAYC,QAAQ;YAAcL;YAAOnC;QAAI;IACxF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,mBAAmB,4CAkH9B,CAAA"}
1
+ {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,mBAAmB,4CAuF9B,CAAA"}
@@ -1,12 +1,10 @@
1
- import { z } from 'zod';
1
+ import { deleteDocumentsInputSchema, parseDocumentID } 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
- import { whereSchema } from '../../../utils/whereSchema.js';
7
5
  const DEFAULT_DESCRIPTION = 'Delete documents in any collection by passing the collection slug and ID or where clause.';
8
6
  export const deleteDocumentsTool = defineCollectionTool({
9
- access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.delete),
7
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.delete),
10
8
  annotations: {
11
9
  destructiveHint: true,
12
10
  idempotentHint: false,
@@ -15,25 +13,44 @@ export const deleteDocumentsTool = defineCollectionTool({
15
13
  title: 'Delete Documents'
16
14
  },
17
15
  description: DEFAULT_DESCRIPTION,
18
- input: z.object({
19
- id: z.union([
20
- z.string(),
21
- z.number()
22
- ]).describe('Optional: specific document ID to delete').optional(),
23
- depth: z.number().int().min(0).max(10).describe('Depth of population for relationships in response').optional().default(0),
24
- fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
25
- locale: z.string().describe('Optional: locale code for the operation (e.g., "en", "es"). Defaults to the default locale').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()
27
- })
28
- }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
16
+ input: deleteDocumentsInputSchema
17
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
29
18
  const payload = req.payload;
30
19
  const logger = getLogger({
31
20
  payload
32
21
  });
33
22
  const { id, depth, fallbackLocale, locale, where } = input;
34
- logger.info(`Deleting document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`);
23
+ logger.info(`Deleting document from collection: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`);
35
24
  try {
36
- if (!id && !where) {
25
+ if (id !== undefined) {
26
+ const result = await payload.delete({
27
+ id: parseDocumentID({
28
+ id,
29
+ collectionSlug: slug,
30
+ payload
31
+ }),
32
+ collection: slug,
33
+ depth,
34
+ overrideAccess: authorizedMCP.overrideAccess,
35
+ req,
36
+ ...locale && {
37
+ locale
38
+ },
39
+ ...fallbackLocale !== undefined && {
40
+ fallbackLocale
41
+ }
42
+ });
43
+ return {
44
+ content: [
45
+ {
46
+ type: 'text',
47
+ text: `Document deleted successfully from collection "${slug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
48
+ }
49
+ ],
50
+ doc: result
51
+ };
52
+ }
53
+ if (where === undefined) {
37
54
  return {
38
55
  content: [
39
56
  {
@@ -43,39 +60,22 @@ export const deleteDocumentsTool = defineCollectionTool({
43
60
  ]
44
61
  };
45
62
  }
46
- const deleteOptions = {
47
- collection: collectionSlug,
63
+ const result = await payload.delete({
64
+ collection: slug,
48
65
  depth,
66
+ overrideAccess: authorizedMCP.overrideAccess,
49
67
  req,
50
- ...localAPIDefaults(authorizedMCP),
68
+ where,
51
69
  ...locale && {
52
70
  locale
53
71
  },
54
- ...fallbackLocale && {
72
+ ...fallbackLocale !== undefined && {
55
73
  fallbackLocale
56
74
  }
57
- };
58
- if (id) {
59
- deleteOptions.id = id;
60
- } else {
61
- deleteOptions.where = where;
62
- }
63
- const result = await payload.delete(deleteOptions);
64
- if (id) {
65
- return {
66
- content: [
67
- {
68
- type: 'text',
69
- text: `Document deleted successfully from collection "${collectionSlug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
70
- }
71
- ],
72
- doc: result
73
- };
74
- }
75
- const bulkResult = result;
76
- const docs = bulkResult.docs || [];
77
- const errors = bulkResult.errors || [];
78
- let responseText = `Document deleted successfully from collection "${collectionSlug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`;
75
+ });
76
+ const docs = result.docs || [];
77
+ const errors = result.errors || [];
78
+ let responseText = `Document deleted successfully from collection "${slug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`;
79
79
  if (docs.length > 0) {
80
80
  responseText += `\n\nDeleted documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``;
81
81
  }
@@ -96,12 +96,12 @@ export const deleteDocumentsTool = defineCollectionTool({
96
96
  };
97
97
  } catch (error) {
98
98
  const errorMessage = error instanceof Error ? error.message : 'Unknown error';
99
- logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`);
99
+ logger.error(`Error deleting document from ${slug}: ${errorMessage}`);
100
100
  return {
101
101
  content: [
102
102
  {
103
103
  type: 'text',
104
- text: `Error deleting document from collection "${collectionSlug}": ${errorMessage}`
104
+ text: `Error deleting document from collection "${slug}": ${errorMessage}`
105
105
  }
106
106
  ]
107
107
  };
@@ -1 +1 @@
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"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"sourcesContent":["import { deleteDocumentsInputSchema, parseDocumentID } from 'payload'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.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.slug]?.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: deleteDocumentsInputSchema,\n}).handler(async ({ slug, authorizedMCP, 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: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n if (id !== undefined) {\n const result = await payload.delete({\n id: parseDocumentID({ id, collectionSlug: slug, payload }),\n collection: slug,\n depth,\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n ...(locale && { locale }),\n ...(fallbackLocale !== undefined && { fallbackLocale }),\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Document deleted successfully from collection \"${slug}\"!\\nDeleted document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n }\n\n if (where === undefined) {\n return {\n content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n }\n }\n\n const result = await payload.delete({\n collection: slug,\n depth,\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n where,\n ...(locale && { locale }),\n ...(fallbackLocale !== undefined && { fallbackLocale }),\n })\n const docs = result.docs || []\n const errors = result.errors || []\n\n let responseText = `Document deleted successfully from collection \"${slug}\"!\\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 ${slug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `Error deleting document from collection \"${slug}\": ${errorMessage}`,\n },\n ],\n }\n }\n})\n"],"names":["deleteDocumentsInputSchema","parseDocumentID","defaultAccess","defineCollectionTool","getLogger","DEFAULT_DESCRIPTION","deleteDocumentsTool","access","args","Boolean","permissions","collections","slug","delete","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","handler","authorizedMCP","req","payload","logger","id","depth","fallbackLocale","locale","where","info","undefined","result","collectionSlug","collection","overrideAccess","content","type","text","JSON","stringify","doc","docs","errors","responseText","length","error","errorMessage","Error","message"],"mappings":"AAAA,SAASA,0BAA0B,EAAEC,eAAe,QAAQ,UAAS;AAErE,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AAEvD,MAAMC,sBACJ;AAEF,OAAO,MAAMC,sBAAsBH,qBAAqB;IACtDI,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,OAAOrB;AACT,GAAGsB,OAAO,CAAC,OAAO,EAAEV,IAAI,EAAEW,aAAa,EAAEF,KAAK,EAAEG,GAAG,EAAE;IACnD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAStB,UAAU;QAAEqB;IAAQ;IAEnC,MAAM,EAAEE,EAAE,EAAEC,KAAK,EAAEC,cAAc,EAAEC,MAAM,EAAEC,KAAK,EAAE,GAAGV;IAErDK,OAAOM,IAAI,CACT,CAAC,mCAAmC,EAAEpB,OAAOe,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,uBAAuBG,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAGpI,IAAI;QACF,IAAIH,OAAOM,WAAW;YACpB,MAAMC,SAAS,MAAMT,QAAQZ,MAAM,CAAC;gBAClCc,IAAI1B,gBAAgB;oBAAE0B;oBAAIQ,gBAAgBvB;oBAAMa;gBAAQ;gBACxDW,YAAYxB;gBACZgB;gBACAS,gBAAgBd,cAAcc,cAAc;gBAC5Cb;gBACA,GAAIM,UAAU;oBAAEA;gBAAO,CAAC;gBACxB,GAAID,mBAAmBI,aAAa;oBAAEJ;gBAAe,CAAC;YACxD;YAEA,OAAO;gBACLS,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAE5B,KAAK,mCAAmC,EAAE6B,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;oBACpI;iBACD;gBACDS,KAAKT;YACP;QACF;QAEA,IAAIH,UAAUE,WAAW;YACvB,OAAO;gBACLK,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMN,SAAS,MAAMT,QAAQZ,MAAM,CAAC;YAClCuB,YAAYxB;YACZgB;YACAS,gBAAgBd,cAAcc,cAAc;YAC5Cb;YACAO;YACA,GAAID,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,mBAAmBI,aAAa;gBAAEJ;YAAe,CAAC;QACxD;QACA,MAAMe,OAAOV,OAAOU,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASX,OAAOW,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,+CAA+C,EAAElC,KAAK,aAAa,EAAEgC,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QAC/I,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;QAC9E;QAEA,OAAO;YACLP,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMM;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DzB,OAAOsB,KAAK,CAAC,CAAC,6BAA6B,EAAEpC,KAAK,EAAE,EAAEqC,cAAc;QACpE,OAAO;YACLX,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAE5B,KAAK,GAAG,EAAEqC,cAAc;gBAC5E;aACD;QACH;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"duplicateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/duplicateTool.ts"],"names":[],"mappings":"AAkBA,eAAO,MAAM,qBAAqB,4CAoHhC,CAAA"}
1
+ {"version":3,"file":"duplicateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/duplicateTool.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,qBAAqB,4CAkEhC,CAAA"}
@@ -1,14 +1,11 @@
1
- import { z } from 'zod';
1
+ import { duplicateDocumentInputSchema, getCollectionVirtualFieldNames, parseDocumentID, stripVirtualFields, transformPointDataToPayload, 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 { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
8
- import { formatCollectionError } from './formatCollectionError.js';
5
+ import { formatEntityError } from '../formatEntityError.js';
9
6
  const DEFAULT_DESCRIPTION = 'Duplicate a document in any collection by passing the collection slug and source document ID.';
10
7
  export const duplicateDocumentTool = defineCollectionTool({
11
- access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
8
+ access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.create),
12
9
  annotations: {
13
10
  destructiveHint: false,
14
11
  idempotentHint: false,
@@ -17,77 +14,73 @@ export const duplicateDocumentTool = defineCollectionTool({
17
14
  title: 'Duplicate Document'
18
15
  },
19
16
  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 })=>{
17
+ input: duplicateDocumentInputSchema
18
+ }).handler(async ({ slug, authorizedMCP, input, req })=>{
36
19
  const payload = req.payload;
37
20
  const logger = getLogger({
38
21
  payload
39
22
  });
40
- const { id, data, depth, draft, fallbackLocale, locale, populate, select, selectedLocales, showHiddenFields } = input;
41
- logger.info(`Duplicating document in collection: ${collectionSlug} with ID: ${id}`);
23
+ const { id, data, depth, draft, fallbackLocale, locale, populate, select, selectedLocales } = input;
24
+ logger.info(`Duplicating document in collection: ${slug} with ID: ${id}`);
42
25
  try {
43
- const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
26
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug);
44
27
  const inputData = data ? stripVirtualFields(data, virtualFieldNames) : undefined;
28
+ if (inputData) {
29
+ validateCollectionData({
30
+ slug,
31
+ data: inputData,
32
+ partial: true,
33
+ req
34
+ });
35
+ }
45
36
  const parsedData = inputData ? transformPointDataToPayload(inputData) : undefined;
46
37
  const result = await payload.duplicate({
47
- id,
48
- collection: collectionSlug,
38
+ id: parseDocumentID({
39
+ id,
40
+ collectionSlug: slug,
41
+ payload
42
+ }),
43
+ collection: slug,
49
44
  depth,
50
45
  draft,
46
+ overrideAccess: authorizedMCP.overrideAccess,
51
47
  req,
52
- ...localAPIDefaults(authorizedMCP),
53
48
  ...parsedData ? {
54
49
  data: parsedData
55
50
  } : {},
56
51
  ...locale ? {
57
52
  locale
58
53
  } : {},
59
- ...fallbackLocale ? {
54
+ ...fallbackLocale !== undefined ? {
60
55
  fallbackLocale
61
56
  } : {},
62
57
  ...populate ? {
63
- populate: populate
58
+ populate
64
59
  } : {},
65
60
  ...select ? {
66
- select: select
61
+ select
67
62
  } : {},
68
63
  ...selectedLocales ? {
69
64
  selectedLocales
70
- } : {},
71
- ...showHiddenFields !== undefined ? {
72
- showHiddenFields
73
65
  } : {}
74
66
  });
75
- logger.info(`Successfully duplicated document in ${collectionSlug} from ID: ${id}`);
67
+ logger.info(`Successfully duplicated document in ${slug} from ID: ${id}`);
76
68
  return {
77
69
  content: [
78
70
  {
79
71
  type: 'text',
80
- text: `Document duplicated successfully in collection "${collectionSlug}"!\nDuplicated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
72
+ text: `Document duplicated successfully in collection "${slug}"!\nDuplicated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
81
73
  }
82
74
  ],
83
75
  doc: result
84
76
  };
85
77
  } catch (error) {
86
78
  const errorMessage = error instanceof Error ? error.message : 'Unknown error';
87
- logger.error(`Error duplicating document in ${collectionSlug}: ${errorMessage}`);
88
- return formatCollectionError({
79
+ logger.error(`Error duplicating document in ${slug}: ${errorMessage}`);
80
+ return formatEntityError({
81
+ slug,
89
82
  action: 'duplicating',
90
- collectionSlug,
83
+ entity: 'collection',
91
84
  error,
92
85
  req
93
86
  });