@payloadcms/plugin-mcp 4.0.0-internal.2fddfc0 → 4.0.0-internal.314c594

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 (179) hide show
  1. package/LICENSE.md +1 -1
  2. package/bin.js +7 -0
  3. package/dist/defaultAccess.d.ts.map +1 -1
  4. package/dist/defineTool.d.ts +8 -8
  5. package/dist/defineTool.d.ts.map +1 -1
  6. package/dist/endpoint/access.d.ts +2 -7
  7. package/dist/endpoint/access.d.ts.map +1 -1
  8. package/dist/endpoint/access.js +4 -11
  9. package/dist/endpoint/access.js.map +1 -1
  10. package/dist/endpoint/index.d.ts +1 -1
  11. package/dist/endpoint/index.d.ts.map +1 -1
  12. package/dist/endpoint/index.js +57 -17
  13. package/dist/endpoint/index.js.map +1 -1
  14. package/dist/index.d.ts +2 -2
  15. package/dist/index.d.ts.map +1 -1
  16. package/dist/index.js +2 -2
  17. package/dist/index.js.map +1 -1
  18. package/dist/mcp/buildMcpServer.d.ts +4 -4
  19. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  20. package/dist/mcp/buildMcpServer.js +32 -10
  21. package/dist/mcp/buildMcpServer.js.map +1 -1
  22. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  23. package/dist/mcp/builtin/collections/countTool.js +1 -2
  24. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  25. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  26. package/dist/mcp/builtin/collections/countVersionsTool.js +1 -2
  27. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  28. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  29. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  30. package/dist/mcp/builtin/collections/createTool.js +91 -40
  31. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  32. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  33. package/dist/mcp/builtin/collections/deleteTool.js +1 -2
  34. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  35. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  36. package/dist/mcp/builtin/collections/duplicateTool.js +1 -2
  37. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  38. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  39. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  40. package/dist/mcp/builtin/collections/fileInput.js +124 -0
  41. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  42. package/dist/mcp/builtin/collections/fileInput.spec.js +86 -0
  43. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  44. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/findDistinctTool.js +1 -2
  46. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  47. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  48. package/dist/mcp/builtin/collections/findTool.js +3 -4
  49. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  50. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  51. package/dist/mcp/builtin/collections/findVersionByIDTool.js +1 -2
  52. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  53. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  54. package/dist/mcp/builtin/collections/findVersionsTool.js +1 -2
  55. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  56. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +1 -1
  57. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -1
  58. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  59. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +45 -5
  60. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  61. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  62. package/dist/mcp/builtin/collections/restoreVersionTool.js +1 -2
  63. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  64. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  65. package/dist/mcp/builtin/collections/updateTool.js +24 -12
  66. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  67. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  68. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  69. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  70. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  71. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  72. package/dist/mcp/builtin/getConfigInfoTool.js +2 -5
  73. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  74. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  75. package/dist/mcp/builtin/globals/countVersionsTool.js +1 -2
  76. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  77. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  78. package/dist/mcp/builtin/globals/findTool.js +2 -2
  79. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  80. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  81. package/dist/mcp/builtin/globals/findVersionByIDTool.js +1 -2
  82. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  83. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  84. package/dist/mcp/builtin/globals/findVersionsTool.js +1 -2
  85. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  86. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  87. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +21 -3
  88. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  89. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  90. package/dist/mcp/builtin/globals/restoreVersionTool.js +1 -2
  91. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  92. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  93. package/dist/mcp/builtin/globals/updateTool.js +2 -2
  94. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  95. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -1
  96. package/dist/mcp/builtin/validateEntityData.js +1 -1
  97. package/dist/mcp/builtin/validateEntityData.js.map +1 -1
  98. package/dist/mcp/builtinTools.d.ts +6 -0
  99. package/dist/mcp/builtinTools.d.ts.map +1 -1
  100. package/dist/mcp/builtinTools.js +9 -3
  101. package/dist/mcp/builtinTools.js.map +1 -1
  102. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  103. package/dist/mcp/sanitizeMCPConfig.js +5 -1
  104. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  105. package/dist/stdio.d.ts +3 -4
  106. package/dist/stdio.d.ts.map +1 -1
  107. package/dist/stdio.js +61 -42
  108. package/dist/stdio.js.map +1 -1
  109. package/dist/types.d.ts +57 -9
  110. package/dist/types.d.ts.map +1 -1
  111. package/dist/types.js +2 -4
  112. package/dist/types.js.map +1 -1
  113. package/dist/utils/camelCase.d.ts.map +1 -1
  114. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  115. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +28 -0
  116. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +1 -0
  117. package/dist/utils/schemaConversion/filterFieldsByAccess.js +71 -0
  118. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +1 -0
  119. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +5 -3
  120. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -1
  121. package/dist/utils/schemaConversion/getEntityInputSchema.js +44 -12
  122. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -1
  123. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +5 -10
  124. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -1
  125. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +15 -95
  126. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -1
  127. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +15 -40
  128. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -1
  129. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  130. package/package.json +8 -10
  131. package/src/endpoint/access.ts +3 -10
  132. package/src/endpoint/index.ts +45 -16
  133. package/src/index.ts +4 -4
  134. package/src/mcp/buildMcpServer.ts +40 -20
  135. package/src/mcp/builtin/collections/countTool.ts +1 -2
  136. package/src/mcp/builtin/collections/countVersionsTool.ts +1 -2
  137. package/src/mcp/builtin/collections/createTool.ts +90 -34
  138. package/src/mcp/builtin/collections/deleteTool.ts +1 -2
  139. package/src/mcp/builtin/collections/duplicateTool.ts +1 -2
  140. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  141. package/src/mcp/builtin/collections/fileInput.ts +164 -0
  142. package/src/mcp/builtin/collections/findDistinctTool.ts +1 -2
  143. package/src/mcp/builtin/collections/findTool.ts +3 -4
  144. package/src/mcp/builtin/collections/findVersionByIDTool.ts +1 -2
  145. package/src/mcp/builtin/collections/findVersionsTool.ts +1 -2
  146. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +43 -9
  147. package/src/mcp/builtin/collections/restoreVersionTool.ts +1 -2
  148. package/src/mcp/builtin/collections/updateTool.ts +26 -10
  149. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  150. package/src/mcp/builtin/getConfigInfoTool.ts +2 -4
  151. package/src/mcp/builtin/globals/countVersionsTool.ts +1 -2
  152. package/src/mcp/builtin/globals/findTool.ts +2 -2
  153. package/src/mcp/builtin/globals/findVersionByIDTool.ts +1 -2
  154. package/src/mcp/builtin/globals/findVersionsTool.ts +1 -2
  155. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +25 -3
  156. package/src/mcp/builtin/globals/restoreVersionTool.ts +1 -2
  157. package/src/mcp/builtin/globals/updateTool.ts +2 -2
  158. package/src/mcp/builtin/validateEntityData.ts +1 -1
  159. package/src/mcp/builtinTools.ts +9 -2
  160. package/src/mcp/sanitizeMCPConfig.ts +5 -1
  161. package/src/stdio.ts +61 -43
  162. package/src/types.ts +57 -9
  163. package/src/utils/schemaConversion/filterFieldsByAccess.ts +123 -0
  164. package/src/utils/schemaConversion/getEntityInputSchema.ts +45 -27
  165. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +12 -19
  166. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +17 -114
  167. package/dist/@types/assets.d.js +0 -2
  168. package/dist/@types/assets.d.js.map +0 -1
  169. package/dist/utils/localAPIDefaults.d.ts +0 -20
  170. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  171. package/dist/utils/localAPIDefaults.js +0 -19
  172. package/dist/utils/localAPIDefaults.js.map +0 -1
  173. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  174. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  175. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  176. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  177. package/src/@types/assets.d.ts +0 -3
  178. package/src/utils/localAPIDefaults.ts +0 -22
  179. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
