@payloadcms/plugin-mcp 4.0.0-internal.45cfa3d → 4.0.0-internal.4a8e202

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 (147) 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 +4 -11
  8. package/dist/endpoint/access.js.map +1 -1
  9. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  10. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  11. package/dist/mcp/builtin/collections/countTool.js +1 -2
  12. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  13. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  14. package/dist/mcp/builtin/collections/countVersionsTool.js +1 -2
  15. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  16. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  17. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  18. package/dist/mcp/builtin/collections/createTool.js +91 -40
  19. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  20. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  21. package/dist/mcp/builtin/collections/deleteTool.js +1 -2
  22. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  23. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  24. package/dist/mcp/builtin/collections/duplicateTool.js +1 -2
  25. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  26. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  27. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  28. package/dist/mcp/builtin/collections/fileInput.js +124 -0
  29. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  30. package/dist/mcp/builtin/collections/fileInput.spec.js +86 -0
  31. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  32. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  33. package/dist/mcp/builtin/collections/findDistinctTool.js +1 -2
  34. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  35. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  36. package/dist/mcp/builtin/collections/findTool.js +3 -4
  37. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  38. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  39. package/dist/mcp/builtin/collections/findVersionByIDTool.js +1 -2
  40. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  41. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  42. package/dist/mcp/builtin/collections/findVersionsTool.js +1 -2
  43. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  44. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +1 -1
  45. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -1
  46. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  47. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +45 -5
  48. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  49. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  50. package/dist/mcp/builtin/collections/restoreVersionTool.js +1 -2
  51. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  52. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  53. package/dist/mcp/builtin/collections/updateTool.js +24 -12
  54. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  55. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  56. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  57. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  58. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  59. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  60. package/dist/mcp/builtin/getConfigInfoTool.js +2 -5
  61. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  62. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  63. package/dist/mcp/builtin/globals/countVersionsTool.js +1 -2
  64. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  65. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  66. package/dist/mcp/builtin/globals/findTool.js +2 -2
  67. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  68. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  69. package/dist/mcp/builtin/globals/findVersionByIDTool.js +1 -2
  70. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  71. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  72. package/dist/mcp/builtin/globals/findVersionsTool.js +1 -2
  73. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  74. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  75. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +21 -3
  76. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  77. package/dist/mcp/builtin/globals/restoreVersionTool.js +1 -2
  78. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  79. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  80. package/dist/mcp/builtin/globals/updateTool.js +2 -2
  81. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  82. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -1
  83. package/dist/mcp/builtinTools.d.ts +6 -0
  84. package/dist/mcp/builtinTools.d.ts.map +1 -1
  85. package/dist/mcp/builtinTools.js +9 -3
  86. package/dist/mcp/builtinTools.js.map +1 -1
  87. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  88. package/dist/mcp/sanitizeMCPConfig.js +4 -1
  89. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  90. package/dist/stdio.d.ts.map +1 -1
  91. package/dist/stdio.js +2 -1
  92. package/dist/stdio.js.map +1 -1
  93. package/dist/types.d.ts +44 -7
  94. package/dist/types.d.ts.map +1 -1
  95. package/dist/types.js +2 -4
  96. package/dist/types.js.map +1 -1
  97. package/dist/utils/camelCase.d.ts.map +1 -1
  98. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  99. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +28 -0
  100. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +1 -0
  101. package/dist/utils/schemaConversion/filterFieldsByAccess.js +71 -0
  102. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +1 -0
  103. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +5 -3
  104. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -1
  105. package/dist/utils/schemaConversion/getEntityInputSchema.js +40 -6
  106. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -1
  107. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -1
  108. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +2 -2
  109. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -1
  110. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  111. package/package.json +4 -4
  112. package/src/endpoint/access.ts +3 -10
  113. package/src/mcp/builtin/collections/countTool.ts +1 -2
  114. package/src/mcp/builtin/collections/countVersionsTool.ts +2 -6
  115. package/src/mcp/builtin/collections/createTool.ts +90 -34
  116. package/src/mcp/builtin/collections/deleteTool.ts +1 -2
  117. package/src/mcp/builtin/collections/duplicateTool.ts +1 -2
  118. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  119. package/src/mcp/builtin/collections/fileInput.ts +164 -0
  120. package/src/mcp/builtin/collections/findDistinctTool.ts +3 -3
  121. package/src/mcp/builtin/collections/findTool.ts +3 -4
  122. package/src/mcp/builtin/collections/findVersionByIDTool.ts +1 -2
  123. package/src/mcp/builtin/collections/findVersionsTool.ts +1 -2
  124. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +43 -9
  125. package/src/mcp/builtin/collections/restoreVersionTool.ts +1 -2
  126. package/src/mcp/builtin/collections/updateTool.ts +26 -10
  127. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  128. package/src/mcp/builtin/getConfigInfoTool.ts +2 -4
  129. package/src/mcp/builtin/globals/countVersionsTool.ts +2 -6
  130. package/src/mcp/builtin/globals/findTool.ts +2 -2
  131. package/src/mcp/builtin/globals/findVersionByIDTool.ts +1 -2
  132. package/src/mcp/builtin/globals/findVersionsTool.ts +1 -2
  133. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +25 -3
  134. package/src/mcp/builtin/globals/restoreVersionTool.ts +3 -3
  135. package/src/mcp/builtin/globals/updateTool.ts +2 -2
  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 +43 -7
  140. package/src/utils/schemaConversion/filterFieldsByAccess.ts +123 -0
  141. package/src/utils/schemaConversion/getEntityInputSchema.ts +47 -13
  142. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +2 -2
  143. package/dist/utils/localAPIDefaults.d.ts +0 -20
  144. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  145. package/dist/utils/localAPIDefaults.js +0 -19
  146. package/dist/utils/localAPIDefaults.js.map +0 -1
  147. package/src/utils/localAPIDefaults.ts +0 -22
