@payloadcms/plugin-mcp 4.0.0-internal.a1317b2 → 4.0.0-internal.a2d053c

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 (97) hide show
  1. package/bin.js +0 -7
  2. package/dist/endpoint/access.d.ts.map +1 -1
  3. package/dist/endpoint/access.js +23 -3
  4. package/dist/endpoint/access.js.map +1 -1
  5. package/dist/endpoint/index.d.ts.map +1 -1
  6. package/dist/endpoint/index.js +46 -4
  7. package/dist/endpoint/index.js.map +1 -1
  8. package/dist/endpoint/oauth.d.ts +39 -0
  9. package/dist/endpoint/oauth.d.ts.map +1 -0
  10. package/dist/endpoint/oauth.js +94 -0
  11. package/dist/endpoint/oauth.js.map +1 -0
  12. package/dist/endpoint/oauthLoginToken.d.ts +21 -0
  13. package/dist/endpoint/oauthLoginToken.d.ts.map +1 -0
  14. package/dist/endpoint/oauthLoginToken.js +79 -0
  15. package/dist/endpoint/oauthLoginToken.js.map +1 -0
  16. package/dist/endpoint/oauthServer.d.ts +12 -0
  17. package/dist/endpoint/oauthServer.d.ts.map +1 -0
  18. package/dist/endpoint/oauthServer.js +362 -0
  19. package/dist/endpoint/oauthServer.js.map +1 -0
  20. package/dist/index.d.ts +10 -2
  21. package/dist/index.d.ts.map +1 -1
  22. package/dist/index.js +15 -2
  23. package/dist/index.js.map +1 -1
  24. package/dist/mcp/buildMcpServer.d.ts +1 -1
  25. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  26. package/dist/mcp/buildMcpServer.js +3 -3
  27. package/dist/mcp/buildMcpServer.js.map +1 -1
  28. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  29. package/dist/mcp/builtin/collections/authTools.js +4 -3
  30. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  31. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/createTool.js +8 -5
  33. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  34. package/dist/mcp/builtin/collections/deleteTool.js +6 -2
  35. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  36. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  37. package/dist/mcp/builtin/collections/duplicateTool.js +6 -2
  38. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  39. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -1
  40. package/dist/mcp/builtin/collections/fileInput.js +19 -54
  41. package/dist/mcp/builtin/collections/fileInput.js.map +1 -1
  42. package/dist/mcp/builtin/collections/findTool.js +8 -4
  43. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  44. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +19 -3
  46. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  47. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  48. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  49. package/dist/mcp/builtin/collections/updateTool.js +21 -8
  50. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  51. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -1
  52. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  53. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  54. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +19 -3
  55. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  56. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  57. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  58. package/dist/mcp/sanitizeMCPConfig.js +3 -0
  59. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  60. package/dist/stdio.js +4 -3
  61. package/dist/stdio.js.map +1 -1
  62. package/dist/types.d.ts +92 -3
  63. package/dist/types.d.ts.map +1 -1
  64. package/dist/types.js.map +1 -1
  65. package/dist/utils/seal.d.ts +18 -0
  66. package/dist/utils/seal.d.ts.map +1 -0
  67. package/dist/utils/seal.js +27 -0
  68. package/dist/utils/seal.js.map +1 -0
  69. package/dist/utils/toStandardSchema.js.map +1 -1
  70. package/package.json +23 -26
  71. package/src/endpoint/access.ts +22 -3
  72. package/src/endpoint/index.ts +41 -3
  73. package/src/endpoint/oauth.ts +92 -0
  74. package/src/endpoint/oauthLoginToken.ts +91 -0
  75. package/src/endpoint/oauthServer.ts +396 -0
  76. package/src/index.ts +40 -5
  77. package/src/mcp/buildMcpServer.ts +5 -5
  78. package/src/mcp/builtin/collections/authTools.ts +7 -4
  79. package/src/mcp/builtin/collections/createTool.ts +16 -5
  80. package/src/mcp/builtin/collections/deleteTool.ts +3 -3
  81. package/src/mcp/builtin/collections/duplicateTool.ts +3 -2
  82. package/src/mcp/builtin/collections/fileInput.ts +17 -59
  83. package/src/mcp/builtin/collections/findTool.ts +4 -4
  84. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +12 -1
  85. package/src/mcp/builtin/collections/restoreVersionTool.ts +1 -1
  86. package/src/mcp/builtin/collections/updateTool.ts +10 -6
  87. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +1 -1
  88. package/src/mcp/builtin/globals/findTool.ts +1 -1
  89. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +11 -1
  90. package/src/mcp/builtin/globals/updateTool.ts +1 -1
  91. package/src/mcp/sanitizeMCPConfig.ts +1 -0
  92. package/src/stdio.ts +2 -2
  93. package/src/types.ts +94 -3
  94. package/src/utils/seal.ts +46 -0
  95. package/src/utils/toStandardSchema.ts +1 -1
  96. package/dist/mcp/builtin/collections/fileInput.spec.js +0 -86
  97. package/dist/mcp/builtin/collections/fileInput.spec.js.map +0 -1
