@payloadcms/plugin-mcp 4.0.0-internal.5f0cd13 → 4.0.0-internal.811e0a4

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 (233) 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 -73
  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 -38
  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 -82
  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 -36
  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 +10 -0
  143. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -0
  144. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +384 -0
  145. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -0
  146. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +133 -0
  147. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -0
  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 +11 -16
  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 +169 -109
  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 -105
  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 -53
  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 +96 -0
  190. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +432 -0
  191. package/src/utils/whereSchema.ts +24 -0
  192. package/dist/collection/getAccessField.d.ts +0 -12
  193. package/dist/collection/getAccessField.d.ts.map +0 -1
  194. package/dist/collection/getAccessField.js +0 -57
  195. package/dist/collection/getAccessField.js.map +0 -1
  196. package/dist/collection/index.d.ts +0 -6
  197. package/dist/collection/index.d.ts.map +0 -1
  198. package/dist/collection/index.js +0 -59
  199. package/dist/collection/index.js.map +0 -1
  200. package/dist/components/AccessField/index.client.d.ts +0 -10
  201. package/dist/components/AccessField/index.client.d.ts.map +0 -1
  202. package/dist/components/AccessField/index.client.js +0 -305
  203. package/dist/components/AccessField/index.client.js.map +0 -1
  204. package/dist/components/AccessField/index.css +0 -93
  205. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts +0 -7
  206. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts.map +0 -1
  207. package/dist/utils/schemaConversion/prepareCollectionSchema.js +0 -37
  208. package/dist/utils/schemaConversion/prepareCollectionSchema.js.map +0 -1
  209. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  210. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  211. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  212. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  213. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +0 -13
  214. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +0 -1
  215. package/dist/utils/schemaConversion/sanitizeJsonSchema.js +0 -56
  216. package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +0 -1
  217. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +0 -20
  218. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +0 -1
  219. package/dist/utils/schemaConversion/simplifyRelationshipFields.js +0 -56
  220. package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +0 -1
  221. package/dist/utils/schemaConversion/transformPointFields.d.ts +0 -3
  222. package/dist/utils/schemaConversion/transformPointFields.d.ts.map +0 -1
  223. package/dist/utils/schemaConversion/transformPointFields.js +0 -57
  224. package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
  225. package/src/collection/getAccessField.ts +0 -64
  226. package/src/collection/index.ts +0 -63
  227. package/src/components/AccessField/index.client.tsx +0 -344
  228. package/src/components/AccessField/index.css +0 -93
  229. package/src/utils/schemaConversion/prepareCollectionSchema.ts +0 -39
  230. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
  231. package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
  232. package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -70
  233. package/src/utils/schemaConversion/transformPointFields.ts +0 -56
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@payloadcms/plugin-mcp",
3
- "version": "4.0.0-internal.5f0cd13",
3
+ "version": "4.0.0-internal.811e0a4",
4
4
  "description": "MCP (Model Context Protocol) capabilities with Payload",
5
5
  "keywords": [
6
6
  "plugin",
@@ -21,9 +21,6 @@
21
21
  "url": "https://payloadcms.com"
22
22
  }
23
23
  ],
24
- "sideEffects": [
25
- "*.css"
26
- ],
27
24
  "type": "module",
28
25
  "exports": {
29
26
  ".": {
@@ -40,6 +37,11 @@
40
37
  "import": "./dist/stdio.js",
41
38
  "types": "./dist/stdio.d.ts",
42
39
  "default": "./dist/stdio.js"
40
+ },
41
+ "./internal": {
42
+ "import": "./dist/exports/internal.js",
43
+ "types": "./dist/exports/internal.d.ts",
44
+ "default": "./dist/exports/internal.js"
43
45
  }
44
46
  },
45
47
  "main": "./dist/index.js",
@@ -53,26 +55,19 @@
53
55
  "bin.js"
54
56
  ],
55
57
  "dependencies": {
56
- "@cfworker/json-schema": "^4.1.1",
57
- "@modelcontextprotocol/server": "2.0.0-alpha.2",
58
- "tsx": "4.21.0",
59
- "zod": "^4.0.0"
58
+ "@modelcontextprotocol/server": "2.0.0-beta.2",
59
+ "tsx": "4.22.4",
60
+ "zod": "^4.2.0"
60
61
  },
61
62
  "devDependencies": {
62
- "@types/react": "19.2.14",
63
- "react": "^19.0.1 || ^19.1.2 || ^19.2.1",
64
63
  "@payloadcms/eslint-config": "3.28.0",
65
- "payload": "4.0.0-internal.5f0cd13",
66
- "@payloadcms/ui": "4.0.0-internal.5f0cd13"
64
+ "payload": "4.0.0-internal.811e0a4"
67
65
  },
