@payloadcms/plugin-mcp 4.0.0-internal.203916b → 4.0.0-internal.2071af3

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 (210) hide show
  1. package/dist/defaultAccess.d.ts.map +1 -1
  2. package/dist/defineTool.d.ts +8 -8
  3. package/dist/defineTool.d.ts.map +1 -1
  4. package/dist/endpoint/access.d.ts +2 -7
  5. package/dist/endpoint/access.d.ts.map +1 -1
  6. package/dist/endpoint/access.js +29 -16
  7. package/dist/endpoint/access.js.map +1 -1
  8. package/dist/endpoint/index.d.ts.map +1 -1
  9. package/dist/endpoint/index.js +45 -4
  10. package/dist/endpoint/index.js.map +1 -1
  11. package/dist/endpoint/oauth.d.ts +35 -0
  12. package/dist/endpoint/oauth.d.ts.map +1 -0
  13. package/dist/endpoint/oauth.js +96 -0
  14. package/dist/endpoint/oauth.js.map +1 -0
  15. package/dist/endpoint/oauthLoginToken.d.ts +21 -0
  16. package/dist/endpoint/oauthLoginToken.d.ts.map +1 -0
  17. package/dist/endpoint/oauthLoginToken.js +79 -0
  18. package/dist/endpoint/oauthLoginToken.js.map +1 -0
  19. package/dist/endpoint/oauthServer.d.ts +12 -0
  20. package/dist/endpoint/oauthServer.d.ts.map +1 -0
  21. package/dist/endpoint/oauthServer.js +361 -0
  22. package/dist/endpoint/oauthServer.js.map +1 -0
  23. package/dist/index.d.ts +10 -2
  24. package/dist/index.d.ts.map +1 -1
  25. package/dist/index.js +15 -2
  26. package/dist/index.js.map +1 -1
  27. package/dist/mcp/buildMcpServer.d.ts +2 -2
  28. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  29. package/dist/mcp/buildMcpServer.js +36 -24
  30. package/dist/mcp/buildMcpServer.js.map +1 -1
  31. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/authTools.js +80 -56
  33. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  34. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  35. package/dist/mcp/builtin/collections/countTool.js +10 -16
  36. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  37. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  38. package/dist/mcp/builtin/collections/countVersionsTool.js +10 -15
  39. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  40. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  41. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  42. package/dist/mcp/builtin/collections/createTool.js +104 -54
  43. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  44. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/deleteTool.js +45 -45
  46. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  47. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  48. package/dist/mcp/builtin/collections/duplicateTool.js +32 -39
  49. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  50. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  51. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  52. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  53. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  54. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  55. package/dist/mcp/builtin/collections/findDistinctTool.js +12 -28
  56. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  57. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  58. package/dist/mcp/builtin/collections/findTool.js +30 -49
  59. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  60. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  61. package/dist/mcp/builtin/collections/findVersionByIDTool.js +18 -28
  62. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  63. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  64. package/dist/mcp/builtin/collections/findVersionsTool.js +17 -32
  65. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  66. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  67. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +68 -12
  68. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  69. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  70. package/dist/mcp/builtin/collections/restoreVersionTool.js +15 -28
  71. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  72. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  73. package/dist/mcp/builtin/collections/updateTool.js +67 -87
  74. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  75. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  76. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  77. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  78. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  79. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  80. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  81. package/dist/mcp/builtin/formatEntityError.js +55 -0
  82. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  83. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  84. package/dist/mcp/builtin/getConfigInfoTool.js +5 -7
  85. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  86. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  87. package/dist/mcp/builtin/globals/countVersionsTool.js +10 -15
  88. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  89. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  90. package/dist/mcp/builtin/globals/findTool.js +12 -18
  91. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  92. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  93. package/dist/mcp/builtin/globals/findVersionByIDTool.js +14 -26
  94. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  95. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  96. package/dist/mcp/builtin/globals/findVersionsTool.js +14 -31
  97. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  98. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  99. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +46 -12
  100. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  101. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  102. package/dist/mcp/builtin/globals/restoreVersionTool.js +16 -24
  103. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  104. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  105. package/dist/mcp/builtin/globals/updateTool.js +28 -37
  106. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  107. package/dist/mcp/builtinTools.d.ts +6 -0
  108. package/dist/mcp/builtinTools.d.ts.map +1 -1
  109. package/dist/mcp/builtinTools.js +9 -3
  110. package/dist/mcp/builtinTools.js.map +1 -1
  111. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  112. package/dist/mcp/sanitizeMCPConfig.js +7 -1
  113. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  114. package/dist/stdio.d.ts.map +1 -1
  115. package/dist/stdio.js +6 -4
  116. package/dist/stdio.js.map +1 -1
  117. package/dist/types.d.ts +143 -14
  118. package/dist/types.d.ts.map +1 -1
  119. package/dist/types.js +2 -4
  120. package/dist/types.js.map +1 -1
  121. package/dist/utils/camelCase.d.ts.map +1 -1
  122. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  123. package/dist/utils/seal.d.ts +18 -0
  124. package/dist/utils/seal.d.ts.map +1 -0
  125. package/dist/utils/seal.js +27 -0
  126. package/dist/utils/seal.js.map +1 -0
  127. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  128. package/dist/utils/toStandardSchema.js.map +1 -1
  129. package/package.json +23 -28
  130. package/src/endpoint/access.ts +27 -16
  131. package/src/endpoint/index.ts +41 -3
  132. package/src/endpoint/oauth.ts +100 -0
  133. package/src/endpoint/oauthLoginToken.ts +91 -0
  134. package/src/endpoint/oauthServer.ts +396 -0
  135. package/src/index.ts +40 -5
  136. package/src/mcp/buildMcpServer.ts +40 -30
  137. package/src/mcp/builtin/collections/authTools.ts +82 -71
  138. package/src/mcp/builtin/collections/countTool.ts +10 -23
  139. package/src/mcp/builtin/collections/countVersionsTool.ts +10 -23
  140. package/src/mcp/builtin/collections/createTool.ts +108 -77
  141. package/src/mcp/builtin/collections/deleteTool.ts +37 -66
  142. package/src/mcp/builtin/collections/duplicateTool.ts +37 -88
  143. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  144. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  145. package/src/mcp/builtin/collections/findDistinctTool.ts +12 -64
  146. package/src/mcp/builtin/collections/findTool.ts +26 -109
  147. package/src/mcp/builtin/collections/findVersionByIDTool.ts +16 -60
  148. package/src/mcp/builtin/collections/findVersionsTool.ts +15 -87
  149. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +60 -15
  150. package/src/mcp/builtin/collections/restoreVersionTool.ts +16 -59
  151. package/src/mcp/builtin/collections/updateTool.ts +63 -101
  152. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  153. package/src/mcp/builtin/formatEntityError.ts +77 -0
  154. package/src/mcp/builtin/getConfigInfoTool.ts +4 -5
  155. package/src/mcp/builtin/globals/countVersionsTool.ts +10 -22
  156. package/src/mcp/builtin/globals/findTool.ts +15 -54
  157. package/src/mcp/builtin/globals/findVersionByIDTool.ts +14 -54
  158. package/src/mcp/builtin/globals/findVersionsTool.ts +15 -94
  159. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +41 -9
  160. package/src/mcp/builtin/globals/restoreVersionTool.ts +17 -48
  161. package/src/mcp/builtin/globals/updateTool.ts +40 -63
  162. package/src/mcp/builtinTools.ts +9 -2
  163. package/src/mcp/sanitizeMCPConfig.ts +5 -1
  164. package/src/stdio.ts +4 -3
  165. package/src/types.ts +142 -14
  166. package/src/utils/seal.ts +46 -0
  167. package/src/utils/toStandardSchema.ts +1 -1
  168. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +0 -9
  169. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +0 -1
  170. package/dist/mcp/builtin/collections/formatCollectionError.js +0 -60
  171. package/dist/mcp/builtin/collections/formatCollectionError.js.map +0 -1
  172. package/dist/mcp/builtin/validateEntityData.d.ts +0 -14
  173. package/dist/mcp/builtin/validateEntityData.d.ts.map +0 -1
  174. package/dist/mcp/builtin/validateEntityData.js +0 -82
  175. package/dist/mcp/builtin/validateEntityData.js.map +0 -1
  176. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  177. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  178. package/dist/utils/getVirtualFieldNames.js +0 -35
  179. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  180. package/dist/utils/localAPIDefaults.d.ts +0 -20
  181. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  182. package/dist/utils/localAPIDefaults.js +0 -19
  183. package/dist/utils/localAPIDefaults.js.map +0 -1
  184. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -11
  185. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  186. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -32
  187. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  188. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -10
  189. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  190. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -384
  191. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  192. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -133
  193. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  194. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  195. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  196. package/dist/utils/transformPointDataToPayload.js +0 -28
  197. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  198. package/dist/utils/whereSchema.d.ts +0 -9
  199. package/dist/utils/whereSchema.d.ts.map +0 -1
  200. package/dist/utils/whereSchema.js +0 -13
  201. package/dist/utils/whereSchema.js.map +0 -1
  202. package/src/mcp/builtin/collections/formatCollectionError.ts +0 -84
  203. package/src/mcp/builtin/validateEntityData.ts +0 -132
  204. package/src/utils/getVirtualFieldNames.ts +0 -53
  205. package/src/utils/localAPIDefaults.ts +0 -22
  206. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -62
  207. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -96
  208. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -432
  209. package/src/utils/transformPointDataToPayload.ts +0 -40
  210. package/src/utils/whereSchema.ts +0 -24