@@ -0,0 +1,164 @@
1
+ import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'
2
+
3
+ import { APIError } from 'payload'
4
+ import { getExternalFile, getFileFromUploadInstructions, isURLAllowed } from 'payload/internal'
5
+ import { sanitizeFilename } from 'payload/shared'
6
+ import { z } from 'zod'
7
+
8
+ const mimeTypeSchema = z
9
+ .string()
10
+ .regex(/^[!#$%&'*+.^`|~\w-]+\/[!#$%&'*+.^`|~\w-]+$/, 'MIME type must use the type/subtype format')
11
+
12
+ const uploadFileSchema = z.object({
13
+ filename: z.string(),
14
+ mimeType: z.string(),
15
+ size: z.number().int().nonnegative(),
16
+ uploadReference: z.record(z.string(), z.unknown()),
17
+ })
18
+
19
+ export const fileInputSchema = z
20
+ .discriminatedUnion('source', [
21
+ z.object({
22
+ name: z.string().min(1).describe('The file name, including its extension'),
23
+ data: z.string().describe('The base64-encoded file bytes, without a data URL prefix'),
24
+ mimeType: mimeTypeSchema.describe('The file MIME type, for example image/png'),
25
+ source: z.literal('base64'),
26
+ }),
27
+ z.object({
28
+ name: z.string().min(1).describe('Optional file name override').optional(),
29
+ source: z.literal('externalURL'),
30
+ url: z.url().describe('The http or https URL to download'),
31
+ }),
32
+ z.object({
33
+ file: uploadFileSchema.describe('getUploadInstructions file field post-upload'),
34
+ source: z.literal('uploadReference'),
35
+ }),
36
+ ])
37
+ .describe(
38
+ 'A file for an upload collection. Prefer uploadReference after its upload succeeds; use base64 only for small local files or externalURL for an online file.',
39
+ )
40
+
41
+ type FileInput = z.infer<typeof fileInputSchema>
42
+
43
+ export async function resolveFile({
44
+ collectionSlug,
45
+ input,
46
+ req,
47
+ }: {
48
+ collectionSlug: CollectionSlug
49
+ input?: FileInput
50
+ req: PayloadRequest
51
+ }): Promise<File | undefined> {
52
+ if (!input) {
53
+ return undefined
54
+ }
55
+
56
+ if (input.source === 'uploadReference') {
57
+ try {
58
+ return await getFileFromUploadInstructions({ collectionSlug, file: input.file, req })
59
+ } catch (error) {
60
+ if (error instanceof Error && error.message === 'Staged upload was not found.') {
61
+ throw new APIError(
62
+ 'Staged upload not found. Complete the upload action first, or use base64 for small local files.',
63
+ 400,
64
+ )
65
+ }
66
+ throw error
67
+ }
68
+ }
69
+
70
+ const uploadConfig = req.payload.collections[collectionSlug]?.config.upload
71
+
72
+ if (!uploadConfig) {
73
+ throw new APIError(`Collection "${collectionSlug}" does not support file uploads.`, 400)
74
+ }
75
+
76
+ const maxFileSize = req.payload.config.upload.limits?.fileSize
77
+ let file: File
78
+
79
+ if (input.source === 'base64') {
80
+ const data = decodeBase64({ maxFileSize, value: input.data })
81
+
82
+ file = {
83
+ name: sanitizeFilename(input.name),
84
+ data,
85
+ mimetype: input.mimeType,
86
+ size: data.length,
87
+ }
88
+ } else {
89
+ if (uploadConfig.pasteURL === false) {
90
+ throw new APIError(
91
+ `Uploading files from URLs is disabled for collection "${collectionSlug}".`,
92
+ 400,
93
+ )
94
+ }
95
+
96
+ const url = new URL(input.url)
97
+
98
+ if (!['http:', 'https:'].includes(url.protocol)) {
99
+ throw new APIError('File URLs must use http or https.', 400)
100
+ }
101
+
102
+ if (
103
+ typeof uploadConfig.pasteURL === 'object' &&
104
+ !isURLAllowed(input.url, uploadConfig.pasteURL.allowList)
105
+ ) {
106
+ throw new APIError('The provided file URL is not allowed.', 400)
107
+ }
108
+
109
+ file = await getExternalFile({
110
+ data: {
111
+ filename: sanitizeFilename(input.name || getURLFilename(url)),
112
+ url: input.url,
113
+ } as FileData,
114
+ req,
115
+ uploadConfig: {
116
+ ...uploadConfig,
117
+ externalFileHeaderFilter: uploadConfig.externalFileHeaderFilter ?? (() => ({})),
118
+ },
119
+ })
120
+ file.mimetype = file.mimetype?.split(';')[0] || 'application/octet-stream'
121
+ file.size = file.data.length
122
+ }
123
+
124
+ if (maxFileSize !== undefined && Number.isFinite(maxFileSize) && file.size > maxFileSize) {
125
+ throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)
126
+ }
127
+
128
+ return file
129
+ }
130
+
131
+ function decodeBase64({ maxFileSize, value }: { maxFileSize?: number; value: string }): Buffer {
132
+ const normalized = value.replace(/\s/g, '')
133
+
134
+ if (!/^[a-z0-9+/]*={0,2}$/i.test(normalized) || normalized.length % 4 === 1) {
135
+ throw new APIError('File data must be valid base64.', 400)
136
+ }
137
+
138
+ if (maxFileSize !== undefined && Number.isFinite(maxFileSize)) {
139
+ const paddingLength = normalized.endsWith('==') ? 2 : normalized.endsWith('=') ? 1 : 0
140
+ const decodedSize = Math.floor((normalized.length * 3) / 4) - paddingLength
141
+
142
+ if (decodedSize > maxFileSize) {
143
+ throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)
144
+ }
145
+ }
146
+
147
+ const data = Buffer.from(normalized, 'base64')
148
+
149
+ if (data.toString('base64').replace(/=+$/, '') !== normalized.replace(/=+$/, '')) {
150
+ throw new APIError('File data must be valid base64.', 400)
151
+ }
152
+
153
+ return data
154
+ }
155
+
156
+ function getURLFilename(url: URL): string {
157
+ const pathSegment = url.pathname.split('/').pop() || 'upload'
158
+
159
+ try {
160
+ return decodeURIComponent(pathSegment)
161
+ } catch {
162
+ return pathSegment
163
+ }
164
+ }
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -73,7 +72,8 @@ export const findDistinctTool = defineCollectionTool({
73
72
  }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
74
73
  const payload = req.payload
75
74
  const logger = getLogger({ payload })
76
- const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } = input
75
+ const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } =
76
+ input
77
77
 
