@payloadcms/plugin-mcp 4.0.0-internal.3aa3d85 → 4.0.0-internal.3ed7230

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 (180) 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.map +1 -1
  6. package/dist/endpoint/access.js +2 -2
  7. package/dist/endpoint/access.js.map +1 -1
  8. package/dist/mcp/buildMcpServer.d.ts +1 -1
  9. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  10. package/dist/mcp/buildMcpServer.js +35 -23
  11. package/dist/mcp/buildMcpServer.js.map +1 -1
  12. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  13. package/dist/mcp/builtin/collections/authTools.js +79 -56
  14. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  15. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  16. package/dist/mcp/builtin/collections/countTool.js +9 -14
  17. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  18. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  19. package/dist/mcp/builtin/collections/countVersionsTool.js +9 -13
  20. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  21. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  22. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  23. package/dist/mcp/builtin/collections/createTool.js +104 -53
  24. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  25. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  26. package/dist/mcp/builtin/collections/deleteTool.js +44 -43
  27. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  28. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  29. package/dist/mcp/builtin/collections/duplicateTool.js +31 -37
  30. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  31. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  32. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  33. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  34. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  35. package/dist/mcp/builtin/collections/fileInput.spec.js +86 -0
  36. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  37. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  38. package/dist/mcp/builtin/collections/findDistinctTool.js +11 -26
  39. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  40. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  41. package/dist/mcp/builtin/collections/findTool.js +27 -45
  42. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  43. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  44. package/dist/mcp/builtin/collections/findVersionByIDTool.js +17 -26
  45. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  46. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  47. package/dist/mcp/builtin/collections/findVersionsTool.js +16 -30
  48. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  49. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  50. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +34 -12
  51. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  52. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  53. package/dist/mcp/builtin/collections/restoreVersionTool.js +14 -26
  54. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  55. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  56. package/dist/mcp/builtin/collections/updateTool.js +65 -84
  57. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  58. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  59. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  60. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  61. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  62. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  63. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  64. package/dist/mcp/builtin/formatEntityError.js +55 -0
  65. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  66. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  67. package/dist/mcp/builtin/getConfigInfoTool.js +3 -2
  68. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  69. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  70. package/dist/mcp/builtin/globals/countVersionsTool.js +9 -13
  71. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  72. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  73. package/dist/mcp/builtin/globals/findTool.js +10 -16
  74. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  75. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  76. package/dist/mcp/builtin/globals/findVersionByIDTool.js +13 -24
  77. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  78. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  79. package/dist/mcp/builtin/globals/findVersionsTool.js +13 -29
  80. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  81. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  82. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +11 -11
  83. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  84. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  85. package/dist/mcp/builtin/globals/restoreVersionTool.js +15 -22
  86. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  87. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  88. package/dist/mcp/builtin/globals/updateTool.js +27 -36
  89. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  90. package/dist/mcp/builtinTools.d.ts +6 -0
  91. package/dist/mcp/builtinTools.d.ts.map +1 -1
  92. package/dist/mcp/builtinTools.js +9 -3
  93. package/dist/mcp/builtinTools.js.map +1 -1
  94. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  95. package/dist/mcp/sanitizeMCPConfig.js +4 -1
  96. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  97. package/dist/stdio.d.ts.map +1 -1
  98. package/dist/stdio.js +2 -1
  99. package/dist/stdio.js.map +1 -1
  100. package/dist/types.d.ts +4 -4
  101. package/dist/types.d.ts.map +1 -1
  102. package/dist/types.js.map +1 -1
  103. package/dist/utils/camelCase.d.ts.map +1 -1
  104. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  105. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  106. package/package.json +5 -7
  107. package/src/endpoint/access.ts +2 -3
  108. package/src/mcp/buildMcpServer.ts +39 -29
  109. package/src/mcp/builtin/collections/authTools.ts +77 -69
  110. package/src/mcp/builtin/collections/countTool.ts +9 -21
  111. package/src/mcp/builtin/collections/countVersionsTool.ts +9 -18
  112. package/src/mcp/builtin/collections/createTool.ts +110 -76
  113. package/src/mcp/builtin/collections/deleteTool.ts +36 -64
  114. package/src/mcp/builtin/collections/duplicateTool.ts +35 -85
  115. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  116. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  117. package/src/mcp/builtin/collections/findDistinctTool.ts +11 -63
  118. package/src/mcp/builtin/collections/findTool.ts +23 -105
  119. package/src/mcp/builtin/collections/findVersionByIDTool.ts +15 -58
  120. package/src/mcp/builtin/collections/findVersionsTool.ts +14 -85
  121. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +27 -10
  122. package/src/mcp/builtin/collections/restoreVersionTool.ts +14 -56
  123. package/src/mcp/builtin/collections/updateTool.ts +61 -98
  124. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  125. package/src/mcp/builtin/formatEntityError.ts +77 -0
  126. package/src/mcp/builtin/getConfigInfoTool.ts +2 -1
  127. package/src/mcp/builtin/globals/countVersionsTool.ts +9 -17
  128. package/src/mcp/builtin/globals/findTool.ts +12 -51
  129. package/src/mcp/builtin/globals/findVersionByIDTool.ts +13 -52
  130. package/src/mcp/builtin/globals/findVersionsTool.ts +14 -92
  131. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +10 -10
  132. package/src/mcp/builtin/globals/restoreVersionTool.ts +14 -45
  133. package/src/mcp/builtin/globals/updateTool.ts +37 -60
  134. package/src/mcp/builtinTools.ts +9 -2
  135. package/src/mcp/sanitizeMCPConfig.ts +4 -1
  136. package/src/stdio.ts +2 -1
  137. package/src/types.ts +4 -4
  138. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +0 -9
  139. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +0 -1
  140. package/dist/mcp/builtin/collections/formatCollectionError.js +0 -60
  141. package/dist/mcp/builtin/collections/formatCollectionError.js.map +0 -1
  142. package/dist/mcp/builtin/validateEntityData.d.ts +0 -14
  143. package/dist/mcp/builtin/validateEntityData.d.ts.map +0 -1
  144. package/dist/mcp/builtin/validateEntityData.js +0 -82
  145. package/dist/mcp/builtin/validateEntityData.js.map +0 -1
  146. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  147. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  148. package/dist/utils/getVirtualFieldNames.js +0 -35
  149. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  150. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +0 -28
  151. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +0 -1
  152. package/dist/utils/schemaConversion/filterFieldsByAccess.js +0 -71
  153. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +0 -1
  154. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -13
  155. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  156. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -66
  157. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  158. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -10
  159. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  160. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -384
  161. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  162. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -133
  163. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  164. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  165. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  166. package/dist/utils/transformPointDataToPayload.js +0 -28
  167. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  168. package/dist/utils/whereSchema.d.ts +0 -9
  169. package/dist/utils/whereSchema.d.ts.map +0 -1
  170. package/dist/utils/whereSchema.js +0 -13
  171. package/dist/utils/whereSchema.js.map +0 -1
  172. package/src/mcp/builtin/collections/formatCollectionError.ts +0 -84
  173. package/src/mcp/builtin/validateEntityData.ts +0 -132
  174. package/src/utils/getVirtualFieldNames.ts +0 -53
  175. package/src/utils/schemaConversion/filterFieldsByAccess.ts +0 -123
  176. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -96
  177. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -96
  178. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -432
  179. package/src/utils/transformPointDataToPayload.ts +0 -40
  180. package/src/utils/whereSchema.ts +0 -24
