@payloadcms/plugin-mcp 4.0.0-internal.40de3ec → 4.0.0-internal.45cfa3d

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 (221) hide show
  1. package/LICENSE.md +1 -1
  2. package/dist/defaultAccess.d.ts +3 -0
  3. package/dist/defaultAccess.d.ts.map +1 -0
  4. package/dist/defaultAccess.js +3 -0
  5. package/dist/defaultAccess.js.map +1 -0
  6. package/dist/endpoint/access.d.ts +17 -5
  7. package/dist/endpoint/access.d.ts.map +1 -1
  8. package/dist/endpoint/access.js +82 -88
  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 +68 -17
  13. package/dist/endpoint/index.js.map +1 -1
  14. package/dist/exports/client.d.ts +1 -1
  15. package/dist/exports/client.d.ts.map +1 -1
  16. package/dist/exports/client.js +1 -1
  17. package/dist/exports/client.js.map +1 -1
  18. package/dist/exports/internal.d.ts +2 -0
  19. package/dist/exports/internal.d.ts.map +1 -0
  20. package/dist/exports/internal.js +3 -0
  21. package/dist/exports/internal.js.map +1 -0
  22. package/dist/index.d.ts +2 -2
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +15 -20
  25. package/dist/index.js.map +1 -1
  26. package/dist/mcp/buildMcpServer.d.ts +4 -4
  27. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  28. package/dist/mcp/buildMcpServer.js +133 -80
  29. package/dist/mcp/buildMcpServer.js.map +1 -1
  30. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  31. package/dist/mcp/builtin/collections/authTools.js +44 -6
  32. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  33. package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
  34. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
  35. package/dist/mcp/builtin/collections/countTool.js +69 -0
  36. package/dist/mcp/builtin/collections/countTool.js.map +1 -0
  37. package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
  38. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
  39. package/dist/mcp/builtin/collections/countVersionsTool.js +65 -0
  40. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
  41. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  42. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  43. package/dist/mcp/builtin/collections/createTool.js +38 -42
  44. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  45. package/dist/mcp/builtin/collections/deleteTool.d.ts +1 -1
  46. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  47. package/dist/mcp/builtin/collections/deleteTool.js +14 -20
  48. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  49. package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
  50. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
  51. package/dist/mcp/builtin/collections/duplicateTool.js +97 -0
  52. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
  53. package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
  54. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
  55. package/dist/mcp/builtin/collections/findDistinctTool.js +93 -0
  56. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
  57. package/dist/mcp/builtin/collections/findTool.d.ts +1 -1
  58. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  59. package/dist/mcp/builtin/collections/findTool.js +49 -43
  60. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  61. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
  62. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
  63. package/dist/mcp/builtin/collections/findVersionByIDTool.js +84 -0
  64. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
  65. package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
  66. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
  67. package/dist/mcp/builtin/collections/findVersionsTool.js +99 -0
  68. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
  69. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +9 -0
  70. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -0
  71. package/dist/mcp/builtin/collections/formatCollectionError.js +60 -0
  72. package/dist/mcp/builtin/collections/formatCollectionError.js.map +1 -0
  73. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
  74. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
  75. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +47 -0
  76. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
  77. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
  78. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
  79. package/dist/mcp/builtin/collections/restoreVersionTool.js +82 -0
  80. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
  81. package/dist/mcp/builtin/collections/updateTool.d.ts +1 -1
  82. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  83. package/dist/mcp/builtin/collections/updateTool.js +87 -86
  84. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  85. package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
  86. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
  87. package/dist/mcp/builtin/getConfigInfoTool.js +71 -0
  88. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
  89. package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
  90. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
  91. package/dist/mcp/builtin/globals/countVersionsTool.js +65 -0
  92. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
  93. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  94. package/dist/mcp/builtin/globals/findTool.js +18 -21
  95. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  96. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
  97. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
  98. package/dist/mcp/builtin/globals/findVersionByIDTool.js +80 -0
  99. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
  100. package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
  101. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
  102. package/dist/mcp/builtin/globals/findVersionsTool.js +95 -0
  103. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
  104. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
  105. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
  106. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +47 -0
  107. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
  108. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
  109. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
  110. package/dist/mcp/builtin/globals/restoreVersionTool.js +78 -0
  111. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
  112. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  113. package/dist/mcp/builtin/globals/updateTool.js +31 -40
  114. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  115. package/dist/mcp/builtin/validateEntityData.d.ts +14 -0
  116. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -0
  117. package/dist/mcp/builtin/validateEntityData.js +82 -0
  118. package/dist/mcp/builtin/validateEntityData.js.map +1 -0
  119. package/dist/mcp/builtinTools.d.ts +144 -19
  120. package/dist/mcp/builtinTools.d.ts.map +1 -1
  121. package/dist/mcp/builtinTools.js +119 -20
  122. package/dist/mcp/builtinTools.js.map +1 -1
  123. package/dist/mcp/sanitizeMCPConfig.d.ts +0 -1
  124. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  125. package/dist/mcp/sanitizeMCPConfig.js +121 -58
  126. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  127. package/dist/stdio.d.ts +3 -3
  128. package/dist/stdio.d.ts.map +1 -1
  129. package/dist/stdio.js +82 -45
  130. package/dist/stdio.js.map +1 -1
  131. package/dist/types.d.ts +75 -110
  132. package/dist/types.d.ts.map +1 -1
  133. package/dist/types.js +4 -4
  134. package/dist/types.js.map +1 -1
  135. package/dist/utils/getPluginConfig.d.ts +1 -1
  136. package/dist/utils/getPluginConfig.js +1 -1
  137. package/dist/utils/getPluginConfig.js.map +1 -1
  138. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +11 -0
  139. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -0
  140. package/dist/utils/schemaConversion/getEntityInputSchema.js +32 -0
  141. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -0
  142. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +5 -10
  143. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -1
  144. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +15 -95
  145. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -1
  146. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +15 -40
  147. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -1
  148. package/dist/utils/whereSchema.d.ts +9 -0
  149. package/dist/utils/whereSchema.d.ts.map +1 -0
  150. package/dist/utils/whereSchema.js +13 -0
  151. package/dist/utils/whereSchema.js.map +1 -0
  152. package/package.json +10 -15
  153. package/src/defaultAccess.ts +3 -0
  154. package/src/endpoint/access.ts +88 -101
  155. package/src/endpoint/index.ts +58 -16
  156. package/src/exports/client.ts +2 -1
  157. package/src/exports/internal.ts +1 -0
  158. package/src/index.ts +12 -20
  159. package/src/mcp/buildMcpServer.ts +170 -115
  160. package/src/mcp/builtin/collections/authTools.ts +45 -9
  161. package/src/mcp/builtin/collections/countTool.ts +74 -0
  162. package/src/mcp/builtin/collections/countVersionsTool.ts +73 -0
  163. package/src/mcp/builtin/collections/createTool.ts +55 -59
  164. package/src/mcp/builtin/collections/deleteTool.ts +19 -16
  165. package/src/mcp/builtin/collections/duplicateTool.ts +135 -0
  166. package/src/mcp/builtin/collections/findDistinctTool.ts +119 -0
  167. package/src/mcp/builtin/collections/findTool.ts +63 -33
  168. package/src/mcp/builtin/collections/findVersionByIDTool.ts +110 -0
  169. package/src/mcp/builtin/collections/findVersionsTool.ts +155 -0
  170. package/src/mcp/builtin/collections/formatCollectionError.ts +84 -0
  171. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +46 -0
  172. package/src/mcp/builtin/collections/restoreVersionTool.ts +108 -0
  173. package/src/mcp/builtin/collections/updateTool.ts +111 -110
  174. package/src/mcp/builtin/getConfigInfoTool.ts +69 -0
  175. package/src/mcp/builtin/globals/countVersionsTool.ts +72 -0
  176. package/src/mcp/builtin/globals/findTool.ts +26 -17
  177. package/src/mcp/builtin/globals/findVersionByIDTool.ts +104 -0
  178. package/src/mcp/builtin/globals/findVersionsTool.ts +148 -0
  179. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +41 -0
  180. package/src/mcp/builtin/globals/restoreVersionTool.ts +99 -0
  181. package/src/mcp/builtin/globals/updateTool.ts +50 -55
  182. package/src/mcp/builtin/validateEntityData.ts +132 -0
  183. package/src/mcp/builtinTools.ts +111 -41
  184. package/src/mcp/sanitizeMCPConfig.ts +117 -78
  185. package/src/stdio.ts +77 -45
  186. package/src/types.ts +92 -115
  187. package/src/utils/getPluginConfig.ts +1 -1
  188. package/src/utils/schemaConversion/getEntityInputSchema.ts +62 -0
  189. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +12 -19
  190. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +17 -114
  191. package/src/utils/whereSchema.ts +24 -0
  192. package/dist/@types/assets.d.js +0 -2
  193. package/dist/@types/assets.d.js.map +0 -1
  194. package/dist/collection/getAccessField.d.ts +0 -12
  195. package/dist/collection/getAccessField.d.ts.map +0 -1
  196. package/dist/collection/getAccessField.js +0 -57
  197. package/dist/collection/getAccessField.js.map +0 -1
  198. package/dist/collection/index.d.ts +0 -6
  199. package/dist/collection/index.d.ts.map +0 -1
  200. package/dist/collection/index.js +0 -60
  201. package/dist/collection/index.js.map +0 -1
  202. package/dist/components/AccessField/index.client.d.ts +0 -10
  203. package/dist/components/AccessField/index.client.d.ts.map +0 -1
  204. package/dist/components/AccessField/index.client.js +0 -305
  205. package/dist/components/AccessField/index.client.js.map +0 -1
  206. package/dist/components/AccessField/index.css +0 -93
  207. package/dist/utils/schemaConversion/buildToolInput.d.ts +0 -29
  208. package/dist/utils/schemaConversion/buildToolInput.d.ts.map +0 -1
  209. package/dist/utils/schemaConversion/buildToolInput.js +0 -51
  210. package/dist/utils/schemaConversion/buildToolInput.js.map +0 -1
  211. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  212. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  213. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  214. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  215. package/src/@types/assets.d.ts +0 -3
  216. package/src/collection/getAccessField.ts +0 -64
  217. package/src/collection/index.ts +0 -64
  218. package/src/components/AccessField/index.client.tsx +0 -344
  219. package/src/components/AccessField/index.css +0 -93
  220. package/src/utils/schemaConversion/buildToolInput.ts +0 -68
  221. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
