@payloadcms/plugin-mcp 4.0.0-internal.c2b57ce → 4.0.0-internal.ccea85d

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 (257) hide show
  1. package/LICENSE.md +1 -1
  2. package/bin.js +7 -0
  3. package/dist/defaultAccess.d.ts +3 -0
  4. package/dist/defaultAccess.d.ts.map +1 -0
  5. package/dist/defaultAccess.js +3 -0
  6. package/dist/defaultAccess.js.map +1 -0
  7. package/dist/defineTool.d.ts +8 -8
  8. package/dist/defineTool.d.ts.map +1 -1
  9. package/dist/endpoint/access.d.ts +12 -5
  10. package/dist/endpoint/access.d.ts.map +1 -1
  11. package/dist/endpoint/access.js +75 -88
  12. package/dist/endpoint/access.js.map +1 -1
  13. package/dist/endpoint/index.d.ts +1 -1
  14. package/dist/endpoint/index.d.ts.map +1 -1
  15. package/dist/endpoint/index.js +70 -19
  16. package/dist/endpoint/index.js.map +1 -1
  17. package/dist/exports/client.d.ts +1 -1
  18. package/dist/exports/client.d.ts.map +1 -1
  19. package/dist/exports/client.js +1 -1
  20. package/dist/exports/client.js.map +1 -1
  21. package/dist/exports/internal.d.ts +2 -0
  22. package/dist/exports/internal.d.ts.map +1 -0
  23. package/dist/exports/internal.js +3 -0
  24. package/dist/exports/internal.js.map +1 -0
  25. package/dist/index.d.ts +2 -2
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +15 -20
  28. package/dist/index.js.map +1 -1
  29. package/dist/mcp/buildMcpServer.d.ts +4 -4
  30. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  31. package/dist/mcp/buildMcpServer.js +133 -73
  32. package/dist/mcp/buildMcpServer.js.map +1 -1
  33. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  34. package/dist/mcp/builtin/collections/authTools.js +44 -6
  35. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  36. package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
  37. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
  38. package/dist/mcp/builtin/collections/countTool.js +68 -0
  39. package/dist/mcp/builtin/collections/countTool.js.map +1 -0
  40. package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
  41. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
  42. package/dist/mcp/builtin/collections/countVersionsTool.js +64 -0
  43. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
  44. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  45. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  46. package/dist/mcp/builtin/collections/createTool.js +50 -41
  47. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  48. package/dist/mcp/builtin/collections/deleteTool.d.ts +1 -1
  49. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  50. package/dist/mcp/builtin/collections/deleteTool.js +15 -22
  51. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  52. package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
  53. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
  54. package/dist/mcp/builtin/collections/duplicateTool.js +96 -0
  55. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
  56. package/dist/mcp/builtin/collections/fileInput.d.ts +20 -0
  57. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  58. package/dist/mcp/builtin/collections/fileInput.js +100 -0
  59. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  60. package/dist/mcp/builtin/collections/fileInput.spec.js +72 -0
  61. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  62. package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
  63. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
  64. package/dist/mcp/builtin/collections/findDistinctTool.js +92 -0
  65. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
  66. package/dist/mcp/builtin/collections/findTool.d.ts +1 -1
  67. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  68. package/dist/mcp/builtin/collections/findTool.js +52 -47
  69. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  70. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
  71. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
  72. package/dist/mcp/builtin/collections/findVersionByIDTool.js +83 -0
  73. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
  74. package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
  75. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
  76. package/dist/mcp/builtin/collections/findVersionsTool.js +98 -0
  77. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
  78. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +9 -0
  79. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -0
  80. package/dist/mcp/builtin/collections/formatCollectionError.js +60 -0
  81. package/dist/mcp/builtin/collections/formatCollectionError.js.map +1 -0
  82. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
  83. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
  84. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +86 -0
  85. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
  86. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
  87. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
  88. package/dist/mcp/builtin/collections/restoreVersionTool.js +81 -0
  89. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
  90. package/dist/mcp/builtin/collections/updateTool.d.ts +1 -1
  91. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  92. package/dist/mcp/builtin/collections/updateTool.js +106 -89
  93. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  94. package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
  95. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
  96. package/dist/mcp/builtin/getConfigInfoTool.js +68 -0
  97. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
  98. package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
  99. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
  100. package/dist/mcp/builtin/globals/countVersionsTool.js +64 -0
  101. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
  102. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  103. package/dist/mcp/builtin/globals/findTool.js +20 -23
  104. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  105. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
  106. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
  107. package/dist/mcp/builtin/globals/findVersionByIDTool.js +79 -0
  108. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
  109. package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
  110. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
  111. package/dist/mcp/builtin/globals/findVersionsTool.js +94 -0
  112. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
  113. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
  114. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
  115. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +65 -0
  116. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
  117. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
  118. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
  119. package/dist/mcp/builtin/globals/restoreVersionTool.js +77 -0
  120. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
  121. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  122. package/dist/mcp/builtin/globals/updateTool.js +33 -38
  123. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  124. package/dist/mcp/builtin/validateEntityData.d.ts +14 -0
  125. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -0
  126. package/dist/mcp/builtin/validateEntityData.js +82 -0
  127. package/dist/mcp/builtin/validateEntityData.js.map +1 -0
  128. package/dist/mcp/builtinTools.d.ts +144 -19
  129. package/dist/mcp/builtinTools.d.ts.map +1 -1
  130. package/dist/mcp/builtinTools.js +119 -20
  131. package/dist/mcp/builtinTools.js.map +1 -1
  132. package/dist/mcp/sanitizeMCPConfig.d.ts +0 -1
  133. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  134. package/dist/mcp/sanitizeMCPConfig.js +121 -58
  135. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  136. package/dist/stdio.d.ts +3 -3
  137. package/dist/stdio.d.ts.map +1 -1
  138. package/dist/stdio.js +82 -45
  139. package/dist/stdio.js.map +1 -1
  140. package/dist/types.d.ts +112 -110
  141. package/dist/types.d.ts.map +1 -1
  142. package/dist/types.js +2 -4
  143. package/dist/types.js.map +1 -1
  144. package/dist/utils/camelCase.d.ts.map +1 -1
  145. package/dist/utils/getPluginConfig.d.ts +1 -1
  146. package/dist/utils/getPluginConfig.js +1 -1
  147. package/dist/utils/getPluginConfig.js.map +1 -1
  148. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  149. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +28 -0
  150. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +1 -0
  151. package/dist/utils/schemaConversion/filterFieldsByAccess.js +71 -0
  152. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +1 -0
  153. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +13 -0
  154. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -0
  155. package/dist/utils/schemaConversion/getEntityInputSchema.js +66 -0
  156. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -0
  157. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +10 -0
  158. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -0
  159. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +384 -0
  160. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -0
  161. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +133 -0
  162. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -0
  163. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  164. package/dist/utils/whereSchema.d.ts +9 -0
  165. package/dist/utils/whereSchema.d.ts.map +1 -0
  166. package/dist/utils/whereSchema.js +13 -0
  167. package/dist/utils/whereSchema.js.map +1 -0
  168. package/package.json +15 -20
  169. package/src/defaultAccess.ts +3 -0
  170. package/src/endpoint/access.ts +81 -101
  171. package/src/endpoint/index.ts +59 -17
  172. package/src/exports/client.ts +2 -1
  173. package/src/exports/internal.ts +1 -0
  174. package/src/index.ts +12 -20
  175. package/src/mcp/buildMcpServer.ts +169 -109
  176. package/src/mcp/builtin/collections/authTools.ts +45 -9
  177. package/src/mcp/builtin/collections/countTool.ts +73 -0
  178. package/src/mcp/builtin/collections/countVersionsTool.ts +69 -0
  179. package/src/mcp/builtin/collections/createTool.ts +67 -62
  180. package/src/mcp/builtin/collections/deleteTool.ts +20 -18
  181. package/src/mcp/builtin/collections/duplicateTool.ts +134 -0
  182. package/src/mcp/builtin/collections/fileInput.spec.ts +79 -0
  183. package/src/mcp/builtin/collections/fileInput.ts +139 -0
  184. package/src/mcp/builtin/collections/findDistinctTool.ts +119 -0
  185. package/src/mcp/builtin/collections/findTool.ts +66 -37
  186. package/src/mcp/builtin/collections/findVersionByIDTool.ts +109 -0
  187. package/src/mcp/builtin/collections/findVersionsTool.ts +154 -0
  188. package/src/mcp/builtin/collections/formatCollectionError.ts +84 -0
  189. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +76 -0
  190. package/src/mcp/builtin/collections/restoreVersionTool.ts +107 -0
  191. package/src/mcp/builtin/collections/updateTool.ts +132 -110
  192. package/src/mcp/builtin/getConfigInfoTool.ts +67 -0
  193. package/src/mcp/builtin/globals/countVersionsTool.ts +68 -0
  194. package/src/mcp/builtin/globals/findTool.ts +28 -19
  195. package/src/mcp/builtin/globals/findVersionByIDTool.ts +103 -0
  196. package/src/mcp/builtin/globals/findVersionsTool.ts +147 -0
  197. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +63 -0
  198. package/src/mcp/builtin/globals/restoreVersionTool.ts +99 -0
  199. package/src/mcp/builtin/globals/updateTool.ts +52 -55
  200. package/src/mcp/builtin/validateEntityData.ts +132 -0
  201. package/src/mcp/builtinTools.ts +111 -41
  202. package/src/mcp/sanitizeMCPConfig.ts +117 -78
  203. package/src/stdio.ts +77 -45
  204. package/src/types.ts +128 -115
  205. package/src/utils/getPluginConfig.ts +1 -1
  206. package/src/utils/schemaConversion/filterFieldsByAccess.ts +123 -0
  207. package/src/utils/schemaConversion/getEntityInputSchema.ts +96 -0
  208. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +96 -0
  209. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +432 -0
  210. package/src/utils/whereSchema.ts +24 -0
  211. package/dist/collection/getAccessField.d.ts +0 -12
  212. package/dist/collection/getAccessField.d.ts.map +0 -1
  213. package/dist/collection/getAccessField.js +0 -57
  214. package/dist/collection/getAccessField.js.map +0 -1
  215. package/dist/collection/index.d.ts +0 -6
  216. package/dist/collection/index.d.ts.map +0 -1
  217. package/dist/collection/index.js +0 -59
  218. package/dist/collection/index.js.map +0 -1
  219. package/dist/components/AccessField/index.client.d.ts +0 -10
  220. package/dist/components/AccessField/index.client.d.ts.map +0 -1
  221. package/dist/components/AccessField/index.client.js +0 -305
  222. package/dist/components/AccessField/index.client.js.map +0 -1
  223. package/dist/components/AccessField/index.css +0 -93
  224. package/dist/utils/localAPIDefaults.d.ts +0 -20
  225. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  226. package/dist/utils/localAPIDefaults.js +0 -19
  227. package/dist/utils/localAPIDefaults.js.map +0 -1
  228. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts +0 -7
  229. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts.map +0 -1
  230. package/dist/utils/schemaConversion/prepareCollectionSchema.js +0 -37
  231. package/dist/utils/schemaConversion/prepareCollectionSchema.js.map +0 -1
  232. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  233. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  234. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  235. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  236. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +0 -13
  237. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +0 -1
  238. package/dist/utils/schemaConversion/sanitizeJsonSchema.js +0 -56
  239. package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +0 -1
  240. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +0 -20
  241. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +0 -1
  242. package/dist/utils/schemaConversion/simplifyRelationshipFields.js +0 -56
  243. package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +0 -1
  244. package/dist/utils/schemaConversion/transformPointFields.d.ts +0 -3
  245. package/dist/utils/schemaConversion/transformPointFields.d.ts.map +0 -1
  246. package/dist/utils/schemaConversion/transformPointFields.js +0 -57
  247. package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
  248. package/src/collection/getAccessField.ts +0 -64
  249. package/src/collection/index.ts +0 -63
  250. package/src/components/AccessField/index.client.tsx +0 -344
  251. package/src/components/AccessField/index.css +0 -93
  252. package/src/utils/localAPIDefaults.ts +0 -22
  253. package/src/utils/schemaConversion/prepareCollectionSchema.ts +0 -39
  254. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
  255. package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
  256. package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -70
  257. package/src/utils/schemaConversion/transformPointFields.ts +0 -56