78
78
  logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`)
79
79
 
@@ -82,8 +82,8 @@ export const findDistinctTool = defineCollectionTool({
82
82
  collection: collectionSlug,
83
83
  depth,
84
84
  field,
85
+ overrideAccess: authorizedMCP.overrideAccess,
85
86
  req,
86
- ...localAPIDefaults(authorizedMCP),
87
87
  ...(limit ? { limit } : {}),
88
88
  ...(locale ? { locale } : {}),
89
89
  ...(page ? { page } : {}),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -40,7 +39,7 @@ export const findDocumentsTool = defineCollectionTool({
40
39
  draft: z
41
40
  .boolean()
42
41
  .describe(
43
- 'Optional: whether the document should be queried from the versions table/collection or not.',
42
+ 'For versioned collections, true returns the latest draft version when available. False reads the main document.',
44
43
  )
45
44
  .optional(),
46
45
  fallbackLocale: z
@@ -134,8 +133,8 @@ export const findDocumentsTool = defineCollectionTool({
134
133
  id,
135
134
  collection: collectionSlug,
136
135
  depth,
136
+ overrideAccess: authorizedMCP.overrideAccess,
137
137
  req,
138
- ...localAPIDefaults(authorizedMCP),
139
138
  ...(select && { select: select as SelectType }),
140
139
  ...(populate && { populate: populate as PopulateType }),
141
140
  ...(joins !== undefined && { joins: joins as JoinQuery }),
@@ -171,9 +170,9 @@ export const findDocumentsTool = defineCollectionTool({
171
170
  collection: collectionSlug,
172
171
  depth,
173
172
  limit,
173
+ overrideAccess: authorizedMCP.overrideAccess,
174
174
  page,
175
175
  req,
176
- ...localAPIDefaults(authorizedMCP),
177
176
  ...(select && { select: select as SelectType }),
178
177
  ...(populate && { populate: populate as PopulateType }),
179
178
  ...(joins !== undefined && { joins: joins as JoinQuery }),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Find a specific document version in any version-enabled collection by passing the collection slug and version ID.'
@@ -75,8 +74,8 @@ export const findVersionByIDTool = defineCollectionTool({
75
74
  id,
76
75
  collection: collectionSlug,
77
76
  depth,
77
+ overrideAccess: authorizedMCP.overrideAccess,
78
78
  req,
79
- ...localAPIDefaults(authorizedMCP),
80
79
  ...(fallbackLocale ? { fallbackLocale } : {}),
81
80
  ...(locale ? { locale } : {}),
82
81
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -116,9 +115,9 @@ export const findVersionsTool = defineCollectionTool({
116
115
  collection: collectionSlug,
117
116
  depth,
118
117
  limit,
118
+ overrideAccess: authorizedMCP.overrideAccess,
119
119
  page,
120
120
  req,
121
- ...localAPIDefaults(authorizedMCP),
122
121
  ...(fallbackLocale ? { fallbackLocale } : {}),
123
122
  ...(locale ? { locale } : {}),
124
123
  ...(pagination !== undefined ? { pagination } : {}),
@@ -1,3 +1,5 @@
1
+ import { getAccessResults } from 'payload'
2
+
1
3
  import { defaultAccess } from '../../../defaultAccess.js'
2
4
  import { defineCollectionTool } from '../../../defineTool.js'
3
5
  import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
@@ -6,12 +8,7 @@ export const getCollectionSchemaTool = defineCollectionTool({
6
8
  access: (args) => {
7
9
  const permissions = args.permissions?.collections?.[args.collectionSlug]
8
10
 
9
- return (
10
- defaultAccess(args) &&
11
- Boolean(
12
- permissions?.create || permissions?.delete || permissions?.read || permissions?.update,
13
- )
14
- )
11
+ return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)
15
12
  },
16
13
  annotations: {
17
14
  destructiveHint: false,
@@ -21,8 +18,28 @@ export const getCollectionSchemaTool = defineCollectionTool({
21
18
  title: 'Get Collection Schema',
22
19
  },
23
20
  description: 'Get the input schema for creating or updating documents in a collection.',
24
- }).handler(({ collectionSlug, req }) => {
25
- const inputSchema = getCollectionInputSchema({ collectionSlug, req })
21
+ }).handler(async ({ authorizedMCP, collectionSlug, req }) => {
22
+ const permissions = authorizedMCP.overrideAccess
23
+ ? null
24
+ : (await getAccessResults({ req })).collections?.[collectionSlug]
25
+
26
+ if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {
27
+ return {
28
+ content: [
29
+ {
30
+ type: 'text',
31
+ text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${collectionSlug}"`,
32
+ },
33
+ ],
34
+ isError: true,
35
+ }
36
+ }
37
+
38
+ const inputSchema = getCollectionInputSchema({
39
+ collectionSlug,
40
+ req,
41
+ ...(permissions ? { permissions } : {}),
42
+ })
26
43
 