@@ -1,30 +1,22 @@
1
1
  import type { JsonSchemaType } from '../../types.js'
2
2
 
3
3
  /**
4
- * Turns the JSON Schema that Payload generates for a collection or global into the input schema for
5
- * an MCP create/update tool. In short, it:
6
- *
7
- * - drops fields a client can't set (`id`, `createdAt`, the draft `_status`, …),
8
- * - rewrites Payload-specific field shapes (points, relationships) into plain JSON the model can fill,
9
- * - and shrinks the result so it's cheaper for the model to read,
10
- *
11
- * while keeping every node valid JSON Schema draft 2020-12. Each step below is tagged with why it runs -
12
- * **Correctness** (valid input the API accepts), **Size** (equivalence-preserving shrink), or **LLM
13
- * ergonomics** (easier for the model to read/fill) - and carries a before/after example on its definition.
4
+ * Refines Payload's `input`-variant JSON Schema into an MCP create/update tool's input schema. The
5
+ * variant already covers correctness (ID-only relationships, no managed/virtual/join fields); the
6
+ * passes here are MCP-specific - reshaping fields for the model and shrinking the result - and keep
7
+ * every node valid JSON Schema draft 2020-12. Each is tagged **Correctness**, **Size**, or **LLM
8
+ * ergonomics**, with a before/after example on its definition.
14
9
  */