68
66
  "peerDependencies": {
69
- "react": "^19.0.1 || ^19.1.2 || ^19.2.1",
70
- "@payloadcms/ui": "4.0.0-internal.5f0cd13",
71
- "payload": "4.0.0-internal.5f0cd13"
67
+ "payload": "4.0.0-internal.811e0a4"
72
68
  },
73
69
  "//deps_notes": {
74
70
  "zod": "zod is a hard dependency of @modelcontextprotocol/server, thus we can safely use it without it impacting bundle size. Make extra sure the zod version here matches exactly what's defined in the dependencies of @modelcontextprotocol/server to avoid duplicate versions being installed.",
75
- "@cfworker/json-schema": "Should be able to remove in next @modelcontextprotocol/server alpha release. Marked as an optional peer of @modelcontextprotocol/server, but its bundle does an eager top-level `import { Validator } from '@cfworker/json-schema'`, so it must be installed even when only zod-registered tools are used. Drop once upstream lazy-loads the validator. See: https://github.com/modelcontextprotocol/typescript-sdk",
76
71
  "tsx": "Required by the `bin.js` stdio mcp. Keep the version pinned to whatever `payload` ships to avoid duplicate installs."
77
72
  },
78
73
  "homepage:": "https://payloadcms.com",
@@ -0,0 +1,3 @@
1
+ import type { MCPAccessArgs } from './types.js'
2
+
3
+ export const defaultAccess = ({ req }: MCPAccessArgs): boolean => Boolean(req.user)
@@ -1,132 +1,119 @@
1
- import type { DefaultDocumentIDType, PayloadRequest, TypedUser } from 'payload'
1
+ import type { PayloadRequest, SanitizedPermissions } from 'payload'
2
2
 
3
- import crypto from 'crypto'
4
- import { UnauthorizedError } from 'payload'
3
+ import { getAccessResults, UnauthorizedError } from 'payload'
5
4
 
6
- import type { AuthorizedMCP, MCPAPIKeysDoc } from '../types.js'
5
+ import type { AuthorizedMCP, MCPItem } from '../types.js'
7
6
 
8
- import { getLogger } from '../utils/getLogger.js'
9
7
  import { getPluginConfig } from '../utils/getPluginConfig.js'
10
8
 
9
+ export type GetAuthorizedMCPArgs = {
10
+ overrideAccess: boolean
11
+ req: PayloadRequest
12
+ }
13
+
11
14
  /**
12
- * Resolves the API key (or dev-mode session) and returns the items the caller
13
- * may use. Denied items are dropped from the array.
15
+ * Resolves the MCP caller and returns the MCP surface authorized for that request.
16
+ *
17
+ * Authorization has two layers:
18
+ * 1. Payload collection/global permissions determine whether built-in operation tools are shown.
19
+ * 2. MCP `access` callbacks can further hide any configured tool, prompt, or resource.
20
+ *
21
+ * Like Payload core operations, `overrideAccess` skips both layers.
14
22
  */