@@ -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 =
@@ -38,8 +37,8 @@ export const countGlobalVersionsTool = defineGlobalTool({
38
37
  try {
39
38
  const result = await payload.countGlobalVersions({
40
39
  global: globalSlug,
40
+ overrideAccess: authorizedMCP.overrideAccess,
41
41
  req,
42
- ...localAPIDefaults(authorizedMCP),
43
42
  ...(locale ? { locale } : {}),
44
43
  ...(where ? { where } : {}),
45
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 } : {}),
@@ -1,3 +1,5 @@
1
+ import { getAccessResults } from 'payload'
2
+
1
3
  import { defaultAccess } from '../../../defaultAccess.js'
2
4
  import { defineGlobalTool } from '../../../defineTool.js'
3
5
  import { getGlobalInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
@@ -6,7 +8,7 @@ export const getGlobalSchemaTool = defineGlobalTool({
6
8
  access: (args) => {
7
9
  const permissions = args.permissions?.globals?.[args.globalSlug]
8
10
 
9
- return defaultAccess(args) && Boolean(permissions?.read || permissions?.update)
11
+ return defaultAccess(args) && Boolean(permissions?.update)
10
12
  },
11
13
  annotations: {
12
14
  destructiveHint: false,
@@ -16,8 +18,28 @@ export const getGlobalSchemaTool = defineGlobalTool({
16
18
  title: 'Get Global Schema',
17
19
  },
18
20
  description: 'Get the input schema for updating a global.',
19
- }).handler(({ globalSlug, req }) => {
20
- const inputSchema = getGlobalInputSchema({ globalSlug, req })
21
+ }).handler(async ({ authorizedMCP, globalSlug, req }) => {
22
+ const permissions = authorizedMCP.overrideAccess
23
+ ? null
24
+ : (await getAccessResults({ req })).globals?.[globalSlug]
25
+
26
+ if (!authorizedMCP.overrideAccess && !permissions?.update) {
27
+ return {
28
+ content: [
29
+ {
30
+ type: 'text',
31
+ text: `Error: MCP access to "getGlobalSchema" is not enabled for global "${globalSlug}"`,
32
+ },
33
+ ],
34
+ isError: true,
35
+ }
36
+ }
37
+
38
+ const inputSchema = getGlobalInputSchema({
39
+ globalSlug,
40
+ req,
41
+ ...(permissions ? { permissions } : {}),
42
+ })
21
43
 
22
44
  if (!inputSchema) {
23
45
  return {
@@ -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
  'Restore a global from a previous version in any version-enabled global.'
@@ -62,8 +61,8 @@ export const restoreGlobalVersionTool = defineGlobalTool({
62
61
  id,
63
62
  slug: globalSlug,
64
63
  depth,
64
+ overrideAccess: authorizedMCP.overrideAccess,
65
65
  req,
66
- ...localAPIDefaults(authorizedMCP),
67
66
  ...(fallbackLocale ? { fallbackLocale } : {}),
68
67
  ...(locale ? { locale } : {}),
69
68
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -9,7 +9,6 @@ import {
9
9
  getGlobalVirtualFieldNames,
10
10
  stripVirtualFields,
11
11
  } from '../../../utils/getVirtualFieldNames.js'
12
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
13
12
  import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
14
13
  import { validateGlobalData } from '../validateEntityData.js'
15
14
 
@@ -81,7 +80,8 @@ export const updateGlobalTool = defineGlobalTool({
81
80
  data: parsedData,
82
81
  depth,
83
82
  draft,
84
- ...localAPIDefaults(authorizedMCP),
83
+ overrideAccess: authorizedMCP.overrideAccess,
84
+ req,
85
85
  }
86
86
 
87
87
  if (locale) {
@@ -1,6 +1,6 @@
1
1
  import type { CollectionSlug, GlobalSlug, PayloadRequest, SanitizedConfig } from 'payload'
2
2
 
3
- import { CfWorkerJsonSchemaValidator } from '@modelcontextprotocol/server'
3
+ import { CfWorkerJsonSchemaValidator } from '@modelcontextprotocol/server/validators/cf-worker'
4
4
 
5
5
  import type { JsonSchemaType, MCPToolResponse } from '../../types.js'
6
6
 
@@ -10,7 +10,7 @@ import {
10
10
  } from './builtin/collections/authTools.js'
11
11
  import { countDocumentsTool } from './builtin/collections/countTool.js'
12
12
  import { countVersionsTool } from './builtin/collections/countVersionsTool.js'
13
- import { createDocumentTool } from './builtin/collections/createTool.js'
13
+ import { createDocumentsTool } from './builtin/collections/createTool.js'
14
14
  import { deleteDocumentsTool } from './builtin/collections/deleteTool.js'
15
15
  import { duplicateDocumentTool } from './builtin/collections/duplicateTool.js'
16
16
  import { findDistinctTool } from './builtin/collections/findDistinctTool.js'
@@ -20,6 +20,7 @@ import { findVersionsTool } from './builtin/collections/findVersionsTool.js'
20
20
  import { getCollectionSchemaTool } from './builtin/collections/getCollectionSchemaTool.js'
21
21
  import { restoreVersionTool } from './builtin/collections/restoreVersionTool.js'
22
22
  import { updateDocumentTool } from './builtin/collections/updateTool.js'
23
+ import { getUploadInstructionsTool } from './builtin/collections/uploadInstructionsTool.js'
23
24
  import { getConfigInfoTool } from './builtin/getConfigInfoTool.js'
24
25
  import { countGlobalVersionsTool } from './builtin/globals/countVersionsTool.js'
25
26
  import { findGlobalTool } from './builtin/globals/findTool.js'
@@ -32,6 +33,7 @@ import { updateGlobalTool } from './builtin/globals/updateTool.js'
32
33
  type CollectionBuiltin = {
33
34
  mcpName: string
34
35
  requiresDuplicateEnabled?: boolean
36
+ requiresUpload?: boolean
35
37
  requiresVersions?: boolean
36
38
  tool: CollectionTool
37
39
  }
@@ -54,7 +56,7 @@ export const TOOL_BUILTINS = {
54
56
  export const COLLECTION_BUILTINS = {
55
57
  count: { mcpName: 'countDocuments', tool: countDocumentsTool },
56
58
  countVersions: { mcpName: 'countVersions', requiresVersions: true, tool: countVersionsTool },
57
- create: { mcpName: 'createDocument', tool: createDocumentTool },
59
+ create: { mcpName: 'createDocuments', tool: createDocumentsTool },
58
60
  delete: { mcpName: 'deleteDocuments', tool: deleteDocumentsTool },
59
61
  duplicate: {
60
62
  mcpName: 'duplicateDocument',
@@ -70,6 +72,11 @@ export const COLLECTION_BUILTINS = {
70
72
  },
71
73
  findVersions: { mcpName: 'findVersions', requiresVersions: true, tool: findVersionsTool },
72
74
  getCollectionSchema: { mcpName: 'getCollectionSchema', tool: getCollectionSchemaTool },
75
+ getUploadInstructions: {
76
+ mcpName: 'getUploadInstructions',
77
+ requiresUpload: true,
78
+ tool: getUploadInstructionsTool,
79
+ },
73
80
  restoreVersion: { mcpName: 'restoreVersion', requiresVersions: true, tool: restoreVersionTool },
74
81
  update: { mcpName: 'updateDocument', tool: updateDocumentTool },
75
82
  } satisfies Record<string, CollectionBuiltin>
@@ -100,6 +100,7 @@ export const sanitizeMCPConfig = ({
100
100
 
101
101
  return {
102
102
  disabled: pluginConfig.disabled,
103
+ hooks: pluginConfig.hooks,
103
104
  items,
104
105
  mcp: pluginConfig.mcp,
105
106
  overrideGetAuthorizedMCP: pluginConfig.overrideGetAuthorizedMCP,
@@ -126,7 +127,7 @@ const sanitizeCollectionConfig = ({
126
127
 
127
128
  for (const [
128
129
  toolKey,
129
- { mcpName, requiresDuplicateEnabled, requiresVersions, tool },
130
+ { mcpName, requiresDuplicateEnabled, requiresUpload, requiresVersions, tool },
130
131
  ] of COLLECTION_BUILTIN_ENTRIES) {
131
132
  if (requiresVersions && !collection.versions) {
132
133
  continue
@@ -134,6 +135,9 @@ const sanitizeCollectionConfig = ({
134
135
  if (requiresDuplicateEnabled && isDuplicateDisabled) {
135
136
  continue
136
137
  }
138
+ if (requiresUpload && !collection.upload) {
139
+ continue
140
+ }
137
141
  const matchedConfigEntry = collectionPluginConfig?.tools?.[toolKey]
138
142
  if (matchedConfigEntry === false) {
139
143
  continue