27
44
  if (!inputSchema) {
28
45
  return {
@@ -31,16 +48,33 @@ export const getCollectionSchemaTool = defineCollectionTool({
31
48
  }
32
49
  }
33
50
 
51
+ const uploadConfig = req.payload.collections[collectionSlug]?.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
+
34
67
  return {
35
68
  content: [
36
69
  {
37
70
  type: 'text',
38
- text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``,
71
+ text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``,
39
72
  },
40
73
  ],
41
74
  structuredContent: {
42
75
  collectionSlug,
43
76
  schema: inputSchema,
77
+ upload,
44
78
  },
45
79
  }
46
80
  })
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Restore a document from a previous version in any version-enabled collection.'
@@ -74,8 +73,8 @@ export const restoreVersionTool = defineCollectionTool({
74
73
  collection: collectionSlug,
75
74
  depth,
76
75
  draft,
76
+ overrideAccess: authorizedMCP.overrideAccess,
77
77
  req,
78
- ...localAPIDefaults(authorizedMCP),
79
78
  ...(fallbackLocale ? { fallbackLocale } : {}),
80
79
  ...(locale ? { locale } : {}),
81
80
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -9,15 +9,15 @@ import {
9
9
  getCollectionVirtualFieldNames,
10
10
  stripVirtualFields,
11
11
  } from '../../../utils/getVirtualFieldNames.js'
12
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
13
12
  import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
14
13
  import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
15
14
  import { whereSchema } from '../../../utils/whereSchema.js'
16
15
  import { validateCollectionData } from '../validateEntityData.js'
16
+ import { fileInputSchema, resolveFile } from './fileInput.js'
17
17
  import { formatCollectionError } from './formatCollectionError.js'
18
18
 
19
19
  const DEFAULT_DESCRIPTION =
20
- '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.'
21
21
 
22
22
  export const updateDocumentTool = defineCollectionTool({
23
23
  access: (args) =>
@@ -32,7 +32,11 @@ export const updateDocumentTool = defineCollectionTool({
32
32
  description: DEFAULT_DESCRIPTION,
33
33
  input: z.object({
34
34
  id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),
35
- data: z.record(z.string(), z.unknown()).describe('The fields to update'),
35
+ data: z
36
+ .record(z.string(), z.unknown())
37
+ .describe(
38
+ 'The fields to update. Only include fields permitted by the schema returned by getCollectionSchema.',
39
+ ),
36
40
  depth: z
37
41
  .number()
38
42
  .describe('How many levels deep to populate relationships')
@@ -40,14 +44,16 @@ export const updateDocumentTool = defineCollectionTool({
40
44
  .default(0),
41
45
  draft: z
42
46
  .boolean()
43
- .describe('Whether to update the document as a draft')
47
+ .describe(
48
+ 'Only if getCollectionSchema includes _status; otherwise _status does not exist. true saves only a draft version; false updates main and versions. data._status: "published" overrides true.',
49
+ )
44
50
  .optional()
45
51
  .default(false),
46
52
  fallbackLocale: z
47
53
  .string()
48
54
  .describe('Optional: fallback locale code to use when requested locale is not available')
49
55
  .optional(),
50
- filePath: z.string().describe('File path for file uploads').optional(),
56
+ file: fileInputSchema.optional(),
51
57
  locale: z
52
58
  .string()
53
59
  .describe(
@@ -64,6 +70,12 @@ export const updateDocumentTool = defineCollectionTool({
64
70
  .describe('Whether to overwrite existing files')
65
71
  .optional()
66
72
  .default(false),
73
+ publishAllLocales: z
74
+ .boolean()
75
+ .describe(
76
+ 'For collections with localized publishing status, whether publishing should affect every locale. Set false with locale to publish only that locale.',
77
+ )
78
+ .optional(),
67
79
  select: z
68
80
  .record(z.string(), z.unknown())
69
81
  .describe(
@@ -86,10 +98,11 @@ export const updateDocumentTool = defineCollectionTool({
86
98
  depth,
87
99
  draft,
88
100
  fallbackLocale,
89
- filePath,
101
+ file: fileInput,
90
102
  locale,
91
103
  overrideLock,
92
104
  overwriteExistingFiles,
105
+ publishAllLocales,
93
106
  select,
94
107
  where,
95
108
  } = input
@@ -119,6 +132,7 @@ export const updateDocumentTool = defineCollectionTool({
119
132
  }
120
133
 
121
134
  const parsedData = transformPointDataToPayload(inputData)
135
+ const file = await resolveFile({ collectionSlug, input: fileInput, req })
122
136
 
123
137
  const whereClause: Where = where ?? {}
124
138
 
@@ -129,11 +143,12 @@ export const updateDocumentTool = defineCollectionTool({
129
143
  data: parsedData,
130
144
  depth,
131
145
  draft,
146
+ overrideAccess: authorizedMCP.overrideAccess,
132
147
  overrideLock,
133
148
  req,
134
- ...localAPIDefaults(authorizedMCP),
135
- ...(filePath ? { filePath } : {}),
149
+ ...(file ? { file } : {}),
136
150
  ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
151
+ ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
137
152
  ...(locale ? { locale } : {}),
138
153
  ...(fallbackLocale ? { fallbackLocale } : {}),
139
154
  ...(select ? { select: select as SelectType } : {}),
@@ -155,12 +170,13 @@ export const updateDocumentTool = defineCollectionTool({
155
170
  data: parsedData,
156
171
  depth,
157
172
  draft,
173
+ overrideAccess: authorizedMCP.overrideAccess,
158
174
  overrideLock,
159
175
  req,
160
176
  where: whereClause,
161
- ...localAPIDefaults(authorizedMCP),
162
- ...(filePath ? { filePath } : {}),
177
+ ...(file ? { file } : {}),
163
178
  ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
179
+ ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
164
180
  ...(locale ? { locale } : {}),
165
181
  ...(fallbackLocale ? { fallbackLocale } : {}),
166
182
  ...(select ? { select: select as SelectType } : {}),
@@ -0,0 +1,64 @@
1
+ import { getUploadInstructions as getPayloadUploadInstructions } from 'payload/internal'
2
+ import { z } from 'zod'
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.collectionSlug]?.create ||
12
+ args.permissions?.collections?.[args.collectionSlug]?.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: z.object({
24
+ docPrefix: z.string().describe('Optional document folder or prefix').optional(),
25
+ filename: z.string().describe('The original file name'),
26
+ filesize: z.number().int().nonnegative().describe('The file size in bytes'),
27
+ mimeType: z.string().describe('The file MIME type'),
28
+ }),
29
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
30
+ try {
31
+ const instructions = await getPayloadUploadInstructions({
32
+ ...input,
33
+ collectionSlug,
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 "${collectionSlug}":\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 "${collectionSlug}": ${message}`,
59
+ },
60
+ ],
61
+ isError: true,
62
+ }
63
+ }
64
+ })
@@ -12,10 +12,8 @@ export const getConfigInfoTool = defineTool({
12
12
  },
13
13
  description: 'List the Payload collection and global slugs visible to this MCP client.',
14
14
  }).handler(async ({ authorizedMCP, req }) => {
15
- const user = authorizedMCP.user
16
- const permissions = authorizedMCP.overrideAccess
17
- ? null
18
- : await getAccessResults({ req: { ...req, user } })
15
+ const user = req.user
16
+ const permissions = authorizedMCP.overrideAccess ? null : await getAccessResults({ req })
19
17
  const authorizedCollectionSlugs = new Set<string>()
20
18
  const authorizedGlobalSlugs = new Set<string>()
21
19
 
@@ -3,7 +3,6 @@ import { z } from 'zod'
3
3
  import { defaultAccess } from '../../../defaultAccess.js'
4
4
  import { defineGlobalTool } from '../../../defineTool.js'
5
5
  import { getLogger } from '../../../utils/getLogger.js'
6
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
7
6
  import { whereSchema } from '../../../utils/whereSchema.js'
8
7
 
9
8
  const DEFAULT_DESCRIPTION =
@@ -21,10 +20,7 @@ export const countGlobalVersionsTool = defineGlobalTool({
21
20
  },
22
21
  description: DEFAULT_DESCRIPTION,
23
22
  input: z.object({
24
- locale: z
25
- .string()
26
- .describe('Optional: locale code to count versions in')
27
- .optional(),
23
+ locale: z.string().describe('Optional: locale code to count versions in').optional(),
28
24
  where: whereSchema
29
25
  .describe(
30
26
  'Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.siteName":{"contains":"test"}}',
@@ -41,8 +37,8 @@ export const countGlobalVersionsTool = defineGlobalTool({
41
37
  try {
42
38
  const result = await payload.countGlobalVersions({
43
39
  global: globalSlug,
40
+ overrideAccess: authorizedMCP.overrideAccess,
44
41
  req,
45
- ...localAPIDefaults(authorizedMCP),
46
42
  ...(locale ? { locale } : {}),
47
43
  ...(where ? { where } : {}),
48
44
  })
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION = 'Find any Payload global by passing the global slug.'
11
10
 
@@ -66,7 +65,8 @@ export const findGlobalTool = defineGlobalTool({
66
65
  const findOptions: Parameters<typeof payload.findGlobal>[0] = {
67
66
  slug: globalSlug,
68
67
  depth,
69
- ...localAPIDefaults(authorizedMCP),
68
+ overrideAccess: authorizedMCP.overrideAccess,
69
+ req,
70
70
  }
71
71
 
72
72
  if (locale) {
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Find a specific global version in any version-enabled global by passing the global slug and version ID.'
@@ -70,8 +69,8 @@ export const findGlobalVersionByIDTool = defineGlobalTool({
70
69
  id,
71
70
  slug: globalSlug,
72
71
  depth,
72
+ overrideAccess: authorizedMCP.overrideAccess,
73
73
  req,
74
- ...localAPIDefaults(authorizedMCP),
75
74
  ...(fallbackLocale ? { fallbackLocale } : {}),
76
75
  ...(locale ? { locale } : {}),
77
76
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -110,9 +109,9 @@ export const findGlobalVersionsTool = defineGlobalTool({
110
109
  slug: globalSlug,
111
110
  depth,
112
111
  limit,
112
+ overrideAccess: authorizedMCP.overrideAccess,
113
113
  page,
114
114
  req,
115
- ...localAPIDefaults(authorizedMCP),
116
115
  ...(fallbackLocale ? { fallbackLocale } : {}),
117
116
  ...(locale ? { locale } : {}),
118
117
  ...(pagination !== undefined ? { pagination } : {}),