@@ -0,0 +1,91 @@
1
+ import type { PayloadRequest } from 'payload'
2
+
3
+ import { APIError, createAuthToken, executeAuthStrategies, redeemRefreshToken } from 'payload'
4
+
5
+ import type { MCPOAuthTokens } from '../types.js'
6
+
7
+ import { seal, unseal } from '../utils/seal.js'
8
+
9
+ /**
10
+ * The default `issueToken`: a Payload login token, sealed so it only works for MCP, where
11
+ * `authenticateLoginToken` unseals it. Otherwise an MCP client could use it as the user's admin
12
+ * panel login. When the collection uses sessions, the client also gets a refresh token.
13
+ */
14
+ export const issueLoginToken = async ({
15
+ req,
16
+ }: {
17
+ req: PayloadRequest
18
+ }): Promise<MCPOAuthTokens> => {
19
+ const collectionConfig = req.payload.collections[req.user!.collection]!.config
20
+
21
+ if (collectionConfig.auth.disableLocalStrategy) {
22
+ throw new APIError(
23
+ `MCP clients can't get Payload login tokens for the "${collectionConfig.slug}" collection because its local strategy is disabled. Pass oauth.issueToken to the MCP plugin.`,
24
+ )
25
+ }
26
+
27
+ // The full document, like the one a password login starts its session on
28
+ const user = (await req.payload.db.findOne<NonNullable<PayloadRequest['user']>>({
29
+ collection: collectionConfig.slug,
30
+ req,
31
+ where: { id: { equals: req.user!.id } },
32
+ }))!
33
+
34
+ const { refreshToken, token } = await createAuthToken({
35
+ collectionConfig,
36
+ email: user.email!,
37
+ req,
38
+ shouldCreateRefreshToken: true,
39
+ user,
40
+ })
41
+
42
+ return {
43
+ accessToken: sealLoginToken({ req, token }),
44
+ expiresIn: collectionConfig.auth.tokenExpiration,
45
+ refreshToken,
46
+ }
47
+ }
48
+
49
+ /** The default `refreshToken`. Payload logs out the session when a refresh token is reused. */
50
+ export const refreshLoginToken = async ({
51
+ refreshToken,
52
+ req,
53
+ }: {
54
+ refreshToken: string
55
+ req: PayloadRequest
56
+ }): Promise<MCPOAuthTokens | null> => {
57
+ const refreshed = await redeemRefreshToken({ refreshToken, req })
58
+
59
+ return (
60
+ refreshed && {
61
+ accessToken: sealLoginToken({ req, token: refreshed.token }),
62
+ expiresIn: refreshed.collectionConfig.auth.tokenExpiration,
63
+ refreshToken: refreshed.refreshToken,
64
+ }
65
+ )
66
+ }
67
+
68
+ /** Finds the user of an MCP request's access token from `issueLoginToken`. */
69
+ export const authenticateLoginToken = async ({
70
+ req,
71
+ token,
72
+ }: {
73
+ req: PayloadRequest
74
+ token: string
75
+ }): Promise<PayloadRequest['user']> => {
76
+ const loginToken = unseal<{ token: string }>({ type: 'access', req, value: token })
77
+
78
+ if (!loginToken) {
79
+ return null
80
+ }
81
+
82
+ const headers = new Headers({
83
+ Authorization: `JWT ${loginToken.token}`,
84
+ DisableAutologin: 'true',
85
+ })
86
+
87
+ return (await executeAuthStrategies({ headers, payload: req.payload, req })).user
88
+ }
89
+
90
+ const sealLoginToken = ({ req, token }: { req: PayloadRequest; token: string }): string =>
91
+ seal({ type: 'access', data: { token }, req })
@@ -0,0 +1,396 @@
1
+ import type {
2
+ OAuthClientInformationFull,
3
+ OAuthTokens,
4
+ OpenIdProviderDiscoveryMetadata,
5
+ } from '@modelcontextprotocol/server'
6
+ import type { Endpoint, PayloadHandler, PayloadRequest } from 'payload'
7
+
8
+ import { OAuthErrorCode } from '@modelcontextprotocol/server'
9
+ import { createHash } from 'crypto'
10
+ import { formatAdminURL } from 'payload/shared'
11
+
12
+ import type { MCPBuiltinOAuthConfig, MCPOAuthTokens } from '../types.js'
13
+
14
+ import { getPluginConfig } from '../utils/getPluginConfig.js'
15
+ import { seal, unseal } from '../utils/seal.js'
16
+ import { getMCPURL } from './oauth.js'
17
+ import { issueLoginToken, refreshLoginToken } from './oauthLoginToken.js'
18
+
19
+ type Client = { name: string; redirectURIs: string[] }
20
+
21
+ type Consent = {
22
+ clientID: string
23
+ codeChallenge: string
24
+ collection: string
25
+ redirectURI: string
26
+ state: null | string
27
+ userID: number | string
28
+ }
29
+
30
+ type Code = {
31
+ clientID: string
32
+ codeChallenge: string
33
+ redirectURI: string
34
+ tokens: MCPOAuthTokens
35
+ }
36
+
37
+ type RefreshToken = {
38
+ clientID: string
39
+ refreshToken: string
40
+ }
41
+
42
+ /**
43
+ * Turns Payload into the OAuth authorization server for MCP clients when `oauth.type` is
44
+ * `'builtin'`. Clients register, the user allows them after logging in to the admin panel, and
45
+ * the client receives the tokens `issueToken` creates.
46
+ *
47
+ * Clients, consent forms, authorization codes, and refresh tokens are encrypted and handed to the
48
+ * client instead of being stored. Only the default tokens write to the database, to the user's
49
+ * login sessions.
50
+ */
51
+ export const oauthServerEndpoints: Endpoint[] = [
52
+ {
53
+ disableAuth: true,
54
+ handler: (req) => withIssuer(req, (issuer) => metadataResponse(issuer)),
55
+ method: 'get',
56
+ // OpenID discovery is the only metadata location MCP clients check below the issuer's path,
57
+ // which lets this work under /api without a route at the site root
58
+ path: '/mcp/oauth/.well-known/openid-configuration',
59
+ },
60
+ {
61
+ disableAuth: true,
62
+ handler: (req) => withIssuer(req, () => Response.json({ keys: [] })),
63
+ method: 'get',
64
+ path: '/mcp/oauth/jwks',
65
+ },
66
+ {
67
+ disableAuth: true,
68
+ handler: (req) => withIssuer(req, () => register(req)),
69
+ method: 'post',
70
+ path: '/mcp/oauth/register',
71
+ },
72
+ {
73
+ handler: (req) => withIssuer(req, () => authorize(req)),
74
+ method: 'get',
75
+ path: '/mcp/oauth/authorize',
76
+ },
77
+ {
78
+ handler: (req) => withIssuer(req, () => approve(req)),
79
+ method: 'post',
80
+ path: '/mcp/oauth/authorize',
81
+ },
82
+ {
83
+ disableAuth: true,
84
+ handler: (req) => withIssuer(req, () => token(req)),
85
+ method: 'post',
86
+ path: '/mcp/oauth/token',
87
+ },
88
+ ]
89
+
90
+ /** The authorization server URL, or `undefined` when Payload isn't the authorization server. */
91
+ const getIssuer = (req: PayloadRequest): string | undefined =>
92
+ getPluginConfig({ config: req.payload.config }).oauth?.type === 'builtin'
93
+ ? `${getMCPURL({ config: req.payload.config, url: req.url! })}/oauth`
94
+ : undefined
95
+
96
+ const withIssuer = (
97
+ req: PayloadRequest,
98
+ handler: (issuer: string) => Promise<Response> | Response,
99
+ ): Promise<Response> | Response => {
100
+ const issuer = getIssuer(req)
101
+ return issuer ? handler(issuer) : new Response(null, { status: 404 })
102
+ }
103
+
104
+ /**
105
+ * The user logged in to this browser, who can allow MCP clients. Tokens and API keys in the
106
+ * `Authorization` header can't, or an MCP client could use its access token to approve itself a
107
+ * new, separate login.
108
+ */
109
+ const getBrowserUser = (req: PayloadRequest): PayloadRequest['user'] =>
110
+ req.headers.has('Authorization') ? null : req.user
111
+
112
+ const metadataResponse = (issuer: string): Response =>
113
+ Response.json(
114
+ {
115
+ authorization_endpoint: `${issuer}/authorize`,
116
+ code_challenge_methods_supported: ['S256'],
117
+ grant_types_supported: ['authorization_code', 'refresh_token'],
118
+ // Required by OpenID discovery. No ID tokens are issued.
119
+ id_token_signing_alg_values_supported: ['RS256'],
120
+ issuer,
121
+ jwks_uri: `${issuer}/jwks`,
122
+ registration_endpoint: `${issuer}/register`,
123
+ response_types_supported: ['code'],
124
+ subject_types_supported: ['public'],
125
+ token_endpoint: `${issuer}/token`,
126
+ token_endpoint_auth_methods_supported: ['none'],
127
+ } satisfies OpenIdProviderDiscoveryMetadata,
128
+ // Not cached, since without `serverURL` its URLs come from the request
129
+ { headers: { 'Access-Control-Allow-Origin': '*', 'Cache-Control': 'no-store' } },
130
+ )
131
+
132
+ const register: PayloadHandler = async (req) => {
133
+ const { client_name, redirect_uris } = await req.json!().catch(() => ({}))
134
+
135
+ if (
136
+ !Array.isArray(redirect_uris) ||
137
+ !redirect_uris.length ||
138
+ !redirect_uris.every(
139
+ (uri) => typeof uri === 'string' && URL.canParse(uri) && !uri.includes('#'),
140
+ )
141
+ ) {
142
+ return Response.json({ error: OAuthErrorCode.InvalidRedirectUri }, { status: 400 })
143
+ }
144
+
145
+ const client: Client = {
146
+ name: typeof client_name === 'string' ? client_name : 'An MCP client',
147
+ redirectURIs: redirect_uris,
148
+ }
149
+
150
+ return Response.json(
151
+ {
152
+ client_id: seal({ type: 'client', data: client, req }),
153
+ client_name: client.name,
154
+ grant_types: ['authorization_code', 'refresh_token'],
155
+ redirect_uris: client.redirectURIs,
156
+ response_types: ['code'],
157
+ token_endpoint_auth_method: 'none',
158
+ } satisfies OAuthClientInformationFull,
159
+ { status: 201 },
160
+ )
161
+ }
162
+
163
+ const authorize: PayloadHandler = (req) => {
164
+ const url = new URL(req.url!)
165
+ const params = url.searchParams
166
+ const clientID = params.get('client_id')
167
+ const client = unseal<Client>({ type: 'client', req, value: clientID })
168
+ const redirectURI = params.get('redirect_uri')
169
+
170
+ // Never redirect to an address the client didn't register
171
+ if (!client || !redirectURI || !client.redirectURIs.includes(redirectURI)) {
172
+ return page({
173
+ content: '<p>Start the sign-in again from your MCP client.</p>',
174
+ status: 400,
175
+ title: 'This sign-in link is invalid',
176
+ })
177
+ }
178
+
179
+ const state = params.get('state')
180
+ const codeChallenge = params.get('code_challenge')
181
+
182
+ if (
183
+ params.get('response_type') !== 'code' ||
184
+ params.get('code_challenge_method') !== 'S256' ||
185
+ !codeChallenge
186
+ ) {
187
+ return redirect({ params: { error: OAuthErrorCode.InvalidRequest, state }, redirectURI })
188
+ }
189
+
190
+ const user = getBrowserUser(req)
191
+
192
+ if (!user) {
193
+ const loginURL = formatAdminURL({ adminRoute: req.payload.config.routes.admin, path: '/login' })
194
+
195
+ return new Response(null, {
196
+ headers: {
197
+ Location: `${loginURL}?redirect=${encodeURIComponent(url.pathname + url.search)}`,
198
+ },
199
+ status: 302,
200
+ })
201
+ }
202
+
203
+ const consent: Consent = {
204
+ clientID: clientID!,
205
+ codeChallenge,
206
+ collection: user.collection,
207
+ redirectURI,
208
+ state,
209
+ userID: user.id,
210
+ }
211
+
212
+ return page({
213
+ content: `<p>It will be able to use this app's MCP tools as ${escapeHTML(String(user.email ?? user.id))}, and you will return to ${escapeHTML(new URL(redirectURI).host || redirectURI)}.</p>
214
+ <form method="post">
215
+ <input name="consent" type="hidden" value="${seal({ type: 'consent', data: consent, expiresIn: 20 * 60 * 60, req })}">
216
+ <button name="decision" type="submit" value="allow">Allow</button>
217
+ <button name="decision" type="submit" value="deny">Deny</button>
218
+ </form>`,
219
+ status: 200,
220
+ title: `Allow ${client.name} to use your account?`,
221
+ })
222
+ }
223
+
224
+ const approve: PayloadHandler = async (req) => {
225
+ const form = new URLSearchParams(await req.text!())
226
+ const consent = unseal<Consent>({ type: 'consent', req, value: form.get('consent') })
227
+ const user = getBrowserUser(req)
228
+
229
+ // The form is only valid for the user it was shown to
230
+ if (!consent || user?.id !== consent.userID || user.collection !== consent.collection) {
231
+ return page({
232
+ content: '<p>Start the sign-in again from your MCP client.</p>',
233
+ status: 400,
234
+ title: 'This sign-in request expired',
235
+ })
236
+ }
237
+
238
+ const { clientID, codeChallenge, redirectURI, state } = consent
239
+
240
+ if (form.get('decision') !== 'allow') {
241
+ return redirect({ params: { error: OAuthErrorCode.AccessDenied, state }, redirectURI })
242
+ }
243
+
244
+ const code: Code = {
245
+ clientID,
246
+ codeChallenge,
247
+ redirectURI,
248
+ tokens: await getTokenHooks(req).issueToken({ req }),
249
+ }
250
+
251
+ return redirect({
252
+ params: { code: seal({ type: 'code', data: code, expiresIn: 60, req }), state },
253
+ redirectURI,
254
+ })
255
+ }
256
+
257
+ const token: PayloadHandler = async (req) => {
258
+ const form = new URLSearchParams(await req.text!())
259
+ const clientID = form.get('client_id')
260
+ const tokens =
261
+ clientID &&
262
+ (form.get('grant_type') === 'refresh_token'
263
+ ? await refresh({ clientID, form, req })
264
+ : redeemCode({ clientID, form, req }))
265
+
266
+ if (!clientID || !tokens) {
267
+ return Response.json({ error: OAuthErrorCode.InvalidGrant }, { status: 400 })
268
+ }
269
+
270
+ return Response.json(
271
+ {
272
+ access_token: tokens.accessToken,
273
+ expires_in: tokens.expiresIn,
274
+ refresh_token:
275
+ tokens.refreshToken &&
276
+ seal({
277
+ type: 'refresh',
278
+ data: { clientID, refreshToken: tokens.refreshToken } satisfies RefreshToken,
279
+ req,
280
+ }),
281
+ token_type: 'Bearer',
282
+ } satisfies OAuthTokens,
283
+ { headers: { 'Cache-Control': 'no-store' } },
284
+ )
285
+ }
286
+
287
+ const redeemCode = ({
288
+ clientID,
289
+ form,
290
+ req,
291
+ }: {
292
+ clientID: string
293
+ form: URLSearchParams
294
+ req: PayloadRequest
295
+ }): MCPOAuthTokens | undefined => {
296
+ const code = unseal<Code>({ type: 'code', req, value: form.get('code') })
297
+
298
+ if (
299
+ form.get('grant_type') === 'authorization_code' &&
300
+ code?.clientID === clientID &&
301
+ code.redirectURI === form.get('redirect_uri') &&
302
+ // PKCE: only the client that started the sign-in knows the verifier
303
+ createHash('sha256')
304
+ .update(form.get('code_verifier') ?? '')
305
+ .digest('base64url') === code.codeChallenge
306
+ ) {
307
+ return code.tokens
308
+ }
309
+ }
310
+
311
+ const refresh = async ({
312
+ clientID,
313
+ form,
314
+ req,
315
+ }: {
316
+ clientID: string
317
+ form: URLSearchParams
318
+ req: PayloadRequest
319
+ }): Promise<MCPOAuthTokens | null | undefined> => {
320
+ const refreshToken = unseal<RefreshToken>({
321
+ type: 'refresh',
322
+ req,
323
+ value: form.get('refresh_token'),
324
+ })
325
+
326
+ // Only the client a refresh token was issued to can use it
327
+ if (refreshToken?.clientID === clientID) {
328
+ return await getTokenHooks(req).refreshToken?.({
329
+ refreshToken: refreshToken.refreshToken,
330
+ req,
331
+ })
332
+ }
333
+ }
334
+
335
+ /** `issueToken` and `refreshToken`, or the defaults for Payload login tokens. */
336
+ const getTokenHooks = (req: PayloadRequest) => {
337
+ const oauth = getPluginConfig({ config: req.payload.config }).oauth as MCPBuiltinOAuthConfig
338
+
339
+ return oauth.issueToken
340
+ ? { issueToken: oauth.issueToken, refreshToken: oauth.refreshToken }
341
+ : { issueToken: issueLoginToken, refreshToken: refreshLoginToken }
342
+ }
343
+
344
+ const redirect = ({
345
+ params,
346
+ redirectURI,
347
+ }: {
348
+ params: Record<string, null | string>
349
+ redirectURI: string
350
+ }): Response => {
351
+ const location = new URL(redirectURI)
352
+
353
+ for (const [key, value] of Object.entries(params)) {
354
+ if (value) {
355
+ location.searchParams.set(key, value)
356
+ }
357
+ }
358
+
359
+ return new Response(null, { headers: { Location: location.href }, status: 302 })
360
+ }
361
+
362
+ const page = ({
363
+ content,
364
+ status,
365
+ title,
366
+ }: {
367
+ content: string
368
+ status: number
369
+ title: string
370
+ }): Response =>
371
+ new Response(
372
+ `<!doctype html>
373
+ <html lang="en">
374
+ <head>
375
+ <meta charset="utf-8">
376
+ <meta name="viewport" content="width=device-width, initial-scale=1">
377
+ <title>${escapeHTML(title)}</title>
378
+ <style>
379
+ body { font-family: system-ui, sans-serif; margin: 4rem auto; max-width: 32rem; overflow-wrap: anywhere; padding: 0 1rem }
380
+ button { font: inherit; margin-inline-end: 0.5rem; padding: 0.5rem 1rem }
381
+ </style>
382
+ </head>
383
+ <body><h1>${escapeHTML(title)}</h1>${content}</body>
384
+ </html>`,
385
+ {
386
+ headers: {
387
+ // Stop other sites from framing the page to trick users into clicking Allow
388
+ 'Content-Security-Policy': "frame-ancestors 'none'",
389
+ 'Content-Type': 'text/html; charset=utf-8',
390
+ },
391
+ status,
392
+ },
393
+ )
394
+
395
+ const escapeHTML = (value: string): string =>
396
+ value.replace(/[&<>"']/g, (character) => `&#${character.charCodeAt(0)};`)
package/src/index.ts CHANGED
@@ -1,8 +1,18 @@
1
1
  import { definePlugin } from 'payload'
2
2
 
3
- import type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig } from './types.js'
3
+ import type {
4
+ AuthorizedMCP,
5
+ MCPBuiltinOAuthConfig,
6
+ MCPExternalOAuthConfig,
7
+ MCPOAuthConfig,
8
+ MCPOAuthTokens,
9
+ MCPPluginConfig,
10
+ SanitizedMCPPluginConfig,
11
+ } from './types.js'
4
12
 
5
13
  import { mcpEndpoint } from './endpoint/index.js'
14
+ import { oauthProtectedResourceEndpoint } from './endpoint/oauth.js'
15
+ import { oauthServerEndpoints } from './endpoint/oauthServer.js'
6
16
  import { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js'
7
17
 
8
18
  declare module 'payload' {
@@ -13,11 +23,27 @@ declare module 'payload' {
13
23
  /** After the plugin's `plugin` callback runs, `options` holds the sanitized config. */
14
24
  '@payloadcms/plugin-mcp': MCPPluginConfig
15
25
  }
26
+ export interface RequestContext {
27
+ /** Set on MCP requests before they're authenticated. */
28
+ mcp?: {
29
+ /** The MCP endpoint's address, which OAuth access tokens for MCP are issued for. */
30
+ resource: string
31
+ }
32
+ }
16
33
  }
17
34
 
18
- export type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig }
35
+ export type {
36
+ AuthorizedMCP,
37
+ MCPBuiltinOAuthConfig,
38
+ MCPExternalOAuthConfig,
39
+ MCPOAuthConfig,
40
+ MCPOAuthTokens,
41
+ MCPPluginConfig,
42
+ SanitizedMCPPluginConfig,
43
+ }
19
44
 
20
45
  export { defineCollectionTool, defineGlobalTool, definePrompt, defineTool } from './defineTool.js'
46
+ export { oauthProtectedResourceHandler } from './endpoint/oauth.js'
21
47
 
22
48
  export const mcpPlugin = definePlugin<MCPPluginConfig>({
23
49
  slug: '@payloadcms/plugin-mcp',
@@ -29,7 +55,7 @@ export const mcpPlugin = definePlugin<MCPPluginConfig>({
29
55
  const registered = plugins['@payloadcms/plugin-mcp']
30
56
  if (registered) {
31
57
  // @ts-expect-error
32
- registered.sanitizedOptions = pluginConfig as unknown as typeof registered.options
58
+ registered.sanitizedOptions = pluginConfig
33
59
  }
34
60
 
35
61
  if (pluginConfig.disabled) {
@@ -40,15 +66,24 @@ export const mcpPlugin = definePlugin<MCPPluginConfig>({
40
66
  ...config,
41
67
  endpoints: [
42
68
  ...(config.endpoints ?? []),
43
- // Payload prefixes /api, so the full path is /api/mcp.
44
- { handler: mcpEndpoint, method: 'post', path: '/mcp' },
69
+ // Payload prefixes /api, so the full path is /api/mcp. getAuthorizedMCP authenticates the
70
+ // request with dev auto-login turned off, so Payload doesn't authenticate it first.
71
+ { disableAuth: true, handler: mcpEndpoint, method: 'post', path: '/mcp' },
45
72
  // Streamable HTTP's optional server=>client GET stream. We don't offer
46
73
  // one, so answer 405 per spec-— clients then skip it cleanly
47
74
  {
75
+ disableAuth: true,
48
76
  handler: () => new Response(null, { headers: { Allow: 'POST' }, status: 405 }),
49
77
  method: 'get',
50
78
  path: '/mcp',
51
79
  },
80
+ {
81
+ disableAuth: true,
82
+ handler: oauthProtectedResourceEndpoint,
83
+ method: 'get',
84
+ path: '/mcp/oauth-protected-resource',
85
+ },
86
+ ...oauthServerEndpoints,
52
87
  ],
53
88
  }
54
89
  },
@@ -17,8 +17,6 @@ import type {
17
17
  import { getLogger } from '../utils/getLogger.js'
18
18
  import { toStandardSchema } from '../utils/toStandardSchema.js'
19
19
 
20
- z.config(z.locales.en())
21
-
22
20
  /**
23
21
  * Serving-entry-agnostic core: registers every authorized MCP item onto a fresh
24
22
  * `McpServer` and returns it. The HTTP and stdio entry point callers provide fresh
@@ -27,7 +25,7 @@ z.config(z.locales.en())
27
25
  *
28
26
  * `req` is the request context handlers see. For HTTP it's the live
29
27
  * `PayloadRequest` derived from the incoming HTTP request; for stdio it's a
30
- * synthesized one built via `createLocalReq`.
28
+ * synthesized one built via `createPayloadRequest`.
31
29
  */
32
30
  export const buildMcpServer = ({
33
31
  authorizedMCP,
@@ -38,6 +36,8 @@ export const buildMcpServer = ({
38
36
  pluginConfig: SanitizedMCPPluginConfig
39
37
  req: PayloadRequest
40
38
  }): McpServer => {
39
+ z.config(z.locales.en())
40
+
41
41
  const serverOptions = pluginConfig.mcp?.serverOptions || {}
42
42
  const server = new McpServer(
43
43
  { name: 'Payload MCP Server', version: '1.0.0', ...serverOptions.serverInfo },
@@ -250,7 +250,7 @@ const withSlugInput = ({ input }: { input?: ToolInputSchema }): ToolInputSchema
250
250
  const slugSchema = z.string().check(z.describe(description))
251
251
 
252
252
  if (!input) {
253
- return strictObject({ slug: slugSchema }) as unknown as ToolInputSchema
253
+ return strictObject({ slug: slugSchema })
254
254
  }
255
255
 
256
256
  if (typeof input === 'object' && input !== null && '~standard' in input) {
@@ -261,7 +261,7 @@ const withSlugInput = ({ input }: { input?: ToolInputSchema }): ToolInputSchema
261
261
  return input
262
262
  }
263
263
 
264
- return addSlugToJSONSchema({ description, schema: schema as JsonSchemaType })
264
+ return addSlugToJSONSchema({ description, schema })
265
265
  }
266
266
 
267
267
  return addSlugToJSONSchema({ description, schema: input })
@@ -1,4 +1,4 @@
1
- import { createLocalReq, strictObject, z } from 'payload'
1
+ import { createPayloadRequest, strictObject, z } from 'payload'
2
2
 
3
3
  import type { MCPToolResponse } from '../../../types.js'
4
4
 
@@ -53,7 +53,10 @@ export const authCollectionTool = defineCollectionTool({
53
53
  if (input.headers) {
54
54
  authHeaders = new Headers(input.headers)
55
55
  }
56
- const authReq = await createLocalReq({ req: { headers: authHeaders } }, req.payload)
56
+ const authReq = await createPayloadRequest({
57
+ payload: req.payload,
58
+ req: { headers: authHeaders },
59
+ })
57
60
  const result = await req.payload.auth({ headers: authHeaders, req: authReq })
58
61
 
59
62
  if (result.user) {
@@ -232,7 +235,7 @@ export const unlockCollectionTool = defineCollectionTool({
232
235
  text: `# Account Unlocked\n\n**Collection:** ${slug}\n**Email:** ${input.email}\n**Result:** ${result ? 'Success' : 'Failed'}`,
233
236
  },
234
237
  ],
235
- doc: { result } as Record<string, unknown>,
238
+ doc: { result },
236
239
  }
237
240
  } catch (error) {
238
241
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
@@ -267,7 +270,7 @@ export const verifyCollectionTool = defineCollectionTool({
267
270
  text: `# Email Verification Successful\n\n**Collection:** ${slug}\n**Result:** ${result ? 'Success' : 'Failed'}`,
268
271
  },
269
272
  ],
270
- doc: { result } as Record<string, unknown>,
273
+ doc: { result },
271
274
  }
272
275
  } catch (error) {
273
276
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
@@ -32,8 +32,17 @@ export const createDocumentsTool = defineCollectionTool({
32
32
  const payload = req.payload
33
33
  const collectionConfig = payload.collections[slug]?.config
34
34
  const logger = getLogger({ payload })
35
- const { depth, documents, draft, fallbackLocale, locale, populate, publishAllLocales, select } =
36
- input
35
+ const {
36
+ depth,
37
+ documents,
38
+ draft,
39
+ fallbackLocale,
40
+ locale,
41
+ populate,
42
+ publishAllLocales,
43
+ returning,
44
+ select,
45
+ } = input
37
46
  const shouldUsePartialSchema =
38
47
  draft === true && collectionConfig !== undefined && !hasDraftValidationEnabled(collectionConfig)
39
48
 
@@ -41,7 +50,9 @@ export const createDocumentsTool = defineCollectionTool({
41
50
 
42
51
  try {
43
52
  const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, slug)
44
- const docs: Array<{ doc: Record<string, unknown>; index: number }> = []
53
+ const docs: Array<
54
+ { doc: Record<string, unknown>; index: number } | { id: number | string; index: number }
55
+ > = []
45
56
  const errors: Array<{ index: number; message: string }> = []
46
57
  let validationSchema: Record<string, unknown> | undefined
47
58
 
@@ -69,10 +80,10 @@ export const createDocumentsTool = defineCollectionTool({
69
80
  ...(file ? { file } : {}),
70
81
  ...(locale ? { locale } : {}),
71
82
  ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
72
- ...(select ? { select } : {}),
83
+ select: returning ? select : { id: true },
73
84
  })
74
85
 
75
- docs.push({ doc: result as Record<string, unknown>, index })
86
+ docs.push(returning ? { doc: result, index } : { id: result.id, index })
76
87
  } catch (error) {
77
88
  const message = error instanceof Error ? error.message : 'Unknown error'
78
89
  const formattedError = formatEntityError({