15
- export const getAuthorizedMCP: (args: { req: PayloadRequest }) => Promise<AuthorizedMCP> = async ({
23
+ export const getAuthorizedMCP: (args: GetAuthorizedMCPArgs) => Promise<AuthorizedMCP> = async ({
24
+ overrideAccess,
16
25
  req,
17
26
  }) => {
18
- const logger = getLogger({ payload: req.payload })
19
27
  const pluginConfig = getPluginConfig({ config: req.payload.config })
20
28
 
21
- const authHeader = req.headers.get('Authorization')
22
- const hasBearerToken = authHeader?.startsWith('Bearer ')
23
-
24
- const buildAuthorized = (apiKeyDoc: MCPAPIKeysDoc): AuthorizedMCP => ({
25
- items: pluginConfig.items.filter((item) => {
26
- switch (item.type) {
27
- case 'collectionTool':
28
- return apiKeyDoc.access.collections?.[item.collectionSlug]?.[item.key] !== false
29
- case 'globalTool':
30
- return apiKeyDoc.access.globals?.[item.globalSlug]?.[item.key] !== false
31
- case 'prompt':
32
- return apiKeyDoc.access.prompts?.[item.key] !== false
33
- case 'resource':
34
- return apiKeyDoc.access.resources?.[item.key] !== false
35
- case 'tool':
36
- return apiKeyDoc.access.tools?.[item.key] !== false
37
- }
38
- }),
39
- overrideAccess:
40
- typeof apiKeyDoc.overrideAccess === 'boolean' ? apiKeyDoc.overrideAccess : false,
41
- user: apiKeyDoc.user,
42
- })
43
-
44
- if (pluginConfig.overrideAuth) {
45
- return await pluginConfig.overrideAuth({
46
- getAPIKeyDoc: (overrideApiKey) => getAPIKeyDoc({ logger, overrideApiKey, pluginConfig, req }),
47
- getAuthorizedMCP: ({ apiKeyDoc }) => buildAuthorized(apiKeyDoc),
29
+ if (pluginConfig.overrideGetAuthorizedMCP) {
30
+ return await pluginConfig.overrideGetAuthorizedMCP({
31
+ overrideAccess,
48
32
  pluginConfig,
49
33
  req,
50
34
  })
51
35
  }
52
36
 
53
- if (process.env.NODE_ENV === 'development' && !hasBearerToken) {
54
- logger.info('Dev mode: skipping API key check, using session user')
55
- return buildAuthorized({
56
- id: -1,
57
- access: {},
58
- overrideAccess: true,
59
- user: req.user ?? null,
60
- })
37
+ if (req.headers) {
38
+ const headers = new Headers(req.headers)
39
+ const hasAuthorization = headers.has('Authorization')
40
+
41
+ headers.set('DisableAutologin', 'true')
42
+ req.user = (await req.payload.auth({ headers, req })).user
43
+
44
+ if (hasAuthorization && !req.user) {
45
+ throw new UnauthorizedError(req.t)
46
+ }
61
47
  }
62
48
 
63
- return buildAuthorized(await getAPIKeyDoc({ logger, pluginConfig, req }))
49
+ return {
50
+ items: await filterMCPItems({
51
+ items: pluginConfig.items,
52
+ overrideAccess,
53
+ req,
54
+ }),
55
+ overrideAccess,
56
+ user: req.user,
57
+ }
64
58
  }
65
59
 
66
- const getAPIKeyDoc = async ({
67
- logger,
68
- overrideApiKey,
69
- pluginConfig,
60
+ export const filterMCPItems = async ({
61
+ items,
62
+ overrideAccess,
70
63
  req,
71
64
  }: {
72
- logger: ReturnType<typeof getLogger>
73
- overrideApiKey?: string
74
- pluginConfig: ReturnType<typeof getPluginConfig>
65
+ items: MCPItem[]
66
+ overrideAccess: boolean
75
67
  req: PayloadRequest
76
- }): Promise<MCPAPIKeysDoc> => {
77
- const authHeader = req.headers.get('Authorization')
78
- const hasBearerToken = authHeader?.startsWith('Bearer ')
79
-
80
- const apiKey =
81
- overrideApiKey ?? (hasBearerToken ? authHeader?.replace('Bearer ', '').trim() || null : null)
82
-
83
- if (!apiKey) {
84
- throw new UnauthorizedError()
85
- }
86
-
87
- const sha256APIKeyIndex = crypto
88
- .createHmac('sha256', req.payload.secret)
89
- .update(apiKey)
90
- .digest('hex')
91
-
92
- const doc = await req.payload.db.findOne<MCPAPIKeysDoc>({
93
- collection: 'payload-mcp-api-keys',
94
- req,
95
- where: {
96
- apiKeyIndex: { equals: sha256APIKeyIndex },
97
- },
98
- })
99
-
100
- if (!doc || !doc.user) {
101
- throw new UnauthorizedError()
68
+ }): Promise<MCPItem[]> => {
69
+ // Match Payload core: overrideAccess bypasses access evaluation instead of
70
+ // forcing each access function to return true.
71
+ if (overrideAccess) {
72
+ return items
102
73
  }
103
74
 
104
- logger.info('API Key is valid')
75
+ const authorizedItems: MCPItem[] = []
105
76
 
106
- const userRef = doc.user
107
- const userID =
108
- typeof userRef === 'object' && userRef !== null && 'id' in userRef
109
- ? userRef.id
110
- : (userRef as unknown as DefaultDocumentIDType)
77
+ const permissions = await getAccessResults({ req })
111
78
 
112
- const user = (await req.payload.findByID({
113
- id: userID,
114
- collection: pluginConfig.userCollection,
115
- depth: 0,
116
- disableErrors: true,
117
- req,
118
- })) as null | TypedUser
119
-
120
- if (!user) {
121
- throw new UnauthorizedError()
79
+ for (const item of items) {
80
+ if (!(await checkItemAccess({ item, permissions, req }))) {
81
+ continue
82
+ }
83
+ authorizedItems.push(item)
122
84
  }
123
85
 
124
- return {
125
- ...doc,
126
- user: {
127
- ...user,
128
- _strategy: 'mcp-api-key' as const,
129
- collection: pluginConfig.userCollection,
130
- },
86
+ return authorizedItems
87
+ }
88
+
89
+ /**
90
+ * Runs MCP item access callbacks
91
+ */
92
+ const checkItemAccess = async ({
93
+ item,
94
+ permissions,
95
+ req,
96
+ }: {
97
+ item: MCPItem
98
+ permissions?: SanitizedPermissions
99
+ req: PayloadRequest
100
+ }): Promise<boolean> => {
101
+ switch (item.type) {
102
+ case 'collectionTool':
103
+ return (
104
+ !item.tool.access ||
105
+ (await item.tool.access({ collectionSlug: item.collectionSlug, permissions, req }))
106
+ )
107
+ case 'globalTool':
108
+ return (
109
+ !item.tool.access ||
110
+ (await item.tool.access({ globalSlug: item.globalSlug, permissions, req }))
111
+ )
112
+ case 'prompt':
113
+ return !item.prompt.access || (await item.prompt.access({ permissions, req }))
114
+ case 'resource':
115
+ return !item.resource.access || (await item.resource.access({ permissions, req }))
116
+ case 'tool':
117
+ return !item.tool.access || (await item.tool.access({ permissions, req }))
131
118
  }
132
119
  }
@@ -1,5 +1,11 @@
1
- import { WebStandardStreamableHTTPServerTransport } from '@modelcontextprotocol/server'
2
- import { APIError, type PayloadHandler } from 'payload'
1
+ import type { PayloadHandler, PayloadRequest } from 'payload'
2
+
3
+ import {
4
+ createMcpHandler,
5
+ isLegacyRequest,
6
+ WebStandardStreamableHTTPServerTransport,
7
+ } from '@modelcontextprotocol/server'
8
+ import { APIError } from 'payload'
3
9
 
4
10
  import { buildMcpServer } from '../mcp/buildMcpServer.js'
5
11
  import { getPluginConfig } from '../utils/getPluginConfig.js'
@@ -13,23 +19,59 @@ export const mcpEndpoint: PayloadHandler = async (req) => {
13
19
  req.payloadAPI = 'MCP' as const
14
20
 
15
21
  const pluginConfig = getPluginConfig({ config: req.payload.config })
16
- const authorizedMCP = await getAuthorizedMCP({ req })
22
+ const overrideAccessParam = new URL(req.url).searchParams.get('overrideAccess')
17
23
 
18
- const server = buildMcpServer({ authorizedMCP, pluginConfig, req })
24
+ if (overrideAccessParam !== null && process.env.NODE_ENV !== 'development') {
25
+ throw new APIError('MCP overrideAccess is only available in development.', 400)
26
+ }
19
27
 
20
- const transport = new WebStandardStreamableHTTPServerTransport({
21
- enableJsonResponse: true,
22
- sessionIdGenerator: undefined, // stateless mode
23
- })
28
+ let overrideAccess = false
29
+ if (overrideAccessParam === 'true') {
30
+ overrideAccess = true
31
+ } else if (overrideAccessParam !== null && overrideAccessParam !== 'false') {
32
+ throw new APIError('MCP overrideAccess must be "true" or "false".', 400)
33
+ }
24
34
 
25
- await server.connect(transport)
35
+ const authorizedMCP = await getAuthorizedMCP({ overrideAccess, req })
36
+ // Payload augments the original web-standard Request in place.
37
+ const mcpRequest = req as PayloadRequest & Request
26
38
 
27
- const mcpRequest = new Request(req.url, {
28
- body: req.body,
29
- duplex: 'half',
30
- headers: req.headers,
31
- method: req.method,
32
- } as { duplex: 'half' } & RequestInit)
39
+ // Keep the old JSON-only, stateless behavior because the SDK's 2025 fallback uses SSE.
40
+ if (await isLegacyRequest(mcpRequest)) {
41
+ const server = buildMcpServer({ authorizedMCP, pluginConfig, req })
42
+ const transport = new WebStandardStreamableHTTPServerTransport({
43
+ enableJsonResponse: true,
44
+ sessionIdGenerator: undefined, // stateless mode
45
+ })
46
+ transport.onerror = (err) => {
47
+ req.payload.logger.error({ err, msg: 'Error serving legacy MCP request' })
48
+ }
33
49
 
34
- return await transport.handleRequest(mcpRequest)
50
+ try {
51
+ await server.connect(transport)
52
+ return await transport.handleRequest(mcpRequest)
53
+ } finally {
54
+ await server.close().catch((err) => {
55
+ req.payload.logger.error({ err, msg: 'Error closing MCP server' })
56
+ })
57
+ }
58
+ }
59
+
60
+ const handler = createMcpHandler(() => buildMcpServer({ authorizedMCP, pluginConfig, req }), {
61
+ legacy: 'reject',
62
+ // SDK subscriptions always use SSE, so disable them to keep every response JSON-only.
63
+ maxSubscriptions: 0,
64
+ onerror: (err) => {
65
+ req.payload.logger.error({ err, msg: 'Error serving modern MCP request' })
66
+ },
67
+ responseMode: 'json',
68
+ })
69
+
70
+ try {
71
+ return await handler.fetch(mcpRequest)
72
+ } finally {
73
+ await handler.close().catch((err) => {
74
+ req.payload.logger.error({ err, msg: 'Error closing modern MCP handler' })
75
+ })
76
+ }
35
77
  }
@@ -1,2 +1,3 @@
1
1
  'use client'
2
- export { AccessField } from '../components/AccessField/index.client.js'
2
+
3
+ export {}
@@ -0,0 +1 @@
1
+ export { filterMCPItems, getAuthorizedMCP } from '../endpoint/access.js'
package/src/index.ts CHANGED
@@ -1,14 +1,13 @@
1
- import { defaultUserCollection, definePlugin } from 'payload'
1
+ import { definePlugin } from 'payload'
2
2
 
3
3
  import type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig } from './types.js'
4
4
 
5
- import { getAPIKeysCollection } from './collection/index.js'
6
5
  import { mcpEndpoint } from './endpoint/index.js'
7
6
  import { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js'
8
7
 
9
8
  declare module 'payload' {
10
- export interface PayloadRequest {
11
- payloadAPI: 'GraphQL' | 'local' | 'MCP' | 'REST'
9
+ export interface PayloadRequestAPI {
10
+ MCP: true
12
11
  }
13
12
  interface RegisteredPlugins {
14
13
  /** After the plugin's `plugin` callback runs, `options` holds the sanitized config. */
@@ -23,18 +22,8 @@ export { defineCollectionTool, defineGlobalTool, definePrompt, defineTool } from
23
22
  export const mcpPlugin = definePlugin<MCPPluginConfig>({
24
23
  slug: '@payloadcms/plugin-mcp',
25
24
  order: 10,
26
- plugin: ({ config, plugins, ...rawConfig }) => {
27
- // Our `payload-mcp-api-keys` is auth-enabled; if it'd be the only auth
28
- // collection, Payload's later sanitize would pick it as `admin.user`.
29
- // Pre-seed the default user collection to prevent that.
30
- if (!config.admin?.user) {
31
- const firstCollectionWithAuth = (config.collections ?? []).find(({ auth }) => Boolean(auth))
32
- if (!firstCollectionWithAuth) {
33
- ;(config.collections ??= []).push(defaultUserCollection)
34
- }
35
- }
36
-
37
- const pluginConfig = sanitizeMCPConfig({ config, pluginConfig: rawConfig })
25
+ plugin: ({ config, options, plugins }) => {
26
+ const pluginConfig = sanitizeMCPConfig({ config, pluginConfig: options })
38
27
 
39
28
  // Stash the sanitized config on plugin options so `getPluginConfig()` reads it.
40
29
  const registered = plugins['@payloadcms/plugin-mcp']
@@ -43,10 +32,6 @@ export const mcpPlugin = definePlugin<MCPPluginConfig>({
43
32
  registered.sanitizedOptions = pluginConfig as unknown as typeof registered.options
44
33
  }
45
34
 
46
- ;(config.collections ??= []).push(getAPIKeysCollection({ pluginConfig }))
47
-
48
- // Keep the API-keys collection registered even when disabled, so DB schema
49
- // and generated types don't drift between enabled/disabled environments.
50
35
  if (pluginConfig.disabled) {
51
36
  return config
52
37
  }
@@ -57,6 +42,13 @@ export const mcpPlugin = definePlugin<MCPPluginConfig>({
57
42
  ...(config.endpoints ?? []),
58
43
  // Payload prefixes /api, so the full path is /api/mcp.
59
44
  { handler: mcpEndpoint, method: 'post', path: '/mcp' },
45
+ // Streamable HTTP's optional server=>client GET stream. We don't offer
46
+ // one, so answer 405 per spec-— clients then skip it cleanly
47
+ {
48
+ handler: () => new Response(null, { headers: { Allow: 'POST' }, status: 405 }),
49
+ method: 'get',
50
+ path: '/mcp',
51
+ },
60
52
  ],
61
53
  }
62
54
  },