@@ -1,19 +1,15 @@
1
- import type { PopulateType, SelectType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { findVersionsInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
7
5
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { whereSchema } from '../../../utils/whereSchema.js'
9
6
 
10
7
  const DEFAULT_DESCRIPTION =
11
8
  'Find document versions in any version-enabled collection by passing the collection slug and optional where clause.'
12
9
 
13
10
  export const findVersionsTool = defineCollectionTool({
14
11
  access: (args) =>
15
- defaultAccess(args) &&
16
- Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.readVersions),
17
13
  annotations: {
18
14
  destructiveHint: false,
19
15
  idempotentHint: true,
@@ -22,79 +18,13 @@ export const findVersionsTool = defineCollectionTool({
22
18
  title: 'Find Versions',
23
19
  },
24
20
  description: DEFAULT_DESCRIPTION,
25
- input: z.object({
26
- depth: z
27
- .number()
28
- .int()
29
- .min(0)
30
- .max(10)
31
- .describe('How many levels deep to populate relationships in version documents')
32
- .optional()
33
- .default(0),
34
- fallbackLocale: z
35
- .string()
36
- .describe('Optional: fallback locale code to use when requested locale is not available')
37
- .optional(),
38
- limit: z
39
- .number()
40
- .int()
41
- .min(1)
42
- .max(100)
43
- .describe('Maximum number of versions to return (default: 10, max: 100)')
44
- .optional()
45
- .default(10),
46
- locale: z
47
- .string()
48
- .describe(
49
- 'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
50
- )
51
- .optional(),
52
- page: z
53
- .number()
54
- .int()
55
- .min(1)
56
- .describe('Page number for pagination (default: 1)')
57
- .optional()
58
- .default(1),
59
- pagination: z
60
- .boolean()
61
- .describe('Optional: set to false to skip the count query overhead')
62
- .optional(),
63
- populate: z
64
- .record(z.string(), z.unknown())
65
- .describe(
66
- 'Optional: control which fields to include from populated relationship or upload documents.',
67
- )
68
- .optional(),
69
- select: z
70
- .record(z.string(), z.unknown())
71
- .describe(
72
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"version.title": true}',
73
- )
74
- .optional(),
75
- showHiddenFields: z
76
- .boolean()
77
- .describe('Optional: include hidden fields in returned version documents')
78
- .optional(),
79
- sort: z
80
- .string()
81
- .describe('Field to sort by (e.g., "-updatedAt", "-version.updatedAt" for descending)')
82
- .optional(),
83
- trash: z
84
- .boolean()
85
- .describe('Optional: include versions for soft-deleted documents when trash is enabled')
86
- .optional(),
87
- where: whereSchema
88
- .describe(
89
- 'Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.title":{"contains":"test"}}',
90
- )
91
- .optional(),
92
- }),
93
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: findVersionsInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
94
23
  const payload = req.payload
95
24
  const logger = getLogger({ payload })
96
25
  const {
97
26
  depth,
27
+ draft,
98
28
  fallbackLocale,
99
29
  limit,
100
30
  locale,
@@ -102,28 +32,27 @@ export const findVersionsTool = defineCollectionTool({
102
32
  pagination,
103
33
  populate,
104
34
  select,
105
- showHiddenFields,
106
35
  sort,
107
36
  trash,
108
37
  where,
109
38
  } = input
110
39
 
111
- logger.info(`Finding versions in collection: ${collectionSlug}, limit: ${limit}, page: ${page}`)
40
+ logger.info(`Finding versions in collection: ${slug}, limit: ${limit}, page: ${page}`)
112
41
 
113
42
  try {
114
43
  const result = await payload.findVersions({
115
- collection: collectionSlug,
44
+ collection: slug,
116
45
  depth,
117
46
  limit,
118
47
  overrideAccess: authorizedMCP.overrideAccess,
119
48
  page,
120
49
  req,
121
- ...(fallbackLocale ? { fallbackLocale } : {}),
50
+ ...(draft !== undefined ? { draft } : {}),
51
+ ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
122
52
  ...(locale ? { locale } : {}),
123
53
  ...(pagination !== undefined ? { pagination } : {}),
124
- ...(populate ? { populate: populate as PopulateType } : {}),
125
- ...(select ? { select: select as SelectType } : {}),
126
- ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
54
+ ...(populate ? { populate } : {}),
55
+ ...(select ? { select } : {}),
127
56
  ...(sort ? { sort } : {}),
128
57
  ...(trash !== undefined ? { trash } : {}),
129
58
  ...(where ? { where } : {}),
@@ -133,19 +62,19 @@ export const findVersionsTool = defineCollectionTool({
133
62
  content: [
134
63
  {
135
64
  type: 'text',
136
- text: `Versions for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
65
+ text: `Versions for collection "${slug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
137
66
  },
138
67
  ],
139
68
  doc: result as unknown as Record<string, unknown>,
140
69
  }
141
70
  } catch (error) {
142
71
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
143
- logger.error(`Error finding versions in ${collectionSlug}: ${errorMessage}`)
72
+ logger.error(`Error finding versions in ${slug}: ${errorMessage}`)
144
73
  return {
145
74
  content: [
146
75
  {
147
76
  type: 'text',
148
- text: `❌ **Error finding versions in collection "${collectionSlug}":** ${errorMessage}`,
77
+ text: `❌ **Error finding versions in collection "${slug}":** ${errorMessage}`,
149
78
  },
150
79
  ],
151
80
  isError: true,
@@ -1,12 +1,11 @@
1
- import { getAccessResults } from 'payload'
1
+ import { getAccessResults, getCollectionInputSchema, getCollectionSchemaInputSchema } from 'payload'
2
2
 
3
3
  import { defaultAccess } from '../../../defaultAccess.js'
4
4
  import { defineCollectionTool } from '../../../defineTool.js'
5
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
6
5
 
7
6
  export const getCollectionSchemaTool = defineCollectionTool({
8
7
  access: (args) => {
9
- const permissions = args.permissions?.collections?.[args.collectionSlug]
8
+ const permissions = args.permissions?.collections?.[args.slug]
10
9
 
11
10
  return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)
12
11
  },
@@ -18,17 +17,18 @@ export const getCollectionSchemaTool = defineCollectionTool({
18
17
  title: 'Get Collection Schema',
19
18
  },
20
19
  description: 'Get the input schema for creating or updating documents in a collection.',
21
- }).handler(async ({ authorizedMCP, collectionSlug, req }) => {
20
+ input: getCollectionSchemaInputSchema,
21
+ }).handler(async ({ slug, authorizedMCP, req }) => {
22
22
  const permissions = authorizedMCP.overrideAccess
23
23
  ? null
24
- : (await getAccessResults({ req })).collections?.[collectionSlug]
24
+ : (await getAccessResults({ req })).collections?.[slug]
25
25
 
26
26
  if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {
27
27
  return {
28
28
  content: [
29
29
  {
30
30
  type: 'text',
31
- text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${collectionSlug}"`,
31
+ text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${slug}"`,
32
32
  },
33
33
  ],
34
34
  isError: true,
@@ -36,28 +36,45 @@ export const getCollectionSchemaTool = defineCollectionTool({
36
36
  }
37
37
 
38
38
  const inputSchema = getCollectionInputSchema({
39
- collectionSlug,
39
+ collectionSlug: slug,
40
40
  req,
41
41
  ...(permissions ? { permissions } : {}),
42
42
  })
43
43
 
44
44
  if (!inputSchema) {
45
45
  return {
46
- content: [{ type: 'text', text: `Error: Collection "${collectionSlug}" not found` }],
46
+ content: [{ type: 'text', text: `Error: Collection "${slug}" not found` }],
47
47
  isError: true,
48
48
  }
49
49
  }
50
50
 
51
+ const uploadConfig = req.payload.collections[slug]?.config.upload
52
+ const maxFileSize = req.payload.config.upload.limits?.fileSize
53
+ const upload = uploadConfig
54
+ ? {
55
+ enabled: true,
56
+ filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,
57
+ mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],
58
+ sources: [
59
+ ...(uploadConfig.pasteURL !== false ? ['externalURL'] : []),
60
+ 'base64',
61
+ 'uploadReference',
62
+ ],
63
+ ...(typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? { maxFileSize } : {}),
64
+ }
65
+ : { enabled: false }
66
+
51
67
  return {
52
68
  content: [
53
69
  {
54
70
  type: 'text',
55
- text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``,
71
+ text: `Schema for collection "${slug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``,
56
72
  },
57
73
  ],
58
74
  structuredContent: {
59
- collectionSlug,
75
+ slug,
60
76
  schema: inputSchema,
77
+ upload,
61
78
  },
62
79
  }
63
80
  })
@@ -1,6 +1,4 @@
1
- import type { PopulateType, SelectType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { restoreVersionInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
@@ -11,7 +9,7 @@ const DEFAULT_DESCRIPTION =
11
9
 
12
10
  export const restoreVersionTool = defineCollectionTool({
13
11
  access: (args) =>
14
- defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
15
13
  annotations: {
16
14
  destructiveHint: true,
17
15
  idempotentHint: false,
@@ -20,85 +18,45 @@ export const restoreVersionTool = defineCollectionTool({
20
18
  title: 'Restore Version',
21
19
  },
22
20
  description: DEFAULT_DESCRIPTION,
23
- input: z.object({
24
- id: z.string().describe('The ID of the version to restore'),
25
- depth: z
26
- .number()
27
- .int()
28
- .min(0)
29
- .max(10)
30
- .describe('How many levels deep to populate relationships in response')
31
- .optional()
32
- .default(0),
33
- draft: z
34
- .boolean()
35
- .describe('Whether to restore the version as a draft')
36
- .optional()
37
- .default(false),
38
- fallbackLocale: z
39
- .string()
40
- .describe('Optional: fallback locale code to use when requested locale is not available')
41
- .optional(),
42
- locale: z
43
- .string()
44
- .describe('Optional: locale code to restore in (e.g., "en", "es")')
45
- .optional(),
46
- populate: z
47
- .record(z.string(), z.unknown())
48
- .describe(
49
- 'Optional: control which fields to include from populated relationship or upload documents.',
50
- )
51
- .optional(),
52
- select: z
53
- .record(z.string(), z.unknown())
54
- .describe(
55
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}',
56
- )
57
- .optional(),
58
- showHiddenFields: z
59
- .boolean()
60
- .describe('Optional: include hidden fields in the restored document response')
61
- .optional(),
62
- }),
63
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: restoreVersionInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
64
23
  const payload = req.payload
65
24
  const logger = getLogger({ payload })
66
- const { id, depth, draft, fallbackLocale, locale, populate, select, showHiddenFields } = input
25
+ const { id, depth, draft, fallbackLocale, locale, populate, select } = input
67
26
 
68
- logger.info(`Restoring version in collection: ${collectionSlug} with ID: ${id}`)
27
+ logger.info(`Restoring version in collection: ${slug} with ID: ${id}`)
69
28
 
70
29
  try {
71
30
  const result = await payload.restoreVersion({
72
- id,
73
- collection: collectionSlug,
31
+ id: String(id),
32
+ collection: slug,
74
33
  depth,
75
34
  draft,
76
35
  overrideAccess: authorizedMCP.overrideAccess,
77
36
  req,
78
- ...(fallbackLocale ? { fallbackLocale } : {}),
37
+ ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
79
38
  ...(locale ? { locale } : {}),
80
- ...(populate ? { populate: populate as PopulateType } : {}),
81
- ...(select ? { select: select as SelectType } : {}),
82
- ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
39
+ ...(populate ? { populate } : {}),
40
+ ...(select ? { select } : {}),
83
41
  })
84
42
 
85
43
  return {
86
44
  content: [
87
45
  {
88
46
  type: 'text',
89
- text: `Version "${id}" restored successfully in collection "${collectionSlug}"!\nRestored document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
47
+ text: `Version "${id}" restored successfully in collection "${slug}"!\nRestored document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
90
48
  },
91
49
  ],
92
50
  doc: result as Record<string, unknown>,
93
51
  }
94
52
  } catch (error) {
95
53
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
96
- logger.error(`Error restoring version ${id} in ${collectionSlug}: ${errorMessage}`)
54
+ logger.error(`Error restoring version ${id} in ${slug}: ${errorMessage}`)
97
55
  return {
98
56
  content: [
99
57
  {
100
58
  type: 'text',
101
- text: `❌ **Error restoring version "${id}" in collection "${collectionSlug}":** ${errorMessage}`,
59
+ text: `❌ **Error restoring version "${id}" in collection "${slug}":** ${errorMessage}`,
102
60
  },
103
61
  ],
104
62
  isError: true,
@@ -1,26 +1,27 @@
1
- import type { SelectType, Where } from 'payload'
1
+ import type { Where } from 'payload'
2
2
 
3
- import { z } from 'zod'
3
+ import {
4
+ getCollectionInputSchema,
5
+ getCollectionVirtualFieldNames,
6
+ parseDocumentID,
7
+ stripVirtualFields,
8
+ transformPointDataToPayload,
9
+ updateDocumentInputSchema,
10
+ validateCollectionData,
11
+ } from 'payload'
4
12
 
5
13
  import { defaultAccess } from '../../../defaultAccess.js'
6
14
  import { defineCollectionTool } from '../../../defineTool.js'
7
15
  import { getLogger } from '../../../utils/getLogger.js'
8
- import {
9
- getCollectionVirtualFieldNames,
10
- stripVirtualFields,
11
- } from '../../../utils/getVirtualFieldNames.js'
12
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
13
- import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
14
- import { whereSchema } from '../../../utils/whereSchema.js'
15
- import { validateCollectionData } from '../validateEntityData.js'
16
- import { formatCollectionError } from './formatCollectionError.js'
16
+ import { formatEntityError } from '../formatEntityError.js'
17
+ import { fileInputSchema, resolveFile } from './fileInput.js'
17
18
 
18
19
  const DEFAULT_DESCRIPTION =
19
- 'Update documents in any collection by passing the collection slug and data.'
20
+ 'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'
20
21
 
21
22
  export const updateDocumentTool = defineCollectionTool({
22
23
  access: (args) =>
23
- defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
24
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.update),
24
25
  annotations: {
25
26
  destructiveHint: true,
26
27
  idempotentHint: false,
@@ -29,53 +30,8 @@ export const updateDocumentTool = defineCollectionTool({
29
30
  title: 'Update Document',
30
31
  },
31
32
  description: DEFAULT_DESCRIPTION,
32
- input: z.object({
33
- id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),
34
- data: z.record(z.string(), z.unknown()).describe('The fields to update'),
35
- depth: z
36
- .number()
37
- .describe('How many levels deep to populate relationships')
38
- .optional()
39
- .default(0),
40
- draft: z
41
- .boolean()
42
- .describe('Whether to update the document as a draft')
43
- .optional()
44
- .default(false),
45
- fallbackLocale: z
46
- .string()
47
- .describe('Optional: fallback locale code to use when requested locale is not available')
48
- .optional(),
49
- filePath: z.string().describe('File path for file uploads').optional(),
50
- locale: z
51
- .string()
52
- .describe(
53
- 'Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale',
54
- )
55
- .optional(),
56
- overrideLock: z
57
- .boolean()
58
- .describe('Whether to override document locks')
59
- .optional()
60
- .default(true),
61
- overwriteExistingFiles: z
62
- .boolean()
63
- .describe('Whether to overwrite existing files')
64
- .optional()
65
- .default(false),
66
- select: z
67
- .record(z.string(), z.unknown())
68
- .describe(
69
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}',
70
- )
71
- .optional(),
72
- where: whereSchema
73
- .describe(
74
- 'Where clause to update multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
75
- )
76
- .optional(),
77
- }),
78
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
33
+ input: updateDocumentInputSchema({ file: fileInputSchema }),
34
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
79
35
  const payload = req.payload
80
36
  const logger = getLogger({ payload })
81
37
 
@@ -85,97 +41,104 @@ export const updateDocumentTool = defineCollectionTool({
85
41
  depth,
86
42
  draft,
87
43
  fallbackLocale,
88
- filePath,
44
+ file: fileInput,
45
+ limit,
89
46
  locale,
90
47
  overrideLock,
91
- overwriteExistingFiles,
48
+ populate,
49
+ publishAllLocales,
50
+ returning,
92
51
  select,
52
+ sort,
53
+ trash,
54
+ unpublishAllLocales,
93
55
  where,
94
56
  } = input
95
57
 
96
58
  logger.info(
97
- `Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,
59
+ `Updating document in collection: ${slug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,
98
60
  )
99
61
 
100
62
  try {
101
- if (!id && !where) {
102
- return {
103
- content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],
104
- }
105
- }
106
-
107
- const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)
63
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)
108
64
  const inputData = stripVirtualFields(data, virtualFieldNames)
109
- const validationError = validateCollectionData({
110
- collectionSlug,
65
+ validateCollectionData({
66
+ slug,
111
67
  data: inputData,
112
68
  partial: true,
113
69
  req,
114
70
  })
115
71
 
116
- if (validationError) {
117
- return validationError
118
- }
119
-
120
72
  const parsedData = transformPointDataToPayload(inputData)
73
+ const file = await resolveFile({ slug, input: fileInput, req })
121
74
 
122
75
  const whereClause: Where = where ?? {}
123
76
 
124
- if (id) {
77
+ if (id !== undefined) {
125
78
  const result = await payload.update({
126
- id,
127
- collection: collectionSlug,
79
+ id: parseDocumentID({ id, collectionSlug: slug, payload }),
80
+ collection: slug,
128
81
  data: parsedData,
129
82
  depth,
130
83
  draft,
84
+ fallbackLocale,
85
+ locale,
131
86
  overrideAccess: authorizedMCP.overrideAccess,
132
87
  overrideLock,
88
+ populate,
89
+ publishAllLocales,
133
90
  req,
134
- ...(filePath ? { filePath } : {}),
135
- ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
136
- ...(locale ? { locale } : {}),
137
- ...(fallbackLocale ? { fallbackLocale } : {}),
138
- ...(select ? { select: select as SelectType } : {}),
91
+ select: returning ? select : { id: true },
92
+ trash,
93
+ unpublishAllLocales,
94
+ ...(file ? { file } : {}),
139
95
  })
140
96
 
97
+ const responseResult = returning ? result : { id: result.id }
98
+
141
99
  return {
142
100
  content: [
143
101
  {
144
102
  type: 'text',
145
- text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
103
+ text: `Document updated successfully in collection "${slug}"!\nResult:\n\`\`\`json\n${JSON.stringify(responseResult)}\n\`\`\``,
146
104
  },
147
105
  ],
148
- doc: result as Record<string, unknown>,
106
+ doc: responseResult as Record<string, unknown>,
149
107
  }
150
108
  }
151
109
 
152
110
  const result = await payload.update({
153
- collection: collectionSlug,
111
+ collection: slug,
154
112
  data: parsedData,
155
113
  depth,
156
114
  draft,
115
+ fallbackLocale,
116
+ limit,
117
+ locale,
157
118
  overrideAccess: authorizedMCP.overrideAccess,
158
119
  overrideLock,
120
+ populate,
121
+ publishAllLocales,
159
122
  req,
123
+ select: returning ? select : { id: true },
124
+ sort,
125
+ trash,
126
+ unpublishAllLocales,
160
127
  where: whereClause,
161
- ...(filePath ? { filePath } : {}),
162
- ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
163
- ...(locale ? { locale } : {}),
164
- ...(fallbackLocale ? { fallbackLocale } : {}),
165
- ...(select ? { select: select as SelectType } : {}),
128
+ ...(file ? { file } : {}),
166
129
  })
167
130
 
168
- const docs = result.docs || []
131
+ const docs = returning ? result.docs : result.docs.map(({ id }) => ({ id }))
169
132
  const errors = result.errors || []
170
133
 
171
- let responseText = `Multiple documents updated in collection "${collectionSlug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`
134
+ let responseText = `Multiple documents updated in collection "${slug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`
172
135
  if (docs.length > 0) {
173
136
  responseText += `\n\nUpdated documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``
174
137
  }
175
138
  if (errors.length > 0) {
176
139
  responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``
177
140
 
178
- const errorSchema = getCollectionInputSchema({ collectionSlug, req })
141
+ const errorSchema = getCollectionInputSchema({ collectionSlug: slug, req })
179
142
 
180
143
  if (errorSchema) {
181
144
  responseText += `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(errorSchema)}\n\`\`\``
@@ -188,7 +151,7 @@ export const updateDocumentTool = defineCollectionTool({
188
151
  ...(errorSchema
189
152
  ? {
190
153
  structuredContent: {
191
- collectionSlug,
154
+ slug,
192
155
  docs,
193
156
  errors,
194
157
  schema: errorSchema,
@@ -204,7 +167,7 @@ export const updateDocumentTool = defineCollectionTool({
204
167
  }
205
168
  } catch (error) {
206
169
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
207
- logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`)
208
- return formatCollectionError({ action: 'updating', collectionSlug, error, req })
170
+ logger.error(`Error updating document in ${slug}: ${errorMessage}`)
171
+ return formatEntityError({ slug, action: 'updating', entity: 'collection', error, req })
209
172
  }
210
173
  })
@@ -0,0 +1,64 @@
1
+ import { strictObject, z } from 'payload'
2
+ import { getUploadInstructions as getPayloadUploadInstructions } from 'payload/internal'
3
+
4
+ import { defaultAccess } from '../../../defaultAccess.js'
5
+ import { defineCollectionTool } from '../../../defineTool.js'
6
+
7
+ export const getUploadInstructionsTool = defineCollectionTool({
8
+ access: (args) =>
9
+ defaultAccess(args) &&
10
+ Boolean(
11
+ args.permissions?.collections?.[args.slug]?.create ||
12
+ args.permissions?.collections?.[args.slug]?.update,
13
+ ),
14
+ annotations: {
15
+ destructiveHint: false,
16
+ idempotentHint: false,
17
+ openWorldHint: true,
18
+ readOnlyHint: false,
19
+ title: 'Get Upload Instructions',
20
+ },
21
+ description:
22
+ 'Prepare uploads for createDocuments or updateDocument. This does not upload bytes; finish the returned action before use.',
23
+ input: strictObject({
24
+ docPrefix: z.optional(z.string()).check(z.describe('Document folder or prefix.')),
25
+ filename: z.string().check(z.describe('The original file name.')),
26
+ filesize: z.int().check(z.nonnegative(), z.describe('The file size in bytes.')),
27
+ mimeType: z.string().check(z.describe('The file MIME type.')),
28
+ }),
29
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
30
+ try {
31
+ const instructions = await getPayloadUploadInstructions({
32
+ ...input,
33
+ collectionSlug: slug,
34
+ overrideAccess: authorizedMCP.overrideAccess,
35
+ req,
36
+ })
37
+
38
+ const nextStep =
39
+ instructions.type === 'http'
40
+ ? 'Upload bytes with instructions.request. After success, pass { source: "uploadReference", file: instructions.file }.'
41
+ : `Call "${instructions.name}" with file and data. After success, pass { source: "uploadReference", file: instructions.file }.`
42
+
43
+ return {
44
+ content: [
45
+ {
46
+ type: 'text',
47
+ text: `Upload instructions for collection "${slug}":\n\`\`\`json\n${JSON.stringify(instructions)}\n\`\`\`\n${nextStep}`,
48
+ },
49
+ ],
50
+ structuredContent: { instructions },
51
+ }
52
+ } catch (error) {
53
+ const message = error instanceof Error ? error.message : 'Unknown error'
54
+ return {
55
+ content: [
56
+ {
57
+ type: 'text',
58
+ text: `Error getting upload instructions for collection "${slug}": ${message}`,
59
+ },
60
+ ],
61
+ isError: true,
62
+ }
63
+ }
64
+ })