@@ -0,0 +1,132 @@
1
+ import type { CollectionSlug, GlobalSlug, PayloadRequest, SanitizedConfig } from 'payload'
2
+
3
+ import { CfWorkerJsonSchemaValidator } from '@modelcontextprotocol/server/validators/cf-worker'
4
+
5
+ import type { JsonSchemaType, MCPToolResponse } from '../../types.js'
6
+
7
+ import {
8
+ getCollectionInputSchema,
9
+ getGlobalInputSchema,
10
+ } from '../../utils/schemaConversion/getEntityInputSchema.js'
11
+
12
+ /**
13
+ * Keep the default `shortcircuit: true` - `false` makes validating nested rich text exponentially slow.
14
+ */
15
+ const validator = new CfWorkerJsonSchemaValidator({ shortcircuit: true })
16
+
17
+ type EntityValidator = {
18
+ schema: JsonSchemaType
19
+ validate: ReturnType<(typeof validator)['getValidator']>
20
+ }
21
+
22
+ /**
23
+ * - Caches each entity's schema and validator, so both are only built on the first request.
24
+ * - Keyed by payload config, then by entity type, slug, partial and language.
25
+ */
26
+ const validatorCache = new WeakMap<SanitizedConfig, Map<string, EntityValidator>>()
27
+
28
+ export const validateCollectionData = ({
29
+ collectionSlug,
30
+ data,
31
+ partial,
32
+ req,
33
+ }: {
34
+ collectionSlug: CollectionSlug
35
+ data: Record<string, unknown>
36
+ partial?: boolean
37
+ req: PayloadRequest
38
+ }): MCPToolResponse | null =>
39
+ validateData({
40
+ slug: collectionSlug,
41
+ buildSchema: () => getCollectionInputSchema({ collectionSlug, req }),
42
+ data,
43
+ entity: 'collection',
44
+ partial,
45
+ req,
46
+ })
47
+
48
+ export const validateGlobalData = ({
49
+ data,
50
+ globalSlug,
51
+ req,
52
+ }: {
53
+ data: Record<string, unknown>
54
+ globalSlug: GlobalSlug
55
+ req: PayloadRequest
56
+ }): MCPToolResponse | null =>
57
+ validateData({
58
+ slug: globalSlug,
59
+ buildSchema: () => getGlobalInputSchema({ globalSlug, req }),
60
+ data,
61
+ entity: 'global',
62
+ partial: true,
63
+ req,
64
+ })
65
+
66
+ const validateData = ({
67
+ slug,
68
+ buildSchema,
69
+ data,
70
+ entity,
71
+ partial,
72
+ req,
73
+ }: {
74
+ buildSchema: () => JsonSchemaType | null
75
+ data: Record<string, unknown>
76
+ entity: 'collection' | 'global'
77
+ partial?: boolean
78
+ req: PayloadRequest
79
+ slug: string
80
+ }): MCPToolResponse | null => {
81
+ let cache = validatorCache.get(req.payload.config)
82
+ if (!cache) {
83
+ cache = new Map()
84
+ validatorCache.set(req.payload.config, cache)
85
+ }
86
+
87
+ const cacheKey = `${entity}:${slug}:${partial ? 'partial' : 'full'}:${req.i18n.language}`
88
+ let entityValidator = cache.get(cacheKey)
89
+
90
+ if (!entityValidator) {
91
+ const schema = buildSchema()
92
+
93
+ if (!schema) {
94
+ return null
95
+ }
96
+
97
+ entityValidator = {
98
+ schema,
99
+ validate: validator.getValidator(partial ? withoutRequired(schema) : schema),
100
+ }
101
+ cache.set(cacheKey, entityValidator)
102
+ }
103
+
104
+ const result = entityValidator.validate(data)
105
+
106
+ if (result.valid) {
107
+ return null
108
+ }
109
+
110
+ const { schema } = entityValidator
111
+
112
+ return {
113
+ content: [
114
+ {
115
+ type: 'text',
116
+ text: `Invalid data for ${entity} "${slug}": ${result.errorMessage}\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\``,
117
+ },
118
+ ],
119
+ isError: true,
120
+ structuredContent: {
121
+ [`${entity}Slug`]: slug,
122
+ errors: [{ message: result.errorMessage }],
123
+ schema,
124
+ },
125
+ }
126
+ }
127
+
128
+ /** Updates are partial — drop the schema's top-level `required` before validating. */
129
+ const withoutRequired = (schema: JsonSchemaType): JsonSchemaType => {
130
+ const { required: _required, ...rest } = schema
131
+ return rest
132
+ }
@@ -1,4 +1,4 @@
1
- import type { CollectionTool, GlobalTool } from '../types.js'
1
+ import type { CollectionTool, GlobalTool, Tool } from '../types.js'
2
2
 