15
10
  export const sanitizeEntitySchema = (schema: JsonSchemaType): JsonSchemaType => {
16
11
  // Work on a copy — the caller reuses the original schema elsewhere (e.g. when listing tools).
17
12
  let result = structuredClone(schema)
18
13
 
19
- // Correctness — drop the fields a client can't set (id, createdAt, updatedAt, draft _status) + collapse nullable types.
20
- result = removeManagedFields(result)
14
+ // LLM ergonomics — drop the redundant `'null'` from optional arrays/objects (`['array','null']` `'array'`).
15
+ result = collapseOptionalContainerTypes(result)
21
16
 
22
17
  // LLM ergonomics — rewrite point fields from a `[number, number]` tuple into a `{ longitude, latitude }` object.
23
18
  result = pointFieldsToObjects(result)
24
19
 
25
- // Correctness — a relationship value can be an ID or a populated doc; on input only the ID is valid, so keep that.
26
- result = relationshipsToIds(result)
27
-
28
20
  // Size — strip inert type-gen leftovers that only bloat the schema (`tsType`, block-collision notes).
29
21
  result = removeTypeGenArtifacts(result)
30
22
 
@@ -58,26 +50,20 @@ const mapNodes = (node: unknown, visit: (node: JsonSchemaType) => JsonSchemaType
58
50
  for (const [key, value] of Object.entries(node)) {
59
51
  out[key] = mapNodes(value, visit)
60
52
  }
61
- return visit(out as JsonSchemaType)
53
+ return visit(out)
62
54
  }
63
55
 
64
- // Payload sets these on every document, so an MCP client never provides them when creating/updating.
65
- const PAYLOAD_MANAGED_FIELDS = new Set(['_status', 'createdAt', 'id', 'updatedAt'])
66
-
67
56
  /**
68
- * **Correctness.** Removes the fields a client can't set on create/update - `id`, `createdAt`, `updatedAt`, and the draft
69
- * `_status` - from every field object's `properties` and `required` (recursing into nested objects and
70
- * array items). Along the way it also collapses optional array/object types via {@link collapseNullableType}.
57
+ * **LLM ergonomics.** Collapses optional array/object types (`['array', 'null']` `'array'`) via
58
+ * {@link collapseNullableType}, recursing through `properties` and array items. The `required` list
59
+ * already conveys optionality, so the `'null'` is redundant noise for the model.
71
60
  *
72
61
  * @example
73
- * { properties: { id: { type: 'string' }, tags: { type: ['array', 'null'], items: {} } }, required: ['id', 'tags'] }
74
- * → { properties: { tags: { type: 'array', items: {} } }, required: ['tags'] }
62
+ * { properties: { tags: { type: ['array', 'null'], items: {} } }, required: [] }
63
+ * → { properties: { tags: { type: 'array', items: {} } }, required: [] }
75
64
  */
76
- const removeManagedFields = (schema: JsonSchemaType): JsonSchemaType => {
65
+ const collapseOptionalContainerTypes = (schema: JsonSchemaType): JsonSchemaType => {
77
66
  if (schema.properties && typeof schema.properties === 'object') {
78
- for (const field of PAYLOAD_MANAGED_FIELDS) {
79
- delete schema.properties[field]
80
- }
81
67
  for (const key of Object.keys(schema.properties)) {
82
68
  const prop = schema.properties[key] as JsonSchemaType
83
69
  if (!prop || typeof prop !== 'object') {
@@ -86,21 +72,14 @@ const removeManagedFields = (schema: JsonSchemaType): JsonSchemaType => {
86
72
  const isRequired = Array.isArray(schema.required) && schema.required.includes(key)
87
73
  collapseNullableType(prop, isRequired)
88
74
  if (prop.properties) {
89
- removeManagedFields(prop)
75
+ collapseOptionalContainerTypes(prop)
90
76
  }
91
77
  if (prop.items && typeof prop.items === 'object' && !Array.isArray(prop.items)) {
92
- removeManagedFields(prop.items)
78
+ collapseOptionalContainerTypes(prop.items)
93
79
  }
94
80
  }
95
81
  }
96
82
 
97
- if (Array.isArray(schema.required)) {
98
- schema.required = schema.required.filter((name) => !PAYLOAD_MANAGED_FIELDS.has(name))
99
- if (schema.required.length === 0) {
100
- delete schema.required
101
- }
102
- }
103
-
104
83
  return schema
105
84
  }
106
85
 
@@ -193,82 +172,6 @@ const pointFieldsToObjects = (schema: JsonSchemaType): JsonSchemaType => {
193
172
  return transformed
194
173
  }
195
174
 
196
- /**
197
- * **Correctness.** Reduces relationship/upload fields to the IDs a client actually sends. Payload types the value as
198
- * "an ID or the full related document" - but the populated-document form only appears in read responses;
199
- * on create/update you always reference a relationship by its ID. So we drop that `$ref` option, leaving
200
- * the bare ID. A single remaining target collapses inline (with a description naming the target
201
- * collection); several targets become an `anyOf` of IDs.
202
- *
203
- * @example
204
- * { oneOf: [{ type: 'string' }, { $ref: '#/$defs/posts' }] }
205
- * → { type: 'string', description: 'The ID of the related "posts" document.' }
206
- */
207
- const relationshipsToIds = (schema: JsonSchemaType): JsonSchemaType => {
208
- if (!schema || typeof schema !== 'object') {
209
- return schema
210
- }
211
-
212
- const processed = { ...schema }
213
-
214
- if (Array.isArray(processed.oneOf)) {
215
- const isRelatedDocRef = (option: unknown): option is { $ref: string } =>
216
- !!option && typeof option === 'object' && '$ref' in option
217
-
218
- if (processed.oneOf.some(isRelatedDocRef)) {
219
- // A relationship value is "an ID, or the populated related document". Keep the ID option(s) and
220
- // drop the `$ref`s to the related collections, since a client only ever sends the ID.
221
- const idOptions = processed.oneOf
222
- .filter((option) => !isRelatedDocRef(option))
223
- .map((option) => (typeof option === 'object' ? relationshipsToIds(option) : option))
224
- const targetCollections = processed.oneOf
225
- .filter(isRelatedDocRef)
226
- .map((option) => option.$ref.replace('#/$defs/', ''))
227
-
228
- if (idOptions.length === 1) {
229
- delete processed.oneOf
230
- Object.assign(processed, idOptions[0])
231
- if (targetCollections.length > 0 && !processed.description) {
232
- processed.description = `The ID of the related "${targetCollections.join('" or "')}" document.`
233
- }
234
- } else if (idOptions.length > 1) {
235
- delete processed.oneOf
236
- processed.anyOf = idOptions
237
- }
238
- } else {
239
- processed.oneOf = processed.oneOf.map((option) =>
240
- typeof option === 'object' ? relationshipsToIds(option) : option,
241
- )
242
- }
243
- }
244
-
245
- if (processed.properties && typeof processed.properties === 'object') {
246
- processed.properties = Object.fromEntries(
247
- Object.entries(processed.properties).map(([key, value]) => [
248
- key,
249
- typeof value === 'object' ? relationshipsToIds(value) : value,
250
- ]),
251
- )
252
- }
253
-
254
- if (processed.items && typeof processed.items === 'object' && !Array.isArray(processed.items)) {
255
- processed.items = relationshipsToIds(processed.items)
256
- }
257
-
258
- // Lexical node unions and blocks live under `$defs` and have their own relationship fields, so walk
259
- // those too — otherwise their `$ref`s would dangle once we don't bundle the related collections.
260
- if (processed.$defs && typeof processed.$defs === 'object') {
261
- processed.$defs = Object.fromEntries(
262
- Object.entries(processed.$defs).map(([key, value]) => [
263
- key,
264
- typeof value === 'object' ? relationshipsToIds(value) : value,
265
- ]),
266
- )
267
- }
268
-
269
- return processed
270
- }
271
-
272
175
  /**
273
176
  * **Size.** Strips type-generation leftovers that bloat the schema without helping the model: the `tsType`
274
177
  * hint (a `json-schema-to-typescript` extension; JSON Schema validators just ignore it, they don't reject it)
@@ -448,7 +351,7 @@ const deduplicateIntoDefinitions = (schema: JsonSchemaType): JsonSchemaType => {
448
351
  if (!name) {
449
352
  name = `shared_${nameByKey.size}`
450
353
  nameByKey.set(key, name)
451
- sharedEntries[name] = node as JsonSchemaType
354
+ sharedEntries[name] = node
452
355
  }
453
356
  return { $ref: `#/$defs/${name}` }
454
357
  }
@@ -0,0 +1,24 @@
1
+ import type { Where } from 'payload'
2
+
3
+ import { validOperators } from 'payload/shared'
4
+ import { z } from 'zod'
5
+
6
+ const whereFieldSchema = z
7
+ .partialRecord(z.enum(validOperators), z.unknown())
8
+ .describe('Field query operators')
9
+
10
+ /**
11
+ * - Validates the `where` input of collection tools against Payload's `Where` shape
12
+ * - Field keys map to operator objects restricted to `validOperators`
13
+ * - `and` / `or` nest recursively
14
+ */
15
+ export const whereSchema: z.ZodType<Where> = z
16
+ .lazy(() =>
17
+ z
18
+ .object({
19
+ and: z.array(whereSchema).optional(),
20
+ or: z.array(whereSchema).optional(),
21
+ })
22
+ .catchall(whereFieldSchema),
23
+ )
24
+ .describe('Where clause using field names with Payload query operators, plus and/or groups')
@@ -1,2 +0,0 @@
1
-
2
- //# sourceMappingURL=assets.d.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/@types/assets.d.ts"],"names":[],"mappings":""}
@@ -1,12 +0,0 @@
1
- import type { JSONField } from 'payload';
2
- import type { SanitizedMCPPluginConfig } from '../types.js';
3
- /**
4
- * Returns the API key collection's `access` field — a JSON field whose value
5
- * is the `MCPAPIKeysDocAccessTree` the endpoint consults. The actual UI is
6
- * a custom client component (`AccessField`) which renders a permissions
7
- * matrix; the field's stored shape is just the runtime access tree.
8
- */
9
- export declare const getAccessField: ({ pluginConfig, }: {
10
- pluginConfig: SanitizedMCPPluginConfig;
11
- }) => JSONField;
12
- //# sourceMappingURL=getAccessField.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getAccessField.d.ts","sourceRoot":"","sources":["../../src/collection/getAccessField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC,OAAO,KAAK,EAAkC,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAE3F;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,mBAE5B;IACD,YAAY,EAAE,wBAAwB,CAAA;CACvC,KAAG,SAqBH,CAAA"}
@@ -1,57 +0,0 @@
1
- /**
2
- * Returns the API key collection's `access` field — a JSON field whose value
3
- * is the `MCPAPIKeysDocAccessTree` the endpoint consults. The actual UI is
4
- * a custom client component (`AccessField`) which renders a permissions
5
- * matrix; the field's stored shape is just the runtime access tree.
6
- */ export const getAccessField = ({ pluginConfig })=>{
7
- const clientPluginConfig = sanitizeClientPluginConfig(pluginConfig);
8
- return {
9
- name: 'access',
10
- type: 'json',
11
- admin: {
12
- components: {
13
- Field: {
14
- clientProps: {
15
- pluginConfig: clientPluginConfig
16
- },
17
- path: '@payloadcms/plugin-mcp/client#AccessField'
18
- }
19
- },
20
- // TODO: needs i18n once design is finalized
21
- description: 'Access for this API key — uncheck to revoke individual tools.',
22
- position: 'sidebar'
23
- },
24
- defaultValue: {},
25
- // TODO: needs i18n once design is finalized
26
- label: 'Access'
27
- };
28
- };
29
- /**
30
- * Strips the non-serializable parts of `SanitizedMCPPluginConfig` (handlers,
31
- * input/argsSchema functions, etc.) so the result is safe to thread to a
32
- * client component via `clientProps`.
33
- */ const sanitizeClientPluginConfig = (pluginConfig)=>({
34
- items: pluginConfig.items.map((item)=>({
35
- ...item.type === 'collectionTool' ? {
36
- collectionSlug: item.collectionSlug
37
- } : {},
38
- ...item.type === 'globalTool' ? {
39
- globalSlug: item.globalSlug
40
- } : {},
41
- type: item.type,
42
- description: itemDescription(item),
43
- key: item.key,
44
- label: item.label
45
- }))
46
- });
47
- const itemDescription = (item)=>{
48
- if (item.type === 'prompt') {
49
- return item.prompt.description;
50
- }
51
- if (item.type === 'resource') {
52
- return item.resource.description;
53
- }
54
- return item.tool.description;
55
- };
56
-
57
- //# sourceMappingURL=getAccessField.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/collection/getAccessField.ts"],"sourcesContent":["import type { JSONField } from 'payload'\n\nimport type { ClientMCPPluginConfig, MCPItem, SanitizedMCPPluginConfig } from '../types.js'\n\n/**\n * Returns the API key collection's `access` field — a JSON field whose value\n * is the `MCPAPIKeysDocAccessTree` the endpoint consults. The actual UI is\n * a custom client component (`AccessField`) which renders a permissions\n * matrix; the field's stored shape is just the runtime access tree.\n */\nexport const getAccessField = ({\n pluginConfig,\n}: {\n pluginConfig: SanitizedMCPPluginConfig\n}): JSONField => {\n const clientPluginConfig = sanitizeClientPluginConfig(pluginConfig)\n\n return {\n name: 'access',\n type: 'json',\n admin: {\n components: {\n Field: {\n clientProps: { pluginConfig: clientPluginConfig },\n path: '@payloadcms/plugin-mcp/client#AccessField',\n },\n },\n // TODO: needs i18n once design is finalized\n description: 'Access for this API key — uncheck to revoke individual tools.',\n position: 'sidebar',\n },\n defaultValue: {},\n // TODO: needs i18n once design is finalized\n label: 'Access',\n }\n}\n\n/**\n * Strips the non-serializable parts of `SanitizedMCPPluginConfig` (handlers,\n * input/argsSchema functions, etc.) so the result is safe to thread to a\n * client component via `clientProps`.\n */\nconst sanitizeClientPluginConfig = (\n pluginConfig: SanitizedMCPPluginConfig,\n): ClientMCPPluginConfig => ({\n items: pluginConfig.items.map((item) => ({\n ...(item.type === 'collectionTool' ? { collectionSlug: item.collectionSlug } : {}),\n ...(item.type === 'globalTool' ? { globalSlug: item.globalSlug } : {}),\n type: item.type,\n description: itemDescription(item),\n key: item.key,\n label: item.label,\n })),\n})\n\nconst itemDescription = (item: MCPItem): string => {\n if (item.type === 'prompt') {\n return item.prompt.description\n }\n if (item.type === 'resource') {\n return item.resource.description\n }\n return item.tool.description\n}\n"],"names":["getAccessField","pluginConfig","clientPluginConfig","sanitizeClientPluginConfig","name","type","admin","components","Field","clientProps","path","description","position","defaultValue","label","items","map","item","collectionSlug","globalSlug","itemDescription","key","prompt","resource","tool"],"mappings":"AAIA;;;;;CAKC,GACD,OAAO,MAAMA,iBAAiB,CAAC,EAC7BC,YAAY,EAGb;IACC,MAAMC,qBAAqBC,2BAA2BF;IAEtD,OAAO;QACLG,MAAM;QACNC,MAAM;QACNC,OAAO;YACLC,YAAY;gBACVC,OAAO;oBACLC,aAAa;wBAAER,cAAcC;oBAAmB;oBAChDQ,MAAM;gBACR;YACF;YACA,4CAA4C;YAC5CC,aAAa;YACbC,UAAU;QACZ;QACAC,cAAc,CAAC;QACf,4CAA4C;QAC5CC,OAAO;IACT;AACF,EAAC;AAED;;;;CAIC,GACD,MAAMX,6BAA6B,CACjCF,eAC2B,CAAA;QAC3Bc,OAAOd,aAAac,KAAK,CAACC,GAAG,CAAC,CAACC,OAAU,CAAA;gBACvC,GAAIA,KAAKZ,IAAI,KAAK,mBAAmB;oBAAEa,gBAAgBD,KAAKC,cAAc;gBAAC,IAAI,CAAC,CAAC;gBACjF,GAAID,KAAKZ,IAAI,KAAK,eAAe;oBAAEc,YAAYF,KAAKE,UAAU;gBAAC,IAAI,CAAC,CAAC;gBACrEd,MAAMY,KAAKZ,IAAI;gBACfM,aAAaS,gBAAgBH;gBAC7BI,KAAKJ,KAAKI,GAAG;gBACbP,OAAOG,KAAKH,KAAK;YACnB,CAAA;IACF,CAAA;AAEA,MAAMM,kBAAkB,CAACH;IACvB,IAAIA,KAAKZ,IAAI,KAAK,UAAU;QAC1B,OAAOY,KAAKK,MAAM,CAACX,WAAW;IAChC;IACA,IAAIM,KAAKZ,IAAI,KAAK,YAAY;QAC5B,OAAOY,KAAKM,QAAQ,CAACZ,WAAW;IAClC;IACA,OAAOM,KAAKO,IAAI,CAACb,WAAW;AAC9B"}
@@ -1,6 +0,0 @@
1
- import type { CollectionConfig } from 'payload';
2
- import type { SanitizedMCPPluginConfig } from '../types.js';
3
- export declare const getAPIKeysCollection: ({ pluginConfig, }: {
4
- pluginConfig: SanitizedMCPPluginConfig;
5
- }) => CollectionConfig;
6
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAI3D,eAAO,MAAM,oBAAoB,GAAI,mBAElC;IACD,YAAY,EAAE,wBAAwB,CAAA;CACvC,KAAG,gBAqDH,CAAA"}
@@ -1,60 +0,0 @@
1
- import { getAccessField } from './getAccessField.js';
2
- export const getAPIKeysCollection = ({ pluginConfig })=>{
3
- const collection = {
4
- slug: 'payload-mcp-api-keys',
5
- admin: {
6
- description: 'API keys control which collections, resources, tools, and prompts MCP clients can access',
7
- group: 'MCP',
8
- useAsTitle: 'label'
9
- },
10
- auth: {
11
- disableLocalStrategy: true,
12
- useAPIKey: true
13
- },
14
- fields: [
15
- {
16
- name: 'user',
17
- type: 'relationship',
18
- admin: {
19
- description: 'The user that the API key is associated with.'
20
- },
21
- relationTo: pluginConfig.userCollection,
22
- required: true
23
- },
24
- {
25
- name: 'label',
26
- type: 'text',
27
- admin: {
28
- description: 'A useful label for the API key.'
29
- }
30
- },
31
- {
32
- name: 'description',
33
- type: 'text',
34
- admin: {
35
- description: 'The purpose of the API key.'
36
- }
37
- },
38
- {
39
- name: 'overrideAccess',
40
- type: 'checkbox',
41
- admin: {
42
- description: 'When checked, this key bypasses Payload access control on every operation it performs. Leave unchecked unless you have a specific reason.'
43
- },
44
- defaultValue: false,
45
- label: 'Override access control'
46
- },
47
- getAccessField({
48
- pluginConfig
49
- })
50
- ],
51
- labels: {
52
- plural: 'API Keys',
53
- singular: 'API Key'
54
- },
55
- versions: false
56
- };
57
- return pluginConfig.overrideApiKeyCollection ? pluginConfig.overrideApiKeyCollection(collection) : collection;
58
- };
59
-
60
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/collection/index.ts"],"sourcesContent":["import type { CollectionConfig } from 'payload'\n\nimport type { SanitizedMCPPluginConfig } from '../types.js'\n\nimport { getAccessField } from './getAccessField.js'\n\nexport const getAPIKeysCollection = ({\n pluginConfig,\n}: {\n pluginConfig: SanitizedMCPPluginConfig\n}): CollectionConfig => {\n const collection: CollectionConfig = {\n slug: 'payload-mcp-api-keys',\n admin: {\n description:\n 'API keys control which collections, resources, tools, and prompts MCP clients can access',\n group: 'MCP',\n useAsTitle: 'label',\n },\n auth: {\n disableLocalStrategy: true,\n useAPIKey: true,\n },\n fields: [\n {\n name: 'user',\n type: 'relationship',\n admin: { description: 'The user that the API key is associated with.' },\n relationTo: pluginConfig.userCollection,\n required: true,\n },\n {\n name: 'label',\n type: 'text',\n admin: { description: 'A useful label for the API key.' },\n },\n {\n name: 'description',\n type: 'text',\n admin: { description: 'The purpose of the API key.' },\n },\n {\n name: 'overrideAccess',\n type: 'checkbox',\n admin: {\n description:\n 'When checked, this key bypasses Payload access control on every operation it performs. Leave unchecked unless you have a specific reason.',\n },\n defaultValue: false,\n label: 'Override access control',\n },\n getAccessField({ pluginConfig }),\n ],\n labels: {\n plural: 'API Keys',\n singular: 'API Key',\n },\n versions: false,\n }\n\n return pluginConfig.overrideApiKeyCollection\n ? pluginConfig.overrideApiKeyCollection(collection)\n : collection\n}\n"],"names":["getAccessField","getAPIKeysCollection","pluginConfig","collection","slug","admin","description","group","useAsTitle","auth","disableLocalStrategy","useAPIKey","fields","name","type","relationTo","userCollection","required","defaultValue","label","labels","plural","singular","versions","overrideApiKeyCollection"],"mappings":"AAIA,SAASA,cAAc,QAAQ,sBAAqB;AAEpD,OAAO,MAAMC,uBAAuB,CAAC,EACnCC,YAAY,EAGb;IACC,MAAMC,aAA+B;QACnCC,MAAM;QACNC,OAAO;YACLC,aACE;YACFC,OAAO;YACPC,YAAY;QACd;QACAC,MAAM;YACJC,sBAAsB;YACtBC,WAAW;QACb;QACAC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNT,OAAO;oBAAEC,aAAa;gBAAgD;gBACtES,YAAYb,aAAac,cAAc;gBACvCC,UAAU;YACZ;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNT,OAAO;oBAAEC,aAAa;gBAAkC;YAC1D;YACA;gBACEO,MAAM;gBACNC,MAAM;gBACNT,OAAO;oBAAEC,aAAa;gBAA8B;YACtD;YACA;gBACEO,MAAM;gBACNC,MAAM;gBACNT,OAAO;oBACLC,aACE;gBACJ;gBACAY,cAAc;gBACdC,OAAO;YACT;YACAnB,eAAe;gBAAEE;YAAa;SAC/B;QACDkB,QAAQ;YACNC,QAAQ;YACRC,UAAU;QACZ;QACAC,UAAU;IACZ;IAEA,OAAOrB,aAAasB,wBAAwB,GACxCtB,aAAasB,wBAAwB,CAACrB,cACtCA;AACN,EAAC"}
@@ -1,10 +0,0 @@
1
- import type { JSONFieldClientProps } from 'payload';
2
- import React from 'react';
3
- import type { ClientMCPPluginConfig } from '../../types.js';
4
- import './index.css';
5
- type Props = {
6
- pluginConfig: ClientMCPPluginConfig;
7
- } & JSONFieldClientProps;
8
- export declare const AccessField: React.FC<Props>;
9
- export {};
10
- //# sourceMappingURL=index.client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.client.d.ts","sourceRoot":"","sources":["../../../src/components/AccessField/index.client.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGnD,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,qBAAqB,EAA2B,MAAM,gBAAgB,CAAA;AAEpF,OAAO,aAAa,CAAA;AAQpB,KAAK,KAAK,GAAG;IACX,YAAY,EAAE,qBAAqB,CAAA;CACpC,GAAG,oBAAoB,CAAA;AAoBxB,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CA0QvC,CAAA"}