package/src/types.ts CHANGED
@@ -1,8 +1,9 @@
1
1
  import type {
2
2
  CallToolResult,
3
3
  ContentBlock,
4
+ Implementation,
4
5
  JsonSchemaType,
5
- McpServer,
6
+ McpServerOptions,
6
7
  ResourceTemplate,
7
8
  ServerContext,
8
9
  StandardSchemaWithJSON,
@@ -15,7 +16,6 @@ import type {
15
16
  MaybePromise,
16
17
  PayloadRequest,
17
18
  SanitizedPermissions,
18
- User,
19
19
  } from 'payload'
20
20
 
21
21
  import type { GetAuthorizedMCPArgs } from './endpoint/access.js'
@@ -76,11 +76,11 @@ export type MCPAccessArgs = {
76
76
  }
77
77
 
78
78
  export type CollectionMCPAccessArgs = {
79
- collectionSlug: CollectionSlug
79
+ slug: CollectionSlug
80
80
  } & MCPAccessArgs
81
81
 
82
82
  export type GlobalMCPAccessArgs = {
83
- globalSlug: GlobalSlug
83
+ slug: GlobalSlug
84
84
  } & MCPAccessArgs
85
85
 
86
86
  export type ToolHandlerArgs<TSchema = undefined> = {
@@ -91,14 +91,19 @@ export type ToolHandlerArgs<TSchema = undefined> = {
91
91
  }
92
92
 
93
93
  export type CollectionToolHandlerArgs<TSchema = undefined> = {
94
- collectionSlug: CollectionSlug
94
+ slug: CollectionSlug
95
95
  } & ToolHandlerArgs<TSchema>
96
96
 
97
97
  export type GlobalToolHandlerArgs<TSchema = undefined> = {
98
- globalSlug: GlobalSlug
98
+ slug: GlobalSlug
99
99
  } & ToolHandlerArgs<TSchema>
100
100
 
101
101
  export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
102
+ /**
103
+ * Runs while authorizing each MCP request, before the tool is advertised or called. Return
104
+ * `false` to make the tool unavailable for that request. This is skipped when `overrideAccess`
105
+ * is enabled.
106
+ */
102
107
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
103
108
  annotations?: ToolAnnotations
104
109
  description: string
@@ -113,6 +118,12 @@ export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema |
113
118
  export type CollectionTool<
114
119
  TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
115
120
  > = {
121
+ /**
122
+ * Runs while authorizing each MCP request for this collection. Return `false` to reject calls
123
+ * to this tool for the collection. The shared tool is not advertised when no collections allow
124
+ * it, but can remain advertised when it is available for another collection. This is skipped
125
+ * when `overrideAccess` is enabled.
126
+ */
116
127
  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
117
128
  handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
118
129
  input?: TSchema
@@ -120,6 +131,12 @@ export type CollectionTool<
120
131
 
121
132
  export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =
122
133
  {
134
+ /**
135
+ * Runs while authorizing each MCP request for this global. Return `false` to reject calls to
136
+ * this tool for the global. The shared tool is not advertised when no globals allow it, but
137
+ * can remain advertised when it is available for another global. This is skipped when
138
+ * `overrideAccess` is enabled.
139
+ */
123
140
  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
124
141
  handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
125
142
  input?: TSchema
@@ -131,6 +148,10 @@ export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSc
131
148
  * required handler) from being silently accepted at a built-in key slot.
132
149
  */
133
150
  export type MCPBuiltInCollectionToolOverride = {
151
+ /**
152
+ * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
153
+ * this collection. This is skipped when `overrideAccess` is enabled.
154
+ */
134
155
  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
135
156
  annotations?: ToolAnnotations
136
157
  description?: string
@@ -139,6 +160,10 @@ export type MCPBuiltInCollectionToolOverride = {
139
160
  }
140
161
 
141
162
  export type MCPBuiltInGlobalToolOverride = {
163
+ /**
164
+ * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
165
+ * this global. This is skipped when `overrideAccess` is enabled.
166
+ */
142
167
  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
143
168
  annotations?: ToolAnnotations
144
169
  description?: string
@@ -183,6 +208,11 @@ export type PromptHandlerArgs<TSchema = undefined> = {
183
208
  }
184
209
 
185
210
  export type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {
211
+ /**
212
+ * Runs while authorizing each MCP request, before the prompt is advertised or used. Return
213
+ * `false` to make the prompt unavailable for that request. This is skipped when
214
+ * `overrideAccess` is enabled.
215
+ */
186
216
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
187
217
  argsSchema: TSchema
188
218
  description: string
@@ -201,6 +231,11 @@ export type ResourceHandlerArgs = {
201
231
  }
202
232
 
203
233
  export type Resource = {
234
+ /**
235
+ * Runs while authorizing each MCP request, before the resource is advertised or read. Return
236
+ * `false` to make the resource unavailable for that request. This is skipped when
237
+ * `overrideAccess` is enabled.
238
+ */
204
239
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
205
240
  description: string
206
241
  handler: (args: ResourceHandlerArgs) => MaybePromise<{
@@ -245,10 +280,30 @@ export type MCPPluginConfig = {
245
280
  afterToolCall?: MCPAfterToolCallHook[]
246
281
  }
247
282
  mcp?: {
283
+ /**
284
+ * Largest HTTP request body, in bytes, that the MCP endpoint accepts. Larger requests
285
+ * are answered with `413`. Base64 file uploads count toward this limit.
286
+ *
287
+ * @default 4194304 (4 MiB, the MCP SDK default)
288
+ */
289
+ maxRequestBodySize?: number
248
290
  serverOptions?: MCPServerOptions
249
291
  verboseLogs?: boolean
250
292
  }
251
- /** Replace the default MCP authorization resolver. */
293
+ /**
294
+ * How MCP clients sign in. MCP requests without an authenticated user get a `401` that points
295
+ * to the protected resource metadata (RFC 9728). Set to `false` to only accept API keys and
296
+ * anonymous requests.
297
+ *
298
+ * @default { type: 'builtin' }
299
+ */
300
+ oauth?: false | MCPOAuthConfig
301
+ /**
302
+ * Replace the default MCP authorization resolver.
303
+ *
304
+ * This hook replaces the default authentication flow. It must set `req.user` to the
305
+ * authenticated Payload user, or to `null` for an anonymous caller, before returning.
306
+ */
252
307
  overrideGetAuthorizedMCP?: (
253
308
  args: {
254
309
  pluginConfig: SanitizedMCPPluginConfig
@@ -260,13 +315,89 @@ export type MCPPluginConfig = {
260
315
  tools?: MCPTopLevelToolsMap
261
316
  }
262
317
 
318
+ export type MCPOAuthConfig = MCPBuiltinOAuthConfig | MCPExternalOAuthConfig
319
+
320
+ /**
321
+ * This Payload app is the authorization server. Users sign in to the admin panel and allow the
322
+ * MCP client, which then gets an access token for them.
323
+ */
324
+ export type MCPBuiltinOAuthConfig = {
325
+ /**
326
+ * Creates the tokens the MCP client gets when the user clicks Allow. `req` is the user's own
327
+ * browser request, so `req.user` is the user who allowed it. Pass `authenticate` too if
328
+ * Payload's auth strategies don't accept the access token.
329
+ *
330
+ * @default a Payload login token for that user that only works for MCP, with a refresh token when
331
+ * the collection uses sessions
332
+ */
333
+ issueToken?: (args: { req: PayloadRequest }) => MaybePromise<MCPOAuthTokens>
334
+ /**
335
+ * Trades a refresh token from `issueToken`, or from an earlier refresh, for new tokens. Return
336
+ * `null` when it's no longer valid, and the client sends the user through sign-in again. `req`
337
+ * is the MCP client's request, without a user. Only used together with `issueToken`.
338
+ *
339
+ * OAuth requires noticing copied refresh tokens: return a new refresh token every time, and
340
+ * revoke the tokens when an already used refresh token comes back.
341
+ */
342
+ refreshToken?: (args: {
343
+ refreshToken: string
344
+ req: PayloadRequest
345
+ }) => MaybePromise<MCPOAuthTokens | null>
346
+ type: 'builtin'
347
+ } & MCPOAuthSharedConfig
348
+
349
+ export type MCPOAuthTokens = {
350
+ accessToken: string
351
+ /** Seconds until the access token expires. */
352
+ expiresIn?: number
353
+ /** Lets the client get new tokens without the user, through `refreshToken`. */
354
+ refreshToken?: string
355
+ }
356
+
357
+ /** Another service, e.g. your identity provider, is the authorization server. */
358
+ export type MCPExternalOAuthConfig = {
359
+ /**
360
+ * The authorization servers that issue access tokens for MCP clients. Clients require each one
361
+ * to exactly match the `issuer` in that server's metadata, so pass a function when the exact
362
+ * value is only known at runtime, e.g. from the server's OpenID configuration or per host.
363
+ */
364
+ authorizationServers: ((args: { req: PayloadRequest }) => MaybePromise<string[]>) | string[]
365
+ /**
366
+ * Scopes MCP clients should request, e.g. `['openid', 'email', 'profile']`. Without them,
367
+ * clients request none, which some authorization servers reject or answer with a token that
368
+ * doesn't identify the user.
369
+ */
370
+ scopes?: string[]
371
+ type: 'external'
372
+ } & MCPOAuthSharedConfig
373
+
374
+ type MCPOAuthSharedConfig = {
375
+ /**
376
+ * Called on MCP requests with a bearer token that Payload's auth strategies didn't accept.
377
+ * Return the Payload user, including its `collection`, or `null` to answer with the OAuth challenge.
378
+ */
379
+ authenticate?: (args: {
380
+ req: PayloadRequest
381
+ token: string
382
+ }) => MaybePromise<PayloadRequest['user']>
383
+ /**
384
+ * The URL clients call to reach the MCP endpoint. The metadata link and the built-in
385
+ * authorization server's issuer are based on it.
386
+ *
387
+ * @default the absolute URL of `/api/mcp`, based on `serverURL` or the request URL
388
+ */
389
+ resource?: ((args: { req: PayloadRequest }) => string) | string
390
+ }
391
+
263
392
  export type SanitizedMCPPluginConfig = {
264
393
  items: MCPItem[]
394
+ /** `undefined` when OAuth is turned off. */
395
+ oauth?: MCPOAuthConfig
265
396
  } & Pick<MCPPluginConfig, 'disabled' | 'hooks' | 'mcp' | 'overrideGetAuthorizedMCP'>
266
397
 
267
398
  export type MCPServerOptions = {
268
- options?: ConstructorParameters<typeof McpServer>[1]
269
- serverInfo?: Partial<ConstructorParameters<typeof McpServer>[0]>
399
+ options?: McpServerOptions
400
+ serverInfo?: Partial<Implementation>
270
401
  }
271
402
 
272
403
  /**
@@ -312,13 +443,10 @@ export type MCPItem =
312
443
  | GlobalMCPItem
313
444
 
314
445
  /**
315
- * The caller's identity + the MCP items authorized for this request. Disabled
316
- * items and items blocked by access callbacks or Payload operation access are
317
- * absent from `items`. Tool handlers receive this via `args.authorizedMCP` so
318
- * they can spread `localAPIDefaults(authorizedMCP)` into every local API call.
446
+ * The MCP items and access mode authorized for this request. The authenticated user is available
447
+ * as `req.user`.
319
448
  */
320
449
  export type AuthorizedMCP = {
321
450
  items: MCPItem[]
322
451
  overrideAccess: boolean
323
- user: null | User
324
452
  }
@@ -0,0 +1,46 @@
1
+ import type { PayloadRequest } from 'payload'
2
+
3
+ /**
4
+ * Encrypts data for the client to hold, so it doesn't need to be stored. `type` keeps one kind
5
+ * from being used as another, e.g. a client ID as an authorization code.
6
+ */
7
+ export const seal = ({
8
+ type,
9
+ data,
10
+ expiresIn,
11
+ req,
12
+ }: {
13
+ data: object
14
+ /** Seconds */
15
+ expiresIn?: number
16
+ req: PayloadRequest
17
+ type: string
18
+ }): string =>
19
+ req.payload.encrypt(
20
+ JSON.stringify({ ...data, type, exp: expiresIn && Date.now() + expiresIn * 1000 }),
21
+ )
22
+
23
+ export const unseal = <T>({
24
+ type,
25
+ req,
26
+ value,
27
+ }: {
28
+ req: PayloadRequest
29
+ type: string
30
+ value: null | string
31
+ }): T | undefined => {
32
+ // Only the v1 format is authenticated. Older formats decrypt anything without an error.
33
+ if (!value?.startsWith('v1:')) {
34
+ return undefined
35
+ }
36
+
37
+ try {
38
+ // Previous secrets can be public, like a default secret from source code, so only client IDs
39
+ // accept them. Client IDs grant nothing, and this keeps clients registered when the secret changes.
40
+ const secret = type === 'client' ? undefined : req.payload.config.secret
41
+ const data = JSON.parse(req.payload.decrypt(value, { secret }))
42
+ return data.type === type && (!data.exp || data.exp > Date.now()) ? data : undefined
43
+ } catch {
44
+ return undefined
45
+ }
46
+ }
@@ -5,5 +5,5 @@ import type { ToolInputSchema } from '../types.js'
5
5
  /** Normalize a tool/prompt input to a Standard Schema. Raw JSON Schema gets wrapped; Standard Schema instances pass through. */
6
6
  export const toStandardSchema = (schema: ToolInputSchema): StandardSchemaWithJSON =>
7
7
  typeof schema === 'object' && schema !== null && '~standard' in schema
8
- ? (schema as StandardSchemaWithJSON)
8
+ ? schema
9
9
  : fromJsonSchema(schema)
@@ -1,9 +0,0 @@
1
- import type { CollectionSlug, PayloadRequest } from 'payload';
2
- import type { MCPToolResponse } from '../../../types.js';
3
- export declare const formatCollectionError: ({ action, collectionSlug, error, req, }: {
4
- action: "creating" | "duplicating" | "updating";
5
- collectionSlug: CollectionSlug;
6
- error: unknown;
7
- req: PayloadRequest;
8
- }) => MCPToolResponse;
9
- //# sourceMappingURL=formatCollectionError.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"formatCollectionError.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/formatCollectionError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAgCxD,eAAO,MAAM,qBAAqB,GAAI,yCAKnC;IACD,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,UAAU,CAAA;IAC/C,cAAc,EAAE,cAAc,CAAA;IAC9B,KAAK,EAAE,OAAO,CAAA;IACd,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,eAuCH,CAAA"}
@@ -1,60 +0,0 @@
1
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js';
2
- const getValidationErrors = (error)=>{
3
- if (!error || typeof error !== 'object') {
4
- return undefined;
5
- }
6
- const data = 'data' in error ? error.data : undefined;
7
- if (!data || typeof data !== 'object' || !('errors' in data) || !Array.isArray(data.errors)) {
8
- return undefined;
9
- }
10
- return data.errors;
11
- };
12
- const isSchemaError = (error, message)=>{
13
- if (getValidationErrors(error)) {
14
- return true;
15
- }
16
- const name = error && typeof error === 'object' && 'name' in error ? error.name : undefined;
17
- return name === 'CastError' || name === 'ValidationError' || message.includes('Cast to ') || message.includes('validation failed');
18
- };
19
- export const formatCollectionError = ({ action, collectionSlug, error, req })=>{
20
- const errorMessage = error instanceof Error ? error.message : 'Unknown error';
21
- const errors = getValidationErrors(error) ?? [
22
- {
23
- message: errorMessage
24
- }
25
- ];
26
- if (!isSchemaError(error, errorMessage)) {
27
- return {
28
- content: [
29
- {
30
- type: 'text',
31
- text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}`
32
- }
33
- ],
34
- isError: true
35
- };
36
- }
37
- const schema = getCollectionInputSchema({
38
- collectionSlug,
39
- req
40
- });
41
- const schemaText = schema ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\`` : '';
42
- return {
43
- content: [
44
- {
45
- type: 'text',
46
- text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}${schemaText}`
47
- }
48
- ],
49
- isError: true,
50
- ...schema ? {
51
- structuredContent: {
52
- collectionSlug,
53
- errors,
54
- schema
55
- }
56
- } : {}
57
- };
58
- };
59
-
60
- //# sourceMappingURL=formatCollectionError.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/formatCollectionError.ts"],"sourcesContent":["import type { CollectionSlug, PayloadRequest } from 'payload'\n\nimport type { MCPToolResponse } from '../../../types.js'\n\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nconst getValidationErrors = (error: unknown): undefined | unknown[] => {\n if (!error || typeof error !== 'object') {\n return undefined\n }\n\n const data = 'data' in error ? error.data : undefined\n if (!data || typeof data !== 'object' || !('errors' in data) || !Array.isArray(data.errors)) {\n return undefined\n }\n\n return data.errors\n}\n\nconst isSchemaError = (error: unknown, message: string): boolean => {\n if (getValidationErrors(error)) {\n return true\n }\n\n const name = error && typeof error === 'object' && 'name' in error ? error.name : undefined\n\n return (\n name === 'CastError' ||\n name === 'ValidationError' ||\n message.includes('Cast to ') ||\n message.includes('validation failed')\n )\n}\n\nexport const formatCollectionError = ({\n action,\n collectionSlug,\n error,\n req,\n}: {\n action: 'creating' | 'duplicating' | 'updating'\n collectionSlug: CollectionSlug\n error: unknown\n req: PayloadRequest\n}): MCPToolResponse => {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n const errors = getValidationErrors(error) ?? [{ message: errorMessage }]\n\n if (!isSchemaError(error, errorMessage)) {\n return {\n content: [\n {\n type: 'text',\n text: `Error ${action} document in collection \"${collectionSlug}\": ${errorMessage}`,\n },\n ],\n isError: true,\n }\n }\n\n const schema = getCollectionInputSchema({ collectionSlug, req })\n const schemaText = schema\n ? `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(schema)}\\n\\`\\`\\``\n : ''\n\n return {\n content: [\n {\n type: 'text',\n text: `Error ${action} document in collection \"${collectionSlug}\": ${errorMessage}${schemaText}`,\n },\n ],\n isError: true,\n ...(schema\n ? {\n structuredContent: {\n collectionSlug,\n errors,\n schema,\n },\n }\n : {}),\n }\n}\n"],"names":["getCollectionInputSchema","getValidationErrors","error","undefined","data","Array","isArray","errors","isSchemaError","message","name","includes","formatCollectionError","action","collectionSlug","req","errorMessage","Error","content","type","text","isError","schema","schemaText","JSON","stringify","structuredContent"],"mappings":"AAIA,SAASA,wBAAwB,QAAQ,0DAAyD;AAElG,MAAMC,sBAAsB,CAACC;IAC3B,IAAI,CAACA,SAAS,OAAOA,UAAU,UAAU;QACvC,OAAOC;IACT;IAEA,MAAMC,OAAO,UAAUF,QAAQA,MAAME,IAAI,GAAGD;IAC5C,IAAI,CAACC,QAAQ,OAAOA,SAAS,YAAY,CAAE,CAAA,YAAYA,IAAG,KAAM,CAACC,MAAMC,OAAO,CAACF,KAAKG,MAAM,GAAG;QAC3F,OAAOJ;IACT;IAEA,OAAOC,KAAKG,MAAM;AACpB;AAEA,MAAMC,gBAAgB,CAACN,OAAgBO;IACrC,IAAIR,oBAAoBC,QAAQ;QAC9B,OAAO;IACT;IAEA,MAAMQ,OAAOR,SAAS,OAAOA,UAAU,YAAY,UAAUA,QAAQA,MAAMQ,IAAI,GAAGP;IAElF,OACEO,SAAS,eACTA,SAAS,qBACTD,QAAQE,QAAQ,CAAC,eACjBF,QAAQE,QAAQ,CAAC;AAErB;AAEA,OAAO,MAAMC,wBAAwB,CAAC,EACpCC,MAAM,EACNC,cAAc,EACdZ,KAAK,EACLa,GAAG,EAMJ;IACC,MAAMC,eAAed,iBAAiBe,QAAQf,MAAMO,OAAO,GAAG;IAC9D,MAAMF,SAASN,oBAAoBC,UAAU;QAAC;YAAEO,SAASO;QAAa;KAAE;IAExE,IAAI,CAACR,cAAcN,OAAOc,eAAe;QACvC,OAAO;YACLE,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,MAAM,EAAEP,OAAO,yBAAyB,EAAEC,eAAe,GAAG,EAAEE,cAAc;gBACrF;aACD;YACDK,SAAS;QACX;IACF;IAEA,MAAMC,SAAStB,yBAAyB;QAAEc;QAAgBC;IAAI;IAC9D,MAAMQ,aAAaD,SACf,CAAC,2CAA2C,EAAEE,KAAKC,SAAS,CAACH,QAAQ,QAAQ,CAAC,GAC9E;IAEJ,OAAO;QACLJ,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,MAAM,EAAEP,OAAO,yBAAyB,EAAEC,eAAe,GAAG,EAAEE,eAAeO,YAAY;YAClG;SACD;QACDF,SAAS;QACT,GAAIC,SACA;YACEI,mBAAmB;gBACjBZ;gBACAP;gBACAe;YACF;QACF,IACA,CAAC,CAAC;IACR;AACF,EAAC"}
@@ -1,14 +0,0 @@
1
- import type { CollectionSlug, GlobalSlug, PayloadRequest } from 'payload';
2
- import type { MCPToolResponse } from '../../types.js';
3
- export declare const validateCollectionData: ({ collectionSlug, data, partial, req, }: {
4
- collectionSlug: CollectionSlug;
5
- data: Record<string, unknown>;
6
- partial?: boolean;
7
- req: PayloadRequest;
8
- }) => MCPToolResponse | null;
9
- export declare const validateGlobalData: ({ data, globalSlug, req, }: {
10
- data: Record<string, unknown>;
11
- globalSlug: GlobalSlug;
12
- req: PayloadRequest;
13
- }) => MCPToolResponse | null;
14
- //# sourceMappingURL=validateEntityData.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"validateEntityData.d.ts","sourceRoot":"","sources":["../../../src/mcp/builtin/validateEntityData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAmB,MAAM,SAAS,CAAA;AAI1F,OAAO,KAAK,EAAkB,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAuBrE,eAAO,MAAM,sBAAsB,GAAI,yCAKpC;IACD,cAAc,EAAE,cAAc,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,eAAe,GAAG,IAQlB,CAAA;AAEJ,eAAO,MAAM,kBAAkB,GAAI,4BAIhC;IACD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,eAAe,GAAG,IAQlB,CAAA"}
@@ -1,82 +0,0 @@
1
- import { CfWorkerJsonSchemaValidator } from '@modelcontextprotocol/server/validators/cf-worker';
2
- import { getCollectionInputSchema, getGlobalInputSchema } from '../../utils/schemaConversion/getEntityInputSchema.js';
3
- /**
4
- * Keep the default `shortcircuit: true` - `false` makes validating nested rich text exponentially slow.
5
- */ const validator = new CfWorkerJsonSchemaValidator({
6
- shortcircuit: true
7
- });
8
- /**
9
- * - Caches each entity's schema and validator, so both are only built on the first request.
10
- * - Keyed by payload config, then by entity type, slug, partial and language.
11
- */ const validatorCache = new WeakMap();
12
- export const validateCollectionData = ({ collectionSlug, data, partial, req })=>validateData({
13
- slug: collectionSlug,
14
- buildSchema: ()=>getCollectionInputSchema({
15
- collectionSlug,
16
- req
17
- }),
18
- data,
19
- entity: 'collection',
20
- partial,
21
- req
22
- });
23
- export const validateGlobalData = ({ data, globalSlug, req })=>validateData({
24
- slug: globalSlug,
25
- buildSchema: ()=>getGlobalInputSchema({
26
- globalSlug,
27
- req
28
- }),
29
- data,
30
- entity: 'global',
31
- partial: true,
32
- req
33
- });
34
- const validateData = ({ slug, buildSchema, data, entity, partial, req })=>{
35
- let cache = validatorCache.get(req.payload.config);
36
- if (!cache) {
37
- cache = new Map();
38
- validatorCache.set(req.payload.config, cache);
39
- }
40
- const cacheKey = `${entity}:${slug}:${partial ? 'partial' : 'full'}:${req.i18n.language}`;
41
- let entityValidator = cache.get(cacheKey);
42
- if (!entityValidator) {
43
- const schema = buildSchema();
44
- if (!schema) {
45
- return null;
46
- }
47
- entityValidator = {
48
- schema,
49
- validate: validator.getValidator(partial ? withoutRequired(schema) : schema)
50
- };
51
- cache.set(cacheKey, entityValidator);
52
- }
53
- const result = entityValidator.validate(data);
54
- if (result.valid) {
55
- return null;
56
- }
57
- const { schema } = entityValidator;
58
- return {
59
- content: [
60
- {
61
- type: 'text',
62
- text: `Invalid data for ${entity} "${slug}": ${result.errorMessage}\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\``
63
- }
64
- ],
65
- isError: true,
66
- structuredContent: {
67
- [`${entity}Slug`]: slug,
68
- errors: [
69
- {
70
- message: result.errorMessage
71
- }
72
- ],
73
- schema
74
- }
75
- };
76
- };
77
- /** Updates are partial — drop the schema's top-level `required` before validating. */ const withoutRequired = (schema)=>{
78
- const { required: _required, ...rest } = schema;
79
- return rest;
80
- };
81
-
82
- //# sourceMappingURL=validateEntityData.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../src/mcp/builtin/validateEntityData.ts"],"sourcesContent":["import type { CollectionSlug, GlobalSlug, PayloadRequest, SanitizedConfig } from 'payload'\n\nimport { CfWorkerJsonSchemaValidator } from '@modelcontextprotocol/server/validators/cf-worker'\n\nimport type { JsonSchemaType, MCPToolResponse } from '../../types.js'\n\nimport {\n getCollectionInputSchema,\n getGlobalInputSchema,\n} from '../../utils/schemaConversion/getEntityInputSchema.js'\n\n/**\n * Keep the default `shortcircuit: true` - `false` makes validating nested rich text exponentially slow.\n */\nconst validator = new CfWorkerJsonSchemaValidator({ shortcircuit: true })\n\ntype EntityValidator = {\n schema: JsonSchemaType\n validate: ReturnType<(typeof validator)['getValidator']>\n}\n\n/**\n * - Caches each entity's schema and validator, so both are only built on the first request.\n * - Keyed by payload config, then by entity type, slug, partial and language.\n */\nconst validatorCache = new WeakMap<SanitizedConfig, Map<string, EntityValidator>>()\n\nexport const validateCollectionData = ({\n collectionSlug,\n data,\n partial,\n req,\n}: {\n collectionSlug: CollectionSlug\n data: Record<string, unknown>\n partial?: boolean\n req: PayloadRequest\n}): MCPToolResponse | null =>\n validateData({\n slug: collectionSlug,\n buildSchema: () => getCollectionInputSchema({ collectionSlug, req }),\n data,\n entity: 'collection',\n partial,\n req,\n })\n\nexport const validateGlobalData = ({\n data,\n globalSlug,\n req,\n}: {\n data: Record<string, unknown>\n globalSlug: GlobalSlug\n req: PayloadRequest\n}): MCPToolResponse | null =>\n validateData({\n slug: globalSlug,\n buildSchema: () => getGlobalInputSchema({ globalSlug, req }),\n data,\n entity: 'global',\n partial: true,\n req,\n })\n\nconst validateData = ({\n slug,\n buildSchema,\n data,\n entity,\n partial,\n req,\n}: {\n buildSchema: () => JsonSchemaType | null\n data: Record<string, unknown>\n entity: 'collection' | 'global'\n partial?: boolean\n req: PayloadRequest\n slug: string\n}): MCPToolResponse | null => {\n let cache = validatorCache.get(req.payload.config)\n if (!cache) {\n cache = new Map()\n validatorCache.set(req.payload.config, cache)\n }\n\n const cacheKey = `${entity}:${slug}:${partial ? 'partial' : 'full'}:${req.i18n.language}`\n let entityValidator = cache.get(cacheKey)\n\n if (!entityValidator) {\n const schema = buildSchema()\n\n if (!schema) {\n return null\n }\n\n entityValidator = {\n schema,\n validate: validator.getValidator(partial ? withoutRequired(schema) : schema),\n }\n cache.set(cacheKey, entityValidator)\n }\n\n const result = entityValidator.validate(data)\n\n if (result.valid) {\n return null\n }\n\n const { schema } = entityValidator\n\n return {\n content: [\n {\n type: 'text',\n text: `Invalid data for ${entity} \"${slug}\": ${result.errorMessage}\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(schema)}\\n\\`\\`\\``,\n },\n ],\n isError: true,\n structuredContent: {\n [`${entity}Slug`]: slug,\n errors: [{ message: result.errorMessage }],\n schema,\n },\n }\n}\n\n/** Updates are partial — drop the schema's top-level `required` before validating. */\nconst withoutRequired = (schema: JsonSchemaType): JsonSchemaType => {\n const { required: _required, ...rest } = schema\n return rest\n}\n"],"names":["CfWorkerJsonSchemaValidator","getCollectionInputSchema","getGlobalInputSchema","validator","shortcircuit","validatorCache","WeakMap","validateCollectionData","collectionSlug","data","partial","req","validateData","slug","buildSchema","entity","validateGlobalData","globalSlug","cache","get","payload","config","Map","set","cacheKey","i18n","language","entityValidator","schema","validate","getValidator","withoutRequired","result","valid","content","type","text","errorMessage","JSON","stringify","isError","structuredContent","errors","message","required","_required","rest"],"mappings":"AAEA,SAASA,2BAA2B,QAAQ,oDAAmD;AAI/F,SACEC,wBAAwB,EACxBC,oBAAoB,QACf,uDAAsD;AAE7D;;CAEC,GACD,MAAMC,YAAY,IAAIH,4BAA4B;IAAEI,cAAc;AAAK;AAOvE;;;CAGC,GACD,MAAMC,iBAAiB,IAAIC;AAE3B,OAAO,MAAMC,yBAAyB,CAAC,EACrCC,cAAc,EACdC,IAAI,EACJC,OAAO,EACPC,GAAG,EAMJ,GACCC,aAAa;QACXC,MAAML;QACNM,aAAa,IAAMb,yBAAyB;gBAAEO;gBAAgBG;YAAI;QAClEF;QACAM,QAAQ;QACRL;QACAC;IACF,GAAE;AAEJ,OAAO,MAAMK,qBAAqB,CAAC,EACjCP,IAAI,EACJQ,UAAU,EACVN,GAAG,EAKJ,GACCC,aAAa;QACXC,MAAMI;QACNH,aAAa,IAAMZ,qBAAqB;gBAAEe;gBAAYN;YAAI;QAC1DF;QACAM,QAAQ;QACRL,SAAS;QACTC;IACF,GAAE;AAEJ,MAAMC,eAAe,CAAC,EACpBC,IAAI,EACJC,WAAW,EACXL,IAAI,EACJM,MAAM,EACNL,OAAO,EACPC,GAAG,EAQJ;IACC,IAAIO,QAAQb,eAAec,GAAG,CAACR,IAAIS,OAAO,CAACC,MAAM;IACjD,IAAI,CAACH,OAAO;QACVA,QAAQ,IAAII;QACZjB,eAAekB,GAAG,CAACZ,IAAIS,OAAO,CAACC,MAAM,EAAEH;IACzC;IAEA,MAAMM,WAAW,GAAGT,OAAO,CAAC,EAAEF,KAAK,CAAC,EAAEH,UAAU,YAAY,OAAO,CAAC,EAAEC,IAAIc,IAAI,CAACC,QAAQ,EAAE;IACzF,IAAIC,kBAAkBT,MAAMC,GAAG,CAACK;IAEhC,IAAI,CAACG,iBAAiB;QACpB,MAAMC,SAASd;QAEf,IAAI,CAACc,QAAQ;YACX,OAAO;QACT;QAEAD,kBAAkB;YAChBC;YACAC,UAAU1B,UAAU2B,YAAY,CAACpB,UAAUqB,gBAAgBH,UAAUA;QACvE;QACAV,MAAMK,GAAG,CAACC,UAAUG;IACtB;IAEA,MAAMK,SAASL,gBAAgBE,QAAQ,CAACpB;IAExC,IAAIuB,OAAOC,KAAK,EAAE;QAChB,OAAO;IACT;IAEA,MAAM,EAAEL,MAAM,EAAE,GAAGD;IAEnB,OAAO;QACLO,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,iBAAiB,EAAErB,OAAO,EAAE,EAAEF,KAAK,GAAG,EAAEmB,OAAOK,YAAY,CAAC,2CAA2C,EAAEC,KAAKC,SAAS,CAACX,QAAQ,QAAQ,CAAC;YAClJ;SACD;QACDY,SAAS;QACTC,mBAAmB;YACjB,CAAC,GAAG1B,OAAO,IAAI,CAAC,CAAC,EAAEF;YACnB6B,QAAQ;gBAAC;oBAAEC,SAASX,OAAOK,YAAY;gBAAC;aAAE;YAC1CT;QACF;IACF;AACF;AAEA,oFAAoF,GACpF,MAAMG,kBAAkB,CAACH;IACvB,MAAM,EAAEgB,UAAUC,SAAS,EAAE,GAAGC,MAAM,GAAGlB;IACzC,OAAOkB;AACT"}
@@ -1,14 +0,0 @@
1
- import type { SanitizedConfig } from 'payload';
2
- /**
3
- * Returns the names of all top-level virtual fields for a given collection slug.
4
- */
5
- export declare function getCollectionVirtualFieldNames(config: SanitizedConfig, slug: string): string[];
6
- /**
7
- * Returns the names of all top-level virtual fields for a given global slug.
8
- */
9
- export declare function getGlobalVirtualFieldNames(config: SanitizedConfig, slug: string): string[];
10
- /**
11
- * Strips virtual field values from a data object given a list of virtual field names.
12
- */
13
- export declare function stripVirtualFields(data: Record<string, unknown>, virtualFieldNames: string[]): Record<string, unknown>;
14
- //# sourceMappingURL=getVirtualFieldNames.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getVirtualFieldNames.d.ts","sourceRoot":"","sources":["../../src/utils/getVirtualFieldNames.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAI9C;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAU9F;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAU1F;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,iBAAiB,EAAE,MAAM,EAAE,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAYzB"}
@@ -1,35 +0,0 @@
1
- import { fieldIsVirtual } from 'payload/shared';
2
- /**
3
- * Returns the names of all top-level virtual fields for a given collection slug.
4
- */ export function getCollectionVirtualFieldNames(config, slug) {
5
- const collection = config.collections.find((c)=>c.slug === slug);
6
- if (!collection) {
7
- return [];
8
- }
9
- return collection.flattenedFields.filter((field)=>'name' in field && fieldIsVirtual(field)).map((field)=>field.name);
10
- }
11
- /**
12
- * Returns the names of all top-level virtual fields for a given global slug.
13
- */ export function getGlobalVirtualFieldNames(config, slug) {
14
- const global = config.globals.find((g)=>g.slug === slug);
15
- if (!global) {
16
- return [];
17
- }
18
- return global.flattenedFields.filter((field)=>'name' in field && fieldIsVirtual(field)).map((field)=>field.name);
19
- }
20
- /**
21
- * Strips virtual field values from a data object given a list of virtual field names.
22
- */ export function stripVirtualFields(data, virtualFieldNames) {
23
- if (virtualFieldNames.length === 0) {
24
- return data;
25
- }
26
- const stripped = {
27
- ...data
28
- };
29
- for (const name of virtualFieldNames){
30
- delete stripped[name];
31
- }
32
- return stripped;
33
- }
34
-
35
- //# sourceMappingURL=getVirtualFieldNames.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/utils/getVirtualFieldNames.ts"],"sourcesContent":["import type { SanitizedConfig } from 'payload'\n\nimport { fieldIsVirtual } from 'payload/shared'\n\n/**\n * Returns the names of all top-level virtual fields for a given collection slug.\n */\nexport function getCollectionVirtualFieldNames(config: SanitizedConfig, slug: string): string[] {\n const collection = config.collections.find((c) => c.slug === slug)\n\n if (!collection) {\n return []\n }\n\n return collection.flattenedFields\n .filter((field) => 'name' in field && fieldIsVirtual(field))\n .map((field) => (field as { name: string }).name)\n}\n\n/**\n * Returns the names of all top-level virtual fields for a given global slug.\n */\nexport function getGlobalVirtualFieldNames(config: SanitizedConfig, slug: string): string[] {\n const global = config.globals.find((g) => g.slug === slug)\n\n if (!global) {\n return []\n }\n\n return global.flattenedFields\n .filter((field) => 'name' in field && fieldIsVirtual(field))\n .map((field) => (field as { name: string }).name)\n}\n\n/**\n * Strips virtual field values from a data object given a list of virtual field names.\n */\nexport function stripVirtualFields(\n data: Record<string, unknown>,\n virtualFieldNames: string[],\n): Record<string, unknown> {\n if (virtualFieldNames.length === 0) {\n return data\n }\n\n const stripped = { ...data }\n\n for (const name of virtualFieldNames) {\n delete stripped[name]\n }\n\n return stripped\n}\n"],"names":["fieldIsVirtual","getCollectionVirtualFieldNames","config","slug","collection","collections","find","c","flattenedFields","filter","field","map","name","getGlobalVirtualFieldNames","global","globals","g","stripVirtualFields","data","virtualFieldNames","length","stripped"],"mappings":"AAEA,SAASA,cAAc,QAAQ,iBAAgB;AAE/C;;CAEC,GACD,OAAO,SAASC,+BAA+BC,MAAuB,EAAEC,IAAY;IAClF,MAAMC,aAAaF,OAAOG,WAAW,CAACC,IAAI,CAAC,CAACC,IAAMA,EAAEJ,IAAI,KAAKA;IAE7D,IAAI,CAACC,YAAY;QACf,OAAO,EAAE;IACX;IAEA,OAAOA,WAAWI,eAAe,CAC9BC,MAAM,CAAC,CAACC,QAAU,UAAUA,SAASV,eAAeU,QACpDC,GAAG,CAAC,CAACD,QAAU,AAACA,MAA2BE,IAAI;AACpD;AAEA;;CAEC,GACD,OAAO,SAASC,2BAA2BX,MAAuB,EAAEC,IAAY;IAC9E,MAAMW,SAASZ,OAAOa,OAAO,CAACT,IAAI,CAAC,CAACU,IAAMA,EAAEb,IAAI,KAAKA;IAErD,IAAI,CAACW,QAAQ;QACX,OAAO,EAAE;IACX;IAEA,OAAOA,OAAON,eAAe,CAC1BC,MAAM,CAAC,CAACC,QAAU,UAAUA,SAASV,eAAeU,QACpDC,GAAG,CAAC,CAACD,QAAU,AAACA,MAA2BE,IAAI;AACpD;AAEA;;CAEC,GACD,OAAO,SAASK,mBACdC,IAA6B,EAC7BC,iBAA2B;IAE3B,IAAIA,kBAAkBC,MAAM,KAAK,GAAG;QAClC,OAAOF;IACT;IAEA,MAAMG,WAAW;QAAE,GAAGH,IAAI;IAAC;IAE3B,KAAK,MAAMN,QAAQO,kBAAmB;QACpC,OAAOE,QAAQ,CAACT,KAAK;IACvB;IAEA,OAAOS;AACT"}
@@ -1,20 +0,0 @@
1
- import type { AuthorizedMCP } from '../types.js';
2
- /**
3
- * Returns the `user` and `overrideAccess` arguments every Payload local API call
4
- * should receive when initiated from an MCP request. Spread the result into the
5
- * call's arg object so the two pieces of caller state can't drift apart.
6
- *
7
- * @example
8
- * ```ts
9
- * await req.payload.create({
10
- * collection: 'posts',
11
- * data,
12
- * ...localAPIDefaults(authorizedMCP),
13
- * })
14
- * ```
15
- */
16
- export declare const localAPIDefaults: (authorizedMCP: AuthorizedMCP) => {
17
- overrideAccess: boolean;
18
- user: AuthorizedMCP["user"];
19
- };
20
- //# sourceMappingURL=localAPIDefaults.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"localAPIDefaults.d.ts","sourceRoot":"","sources":["../../src/utils/localAPIDefaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,GAC3B,eAAe,aAAa,KAC3B;IAAE,cAAc,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAGvD,CAAA"}
@@ -1,19 +0,0 @@
1
- /**
2
- * Returns the `user` and `overrideAccess` arguments every Payload local API call
3
- * should receive when initiated from an MCP request. Spread the result into the
4
- * call's arg object so the two pieces of caller state can't drift apart.
5
- *
6
- * @example
7
- * ```ts
8
- * await req.payload.create({
9
- * collection: 'posts',
10
- * data,
11
- * ...localAPIDefaults(authorizedMCP),
12
- * })
13
- * ```
14
- */ export const localAPIDefaults = (authorizedMCP)=>({
15
- overrideAccess: authorizedMCP.overrideAccess,
16
- user: authorizedMCP.user
17
- });
18
-
19
- //# sourceMappingURL=localAPIDefaults.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/utils/localAPIDefaults.ts"],"sourcesContent":["import type { AuthorizedMCP } from '../types.js'\n\n/**\n * Returns the `user` and `overrideAccess` arguments every Payload local API call\n * should receive when initiated from an MCP request. Spread the result into the\n * call's arg object so the two pieces of caller state can't drift apart.\n *\n * @example\n * ```ts\n * await req.payload.create({\n * collection: 'posts',\n * data,\n * ...localAPIDefaults(authorizedMCP),\n * })\n * ```\n */\nexport const localAPIDefaults = (\n authorizedMCP: AuthorizedMCP,\n): { overrideAccess: boolean; user: AuthorizedMCP['user'] } => ({\n overrideAccess: authorizedMCP.overrideAccess,\n user: authorizedMCP.user,\n})\n"],"names":["localAPIDefaults","authorizedMCP","overrideAccess","user"],"mappings":"AAEA;;;;;;;;;;;;;CAaC,GACD,OAAO,MAAMA,mBAAmB,CAC9BC,gBAC8D,CAAA;QAC9DC,gBAAgBD,cAAcC,cAAc;QAC5CC,MAAMF,cAAcE,IAAI;IAC1B,CAAA,EAAE"}
@@ -1,11 +0,0 @@
1
- import { type CollectionSlug, type GlobalSlug, type PayloadRequest } from 'payload';
2
- import type { JsonSchemaType } from '../../types.js';
3
- export declare const getCollectionInputSchema: ({ collectionSlug, req, }: {
4
- collectionSlug: CollectionSlug;
5
- req: PayloadRequest;
6
- }) => JsonSchemaType | null;
7
- export declare const getGlobalInputSchema: ({ globalSlug, req, }: {
8
- globalSlug: GlobalSlug;
9
- req: PayloadRequest;
10
- }) => JsonSchemaType | null;
11
- //# sourceMappingURL=getEntityInputSchema.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getEntityInputSchema.d.ts","sourceRoot":"","sources":["../../../src/utils/schemaConversion/getEntityInputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,UAAU,EACf,KAAK,cAAc,EAGpB,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAIpD,eAAO,MAAM,wBAAwB,GAAI,0BAGtC;IACD,cAAc,EAAE,cAAc,CAAA;IAC9B,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,cAAc,GAAG,IAQpB,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAI,sBAGlC;IACD,UAAU,EAAE,UAAU,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,cAAc,GAAG,IAQpB,CAAA"}