3
3
  import {
4
4
  authCollectionTool,
@@ -8,62 +8,128 @@ import {
8
8
  unlockCollectionTool,
9
9
  verifyCollectionTool,
10
10
  } from './builtin/collections/authTools.js'
11
- import { createCollectionTool } from './builtin/collections/createTool.js'
12
- import { deleteCollectionTool } from './builtin/collections/deleteTool.js'
13
- import { findCollectionTool } from './builtin/collections/findTool.js'
14
- import { updateCollectionTool } from './builtin/collections/updateTool.js'
11
+ import { countDocumentsTool } from './builtin/collections/countTool.js'
12
+ import { countVersionsTool } from './builtin/collections/countVersionsTool.js'
13
+ import { createDocumentTool } from './builtin/collections/createTool.js'
14
+ import { deleteDocumentsTool } from './builtin/collections/deleteTool.js'
15
+ import { duplicateDocumentTool } from './builtin/collections/duplicateTool.js'
16
+ import { findDistinctTool } from './builtin/collections/findDistinctTool.js'
17
+ import { findDocumentsTool } from './builtin/collections/findTool.js'
18
+ import { findVersionByIDTool } from './builtin/collections/findVersionByIDTool.js'
19
+ import { findVersionsTool } from './builtin/collections/findVersionsTool.js'
20
+ import { getCollectionSchemaTool } from './builtin/collections/getCollectionSchemaTool.js'
21
+ import { restoreVersionTool } from './builtin/collections/restoreVersionTool.js'
22
+ import { updateDocumentTool } from './builtin/collections/updateTool.js'
23
+ import { getConfigInfoTool } from './builtin/getConfigInfoTool.js'
24
+ import { countGlobalVersionsTool } from './builtin/globals/countVersionsTool.js'
15
25
  import { findGlobalTool } from './builtin/globals/findTool.js'
26
+ import { findGlobalVersionByIDTool } from './builtin/globals/findVersionByIDTool.js'
27
+ import { findGlobalVersionsTool } from './builtin/globals/findVersionsTool.js'
28
+ import { getGlobalSchemaTool } from './builtin/globals/getGlobalSchemaTool.js'
29
+ import { restoreGlobalVersionTool } from './builtin/globals/restoreVersionTool.js'
16
30
  import { updateGlobalTool } from './builtin/globals/updateTool.js'
17
31
 
32
+ type CollectionBuiltin = {
33
+ mcpName: string
34
+ requiresDuplicateEnabled?: boolean
35
+ requiresVersions?: boolean
36
+ tool: CollectionTool
37
+ }
38
+
39
+ type GlobalBuiltin = {
40
+ mcpName: string
41
+ requiresVersions?: boolean
42
+ tool: GlobalTool
43
+ }
44
+
45
+ export const TOOL_BUILTINS = {
46
+ getConfigInfo: { mcpName: 'getConfigInfo', tool: getConfigInfoTool },
47
+ } satisfies Record<string, { mcpName: string; tool: Tool }>
48
+
18
49
  /**
19
50
  * The static built-in collection CRUD tools. Keys here are the source of truth
20
51
  * for `MCPCollectionBuiltinName` — adding/removing an entry updates the type
21
52
  * automatically.
22
53
  */
23
- export const COLLECTION_BUILTINS: Record<MCPCollectionBuiltinName, CollectionTool> = {
24
- create: createCollectionTool,
25
- delete: deleteCollectionTool,
26
- find: findCollectionTool,
27
- update: updateCollectionTool,
28
- }
54
+ export const COLLECTION_BUILTINS = {
55
+ count: { mcpName: 'countDocuments', tool: countDocumentsTool },
56
+ countVersions: { mcpName: 'countVersions', requiresVersions: true, tool: countVersionsTool },
57
+ create: { mcpName: 'createDocument', tool: createDocumentTool },
58
+ delete: { mcpName: 'deleteDocuments', tool: deleteDocumentsTool },
59
+ duplicate: {
60
+ mcpName: 'duplicateDocument',
61
+ requiresDuplicateEnabled: true,
62
+ tool: duplicateDocumentTool,
63
+ },
64
+ find: { mcpName: 'findDocuments', tool: findDocumentsTool },
65
+ findDistinct: { mcpName: 'findDistinct', tool: findDistinctTool },
66
+ findVersionByID: {
67
+ mcpName: 'findVersionByID',
68
+ requiresVersions: true,
69
+ tool: findVersionByIDTool,
70
+ },
71
+ findVersions: { mcpName: 'findVersions', requiresVersions: true, tool: findVersionsTool },
72
+ getCollectionSchema: { mcpName: 'getCollectionSchema', tool: getCollectionSchemaTool },
73
+ restoreVersion: { mcpName: 'restoreVersion', requiresVersions: true, tool: restoreVersionTool },
74
+ update: { mcpName: 'updateDocument', tool: updateDocumentTool },
75
+ } satisfies Record<string, CollectionBuiltin>
29
76
 
30
77
  /**
31
- * The static auth tools surfaced under auth-enabled collections. Each entry
32
- * carries the admin-UI label alongside the tool. Keys are the source of truth
33
- * for `MCPCollectionAuthToolName`.
78
+ * The static auth tools surfaced under auth-enabled collections. Keys are the
79
+ * source of truth for `MCPCollectionAuthToolName`.
34
80
  */
35
- export const COLLECTION_AUTH_BUILTINS: Record<
36
- MCPCollectionAuthToolName,
37
- { label: string; tool: CollectionTool }
38
- > = {
39
- auth: { label: 'Check Auth Status', tool: authCollectionTool },
40
- forgotPassword: { label: 'Forgot Password', tool: forgotPasswordCollectionTool },
41
- login: { label: 'User Login', tool: loginCollectionTool },
42
- resetPassword: { label: 'Reset Password', tool: resetPasswordCollectionTool },
43
- unlock: { label: 'Unlock Account', tool: unlockCollectionTool },
44
- verify: { label: 'Email Verification', tool: verifyCollectionTool },
45
- }
81
+ export const COLLECTION_AUTH_BUILTINS = {
82
+ auth: { mcpName: 'auth', tool: authCollectionTool },
83
+ forgotPassword: {
84
+ mcpName: 'forgotPassword',
85
+ tool: forgotPasswordCollectionTool,
86
+ },
87
+ login: { mcpName: 'login', tool: loginCollectionTool },
88
+ resetPassword: {
89
+ mcpName: 'resetPassword',
90
+ tool: resetPasswordCollectionTool,
91
+ },
92
+ unlock: { mcpName: 'unlock', tool: unlockCollectionTool },
93
+ verify: { mcpName: 'verify', tool: verifyCollectionTool },
94
+ } satisfies Record<string, { mcpName: string; tool: CollectionTool }>
46
95
 
47
96
  /**
48
97
  * The static built-in global tools. Keys are the source of truth for
49
98
  * `MCPGlobalBuiltinName`.
50
99
  */
51
- export const GLOBAL_BUILTINS: Record<MCPGlobalBuiltinName, GlobalTool> = {
52
- find: findGlobalTool,
53
- update: updateGlobalTool,
54
- }
100
+ export const GLOBAL_BUILTINS = {
101
+ countGlobalVersions: {
102
+ mcpName: 'countGlobalVersions',
103
+ requiresVersions: true,
104
+ tool: countGlobalVersionsTool,
105
+ },
106
+ find: { mcpName: 'findGlobal', tool: findGlobalTool },
107
+ findGlobalVersionByID: {
108
+ mcpName: 'findGlobalVersionByID',
109
+ requiresVersions: true,
110
+ tool: findGlobalVersionByIDTool,
111
+ },
112
+ findGlobalVersions: {
113
+ mcpName: 'findGlobalVersions',
114
+ requiresVersions: true,
115
+ tool: findGlobalVersionsTool,
116
+ },
117
+ getGlobalSchema: { mcpName: 'getGlobalSchema', tool: getGlobalSchemaTool },
118
+ restoreGlobalVersion: {
119
+ mcpName: 'restoreGlobalVersion',
120
+ requiresVersions: true,
121
+ tool: restoreGlobalVersionTool,
122
+ },
123
+ update: { mcpName: 'updateGlobal', tool: updateGlobalTool },
124
+ } satisfies Record<string, GlobalBuiltin>
125
+
126
+ export type MCPCollectionBuiltinName = keyof typeof COLLECTION_BUILTINS
55
127
 
56
- export type MCPCollectionBuiltinName = 'create' | 'delete' | 'find' | 'update'
128
+ export type MCPCollectionAuthToolName = keyof typeof COLLECTION_AUTH_BUILTINS
57
129
 
58
- export type MCPCollectionAuthToolName =
59
- | 'auth'
60
- | 'forgotPassword'
61
- | 'login'
62
- | 'resetPassword'
63
- | 'unlock'
64
- | 'verify'
130
+ export type MCPGlobalBuiltinName = keyof typeof GLOBAL_BUILTINS
65
131
 
66
- export type MCPGlobalBuiltinName = 'find' | 'update'
132
+ export type MCPTopLevelBuiltinName = keyof typeof TOOL_BUILTINS
67
133
 
68
134
  /**
69
135
  * Pre-typed `Object.entries` for each registry. The cast from `string` to the
@@ -71,14 +137,18 @@ export type MCPGlobalBuiltinName = 'find' | 'update'
71
137
  * cast — TypeScript's `Object.entries` always widens keys to `string`, which
72
138
  * defeats the narrow type lookups on `MCPCollectionToolsMap`.
73
139
  */
140
+ export const TOOL_BUILTIN_ENTRIES = Object.entries(TOOL_BUILTINS) as Array<
141
+ [MCPTopLevelBuiltinName, (typeof TOOL_BUILTINS)[MCPTopLevelBuiltinName]]
142
+ >
143
+
74
144
  export const COLLECTION_BUILTIN_ENTRIES = Object.entries(COLLECTION_BUILTINS) as Array<
75
- [MCPCollectionBuiltinName, CollectionTool]
145
+ [MCPCollectionBuiltinName, CollectionBuiltin]
76
146
  >
77
147
 
78
148
  export const COLLECTION_AUTH_BUILTIN_ENTRIES = Object.entries(COLLECTION_AUTH_BUILTINS) as Array<
79
- [MCPCollectionAuthToolName, { label: string; tool: CollectionTool }]
149
+ [MCPCollectionAuthToolName, (typeof COLLECTION_AUTH_BUILTINS)[MCPCollectionAuthToolName]]
80
150
  >
81
151
 
82
152
  export const GLOBAL_BUILTIN_ENTRIES = Object.entries(GLOBAL_BUILTINS) as Array<
83
- [MCPGlobalBuiltinName, GlobalTool]
153
+ [MCPGlobalBuiltinName, GlobalBuiltin]
84
154
  >
@@ -8,16 +8,16 @@ import type {
8
8
  } from 'payload'
9
9
 
10
10
  import type {
11
+ CollectionMCPItem,
11
12
  CollectionTool,
13
+ GlobalMCPItem,
12
14
  GlobalTool,
13
- MCPBuiltInToolOverride,
14
15
  MCPItem,
15
- MCPPluginCollectionConfig,
16
16
  MCPPluginConfig,
17
- MCPPluginGlobalConfig,
18
17
  SanitizedMCPPluginConfig,
19
18
  } from '../types.js'
20
19
 
20
+ import { defaultAccess } from '../defaultAccess.js'
21
21
  import {
22
22
  COLLECTION_AUTH_BUILTIN_ENTRIES,
23
23
  COLLECTION_AUTH_BUILTINS,
@@ -25,6 +25,8 @@ import {
25
25
  COLLECTION_BUILTINS,
26
26
  GLOBAL_BUILTIN_ENTRIES,
27
27
  GLOBAL_BUILTINS,
28
+ TOOL_BUILTIN_ENTRIES,
29
+ TOOL_BUILTINS,
28
30
  } from './builtinTools.js'
29
31
 
30
32
  /**
@@ -32,7 +34,6 @@ import {
32
34
  * - Flattens `tools` / `prompts` / `resources` / per-collection / per-global
33
35
  * tool maps into a single `items` array.
34
36
  * - Applies built-in tools for collections and globals, respecting opt-out user overrides.
35
- * - Applies the `userCollection` default
36
37
  *
37
38
  * Called once during plugin init. After that, `plugins['@payloadcms/plugin-mcp']
38
39
  * ?.options` holds the sanitized result
@@ -54,44 +55,55 @@ export const sanitizeMCPConfig = ({
54
55
  items.push(...sanitizeGlobalConfig({ global, pluginConfig }))
55
56
  }
56
57
 
57
- for (const [key, tool] of Object.entries(pluginConfig.tools ?? {})) {
58
+ for (const [configKey, { mcpName, tool }] of TOOL_BUILTIN_ENTRIES) {
58
59
  items.push({
59
60
  type: 'tool',
60
- key,
61
- label: key,
62
- tool,
61
+ configKey,
62
+ label: tool.annotations?.title ?? configKey,
63
+ mcpName,
64
+ tool: { ...tool, access: tool.access ?? defaultAccess },
63
65
  })
64
66
  }
65
67
 
66
- for (const [key, prompt] of Object.entries(pluginConfig.prompts ?? {})) {
68
+ for (const [configKey, tool] of Object.entries(pluginConfig.tools ?? {})) {
69
+ if (configKey in TOOL_BUILTINS) {
70
+ continue
71
+ }
72
+ items.push({
73
+ type: 'tool',
74
+ configKey,
75
+ label: tool.annotations?.title ?? configKey,
76
+ mcpName: configKey,
77
+ tool: { ...tool, access: tool.access ?? defaultAccess },
78
+ })
79
+ }
80
+
81
+ for (const [configKey, prompt] of Object.entries(pluginConfig.prompts ?? {})) {
67
82
  items.push({
68
83
  type: 'prompt',
69
- key,
70
- label: prompt.title ?? key,
71
- prompt,
84
+ configKey,
85
+ label: prompt.title ?? configKey,
86
+ mcpName: configKey,
87
+ prompt: { ...prompt, access: prompt.access ?? defaultAccess },
72
88
  })
73
89
  }
74
90
 
75
- for (const [key, resource] of Object.entries(pluginConfig.resources ?? {})) {
91
+ for (const [configKey, resource] of Object.entries(pluginConfig.resources ?? {})) {
76
92
  items.push({
77
93
  type: 'resource',
78
- key,
79
- label: resource.title ?? key,
80
- resource,
94
+ configKey,
95
+ label: resource.title ?? configKey,
96
+ mcpName: configKey,
97
+ resource: { ...resource, access: resource.access ?? defaultAccess },
81
98
  })
82
99
  }
83
100
 
84
- // Mirror Payload's own admin.user detection (sanitize.ts) since plugins run first.
85
- const firstCollectionWithAuth = config.collections!.find(({ auth }) => Boolean(auth))
86
-
87
101
  return {
88
102
  disabled: pluginConfig.disabled,
103
+ hooks: pluginConfig.hooks,
89
104
  items,
90
105
  mcp: pluginConfig.mcp,
91
- overrideApiKeyCollection: pluginConfig.overrideApiKeyCollection,
92
- overrideAuth: pluginConfig.overrideAuth,
93
- userCollection:
94
- pluginConfig.userCollection ?? config.admin?.user ?? firstCollectionWithAuth?.slug ?? 'users',
106
+ overrideGetAuthorizedMCP: pluginConfig.overrideGetAuthorizedMCP,
95
107
  }
96
108
  }
97
109
 
@@ -101,42 +113,78 @@ const sanitizeCollectionConfig = ({
101
113
  }: {
102
114
  collection: CollectionConfig | SanitizedCollectionConfig
103
115
  pluginConfig: MCPPluginConfig
104
- }): MCPItem[] => {
105
- if (collection.slug === 'payload-mcp-api-keys') {
106
- return []
107
- }
116
+ }): CollectionMCPItem[] => {
108
117
  const slug = collection.slug
109
118
  const collectionPluginConfig = pluginConfig.collections?.[slug]
110
- const items: MCPItem[] = []
119
+ const items: CollectionMCPItem[] = []
120
+ /**
121
+ * Payload disables duplicate for auth collections by default unless the
122
+ * collection explicitly opts back in with `disableDuplicate: false`.
123
+ */
124
+ const isDuplicateDisabled =
125
+ collection.disableDuplicate === true ||
126
+ (Boolean(collection.auth) && collection.disableDuplicate !== false)
111
127
 
112
- for (const [toolKey, tool] of COLLECTION_BUILTIN_ENTRIES) {
128
+ for (const [
129
+ toolKey,
130
+ { mcpName, requiresDuplicateEnabled, requiresVersions, tool },
131
+ ] of COLLECTION_BUILTIN_ENTRIES) {
132
+ if (requiresVersions && !collection.versions) {
133
+ continue
134
+ }
135
+ if (requiresDuplicateEnabled && isDuplicateDisabled) {
136
+ continue
137
+ }
113
138
  const matchedConfigEntry = collectionPluginConfig?.tools?.[toolKey]
114
139
  if (matchedConfigEntry === false) {
115
140
  continue
116
141
  }
142
+ const override = typeof matchedConfigEntry === 'object' ? matchedConfigEntry : undefined
143
+ const annotations = { ...tool.annotations, ...override?.annotations }
117
144
  items.push({
118
145
  type: 'collectionTool',
119
146
  collectionSlug: slug,
120
- key: toolKey,
121
- label: capitalize(toolKey),
122
- tool: overrideBuiltinTool(tool, matchedConfigEntry, collectionPluginConfig),
147
+ configKey: toolKey,
148
+ label: annotations.title ?? toolKey,
149
+ mcpName,
150
+ tool: {
151
+ ...tool,
152
+ access: override?.access ?? tool.access ?? defaultAccess,
153
+ annotations,
154
+ description: override?.description ?? tool.description,
155
+ overrideResponse:
156
+ override?.overrideResponse ??
157
+ collectionPluginConfig?.overrideResponse ??
158
+ tool.overrideResponse,
159
+ },
123
160
  })
124
161
  }
125
162
 
126
163
  if (collection.auth) {
127
- for (const [authToolKey, { label, tool }] of COLLECTION_AUTH_BUILTIN_ENTRIES) {
164
+ for (const [authToolKey, { mcpName, tool }] of COLLECTION_AUTH_BUILTIN_ENTRIES) {
128
165
  const matchedConfigEntry = collectionPluginConfig?.tools?.[authToolKey]
129
166
  if (!matchedConfigEntry) {
130
167
  continue
131
168
  }
132
169
  // `true` means "enable, no override"; only the object form carries fields.
133
170
  const override = typeof matchedConfigEntry === 'object' ? matchedConfigEntry : undefined
171
+ const annotations = { ...tool.annotations, ...override?.annotations }
134
172
  items.push({
135
173
  type: 'collectionTool',
136
174
  collectionSlug: slug,
137
- key: authToolKey,
138
- label,
139
- tool: overrideBuiltinTool(tool, override, collectionPluginConfig),
175
+ configKey: authToolKey,
176
+ label: annotations.title ?? authToolKey,
177
+ mcpName,
178
+ tool: {
179
+ ...tool,
180
+ access: override?.access ?? tool.access ?? defaultAccess,
181
+ annotations,
182
+ description: override?.description ?? tool.description,
183
+ overrideResponse:
184
+ override?.overrideResponse ??
185
+ collectionPluginConfig?.overrideResponse ??
186
+ tool.overrideResponse,
187
+ },
140
188
  })
141
189
  }
142
190
  }
@@ -146,8 +194,8 @@ const sanitizeCollectionConfig = ({
146
194
  const customEntries = Object.entries(collectionPluginConfig?.tools ?? {}) as Array<
147
195
  [string, CollectionTool | undefined]
148
196
  >
149
- for (const [key, customTool] of customEntries) {
150
- if (key in COLLECTION_BUILTINS || key in COLLECTION_AUTH_BUILTINS) {
197
+ for (const [configKey, customTool] of customEntries) {
198
+ if (configKey in COLLECTION_BUILTINS || configKey in COLLECTION_AUTH_BUILTINS) {
151
199
  continue
152
200
  }
153
201
  if (!customTool) {
@@ -156,9 +204,10 @@ const sanitizeCollectionConfig = ({
156
204
  items.push({
157
205
  type: 'collectionTool',
158
206
  collectionSlug: slug,
159
- key,
160
- label: key,
161
- tool: customTool,
207
+ configKey,
208
+ label: customTool.annotations?.title ?? configKey,
209
+ mcpName: configKey,
210
+ tool: { ...customTool, access: customTool.access ?? defaultAccess },
162
211
  })
163
212
  }
164
213
 
@@ -171,30 +220,45 @@ const sanitizeGlobalConfig = ({
171
220
  }: {
172
221
  global: GlobalConfig | SanitizedGlobalConfig
173
222
  pluginConfig: MCPPluginConfig
174
- }): MCPItem[] => {
223
+ }): GlobalMCPItem[] => {
175
224
  const slug = global.slug
176
225
  const globalPluginConfig = pluginConfig.globals?.[slug]
177
- const items: MCPItem[] = []
226
+ const items: GlobalMCPItem[] = []
178
227
 
179
- for (const [toolKey, baseTool] of GLOBAL_BUILTIN_ENTRIES) {
228
+ for (const [toolKey, { mcpName, requiresVersions, tool }] of GLOBAL_BUILTIN_ENTRIES) {
229
+ if (requiresVersions && !global.versions) {
230
+ continue
231
+ }
180
232
  const matchedConfigEntry = globalPluginConfig?.tools?.[toolKey]
181
233
  if (matchedConfigEntry === false) {
182
234
  continue
183
235
  }
236
+ const override = typeof matchedConfigEntry === 'object' ? matchedConfigEntry : undefined
237
+ const annotations = { ...tool.annotations, ...override?.annotations }
184
238
  items.push({
185
239
  type: 'globalTool',
240
+ configKey: toolKey,
186
241
  globalSlug: slug,
187
- key: toolKey,
188
- label: capitalize(toolKey),
189
- tool: overrideBuiltinTool(baseTool, matchedConfigEntry, globalPluginConfig),
242
+ label: annotations.title ?? toolKey,
243
+ mcpName,
244
+ tool: {
245
+ ...tool,
246
+ access: override?.access ?? tool.access ?? defaultAccess,
247
+ annotations,
248
+ description: override?.description ?? tool.description,
249
+ overrideResponse:
250
+ override?.overrideResponse ??
251
+ globalPluginConfig?.overrideResponse ??
252
+ tool.overrideResponse,
253
+ },
190
254
  })
191
255
  }
192
256
 
193
257
  const customEntries = Object.entries(globalPluginConfig?.tools ?? {}) as Array<
194
258
  [string, GlobalTool | undefined]
195
259
  >
196
- for (const [key, customTool] of customEntries) {
197
- if (key in GLOBAL_BUILTINS) {
260
+ for (const [configKey, customTool] of customEntries) {
261
+ if (configKey in GLOBAL_BUILTINS) {
198
262
  continue
199
263
  }
200
264
  if (!customTool) {
@@ -202,38 +266,13 @@ const sanitizeGlobalConfig = ({
202
266
  }
203
267
  items.push({
204
268
  type: 'globalTool',
269
+ configKey,
205
270
  globalSlug: slug,
206
- key,
207
- label: key,
208
- tool: customTool,
271
+ label: customTool.annotations?.title ?? configKey,
272
+ mcpName: configKey,
273
+ tool: { ...customTool, access: customTool.access ?? defaultAccess },
209
274
  })
210
275
  }
211
276
 
212
277
  return items
213
278
  }
214
-
215
- const capitalize = (s: string): string => s.charAt(0).toUpperCase() + s.slice(1)
216
-
217
- /**
218
- * Spread the static built-in tool and apply consumer-side overrides.
219
- * Precedence: per-tool override > scope-level (collection/global) override >
220
- * the static tool's defaults. `toolEntry` is whatever the user put under
221
- * `tools: { find: ... }` — could be `true`, `false`, or an override object —
222
- * so it's narrowed internally.
223
- */
224
- const overrideBuiltinTool = <TTool extends CollectionTool | GlobalTool>(
225
- tool: TTool,
226
- toolOverride?: MCPBuiltInToolOverride,
227
- entityPluginConfig?: TTool extends CollectionTool
228
- ? MCPPluginCollectionConfig<any>
229
- : MCPPluginGlobalConfig,
230
- ): TTool => {
231
- return {
232
- ...tool,
233
- description: toolOverride?.description ?? entityPluginConfig?.description ?? tool.description,
234
- overrideResponse:
235
- toolOverride?.overrideResponse ??
236
- entityPluginConfig?.overrideResponse ??
237
- tool.overrideResponse,
238
- }
239
- }