@payloadcms/plugin-mcp 4.0.0-canary.2 → 4.0.0-canary.20261117

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 (529) 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/defineTool.d.ts +8 -8
  7. package/dist/defineTool.d.ts.map +1 -1
  8. package/dist/endpoint/access.d.ts +29 -6
  9. package/dist/endpoint/access.d.ts.map +1 -1
  10. package/dist/endpoint/access.js +133 -100
  11. package/dist/endpoint/access.js.map +1 -1
  12. package/dist/endpoint/index.d.ts +1 -1
  13. package/dist/endpoint/index.d.ts.map +1 -1
  14. package/dist/endpoint/index.js +121 -16
  15. package/dist/endpoint/index.js.map +1 -1
  16. package/dist/endpoint/oauth.d.ts +37 -0
  17. package/dist/endpoint/oauth.d.ts.map +1 -0
  18. package/dist/endpoint/oauth.js +105 -0
  19. package/dist/endpoint/oauth.js.map +1 -0
  20. package/dist/endpoint/oauthLoginToken.d.ts +27 -0
  21. package/dist/endpoint/oauthLoginToken.d.ts.map +1 -0
  22. package/dist/endpoint/oauthLoginToken.js +86 -0
  23. package/dist/endpoint/oauthLoginToken.js.map +1 -0
  24. package/dist/endpoint/oauthServer.d.ts +28 -0
  25. package/dist/endpoint/oauthServer.d.ts.map +1 -0
  26. package/dist/endpoint/oauthServer.js +455 -0
  27. package/dist/endpoint/oauthServer.js.map +1 -0
  28. package/dist/exports/client.d.ts +1 -4
  29. package/dist/exports/client.d.ts.map +1 -1
  30. package/dist/exports/client.js +1 -4
  31. package/dist/exports/client.js.map +1 -1
  32. package/dist/exports/internal.d.ts +2 -0
  33. package/dist/exports/internal.d.ts.map +1 -0
  34. package/dist/exports/internal.js +3 -0
  35. package/dist/exports/internal.js.map +1 -0
  36. package/dist/exports/rsc.d.ts +2 -0
  37. package/dist/exports/rsc.d.ts.map +1 -0
  38. package/dist/exports/rsc.js +3 -0
  39. package/dist/exports/rsc.js.map +1 -0
  40. package/dist/index.d.ts +12 -4
  41. package/dist/index.d.ts.map +1 -1
  42. package/dist/index.js +31 -55
  43. package/dist/index.js.map +1 -1
  44. package/dist/mcp/buildMcpServer.d.ts +6 -6
  45. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  46. package/dist/mcp/buildMcpServer.js +70 -34
  47. package/dist/mcp/buildMcpServer.js.map +1 -1
  48. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  49. package/dist/mcp/builtin/collections/authTools.js +123 -61
  50. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  51. package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
  52. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
  53. package/dist/mcp/builtin/collections/countTool.js +63 -0
  54. package/dist/mcp/builtin/collections/countTool.js.map +1 -0
  55. package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
  56. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
  57. package/dist/mcp/builtin/collections/countVersionsTool.js +60 -0
  58. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
  59. package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
  60. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  61. package/dist/mcp/builtin/collections/createTool.js +109 -66
  62. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  63. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  64. package/dist/mcp/builtin/collections/deleteTool.js +56 -45
  65. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  66. package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
  67. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
  68. package/dist/mcp/builtin/collections/duplicateTool.js +90 -0
  69. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
  70. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  71. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  72. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  73. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  74. package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
  75. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
  76. package/dist/mcp/builtin/collections/findDistinctTool.js +77 -0
  77. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
  78. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  79. package/dist/mcp/builtin/collections/findTool.js +58 -56
  80. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  81. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
  82. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
  83. package/dist/mcp/builtin/collections/findVersionByIDTool.js +74 -0
  84. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
  85. package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
  86. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
  87. package/dist/mcp/builtin/collections/findVersionsTool.js +84 -0
  88. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
  89. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  90. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +78 -10
  91. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  92. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
  93. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
  94. package/dist/mcp/builtin/collections/restoreVersionTool.js +69 -0
  95. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
  96. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  97. package/dist/mcp/builtin/collections/updateTool.js +75 -102
  98. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  99. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  100. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  101. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  102. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  103. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  104. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  105. package/dist/mcp/builtin/formatEntityError.js +55 -0
  106. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  107. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  108. package/dist/mcp/builtin/getConfigInfoTool.js +30 -10
  109. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  110. package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
  111. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
  112. package/dist/mcp/builtin/globals/countVersionsTool.js +60 -0
  113. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
  114. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  115. package/dist/mcp/builtin/globals/findTool.js +26 -35
  116. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  117. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
  118. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
  119. package/dist/mcp/builtin/globals/findVersionByIDTool.js +68 -0
  120. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
  121. package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
  122. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
  123. package/dist/mcp/builtin/globals/findVersionsTool.js +78 -0
  124. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
  125. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  126. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +56 -10
  127. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  128. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
  129. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
  130. package/dist/mcp/builtin/globals/restoreVersionTool.js +70 -0
  131. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
  132. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  133. package/dist/mcp/builtin/globals/updateTool.js +38 -54
  134. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  135. package/dist/mcp/builtinTools.d.ts +75 -12
  136. package/dist/mcp/builtinTools.d.ts.map +1 -1
  137. package/dist/mcp/builtinTools.js +75 -13
  138. package/dist/mcp/builtinTools.js.map +1 -1
  139. package/dist/mcp/sanitizeMCPConfig.d.ts +0 -1
  140. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  141. package/dist/mcp/sanitizeMCPConfig.js +76 -27
  142. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  143. package/dist/stdio.d.ts +3 -3
  144. package/dist/stdio.d.ts.map +1 -1
  145. package/dist/stdio.js +86 -47
  146. package/dist/stdio.js.map +1 -1
  147. package/dist/types.d.ts +224 -95
  148. package/dist/types.d.ts.map +1 -1
  149. package/dist/types.js +2 -4
  150. package/dist/types.js.map +1 -1
  151. package/dist/utils/camelCase.d.ts.map +1 -1
  152. package/dist/utils/getPluginConfig.d.ts +1 -1
  153. package/dist/utils/getPluginConfig.js +1 -1
  154. package/dist/utils/getPluginConfig.js.map +1 -1
  155. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  156. package/dist/utils/seal.d.ts +17 -0
  157. package/dist/utils/seal.d.ts.map +1 -0
  158. package/dist/utils/seal.js +24 -0
  159. package/dist/utils/seal.js.map +1 -0
  160. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  161. package/dist/utils/toStandardSchema.js.map +1 -1
  162. package/dist/views/Authorize/AllowButtons/index.d.ts +18 -0
  163. package/dist/views/Authorize/AllowButtons/index.d.ts.map +1 -0
  164. package/dist/views/Authorize/AllowButtons/index.js +88 -0
  165. package/dist/views/Authorize/AllowButtons/index.js.map +1 -0
  166. package/dist/views/Authorize/index.css +19 -0
  167. package/dist/views/Authorize/index.d.ts +9 -0
  168. package/dist/views/Authorize/index.d.ts.map +1 -0
  169. package/dist/views/Authorize/index.js +98 -0
  170. package/dist/views/Authorize/index.js.map +1 -0
  171. package/package.json +34 -38
  172. package/src/defaultAccess.ts +3 -0
  173. package/src/endpoint/access.ts +149 -109
  174. package/src/endpoint/index.ts +103 -15
  175. package/src/endpoint/oauth.ts +108 -0
  176. package/src/endpoint/oauthLoginToken.ts +100 -0
  177. package/src/endpoint/oauthServer.ts +472 -0
  178. package/src/exports/client.ts +2 -4
  179. package/src/exports/internal.ts +1 -0
  180. package/src/exports/rsc.ts +1 -0
  181. package/src/index.ts +53 -63
  182. package/src/mcp/buildMcpServer.ts +88 -51
  183. package/src/mcp/builtin/collections/authTools.ts +124 -77
  184. package/src/mcp/builtin/collections/countTool.ts +61 -0
  185. package/src/mcp/builtin/collections/countVersionsTool.ts +60 -0
  186. package/src/mcp/builtin/collections/createTool.ts +113 -82
  187. package/src/mcp/builtin/collections/deleteTool.ts +49 -66
  188. package/src/mcp/builtin/collections/duplicateTool.ts +84 -0
  189. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  190. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  191. package/src/mcp/builtin/collections/findDistinctTool.ts +67 -0
  192. package/src/mcp/builtin/collections/findTool.ts +54 -97
  193. package/src/mcp/builtin/collections/findVersionByIDTool.ts +66 -0
  194. package/src/mcp/builtin/collections/findVersionsTool.ts +83 -0
  195. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +70 -7
  196. package/src/mcp/builtin/collections/restoreVersionTool.ts +65 -0
  197. package/src/mcp/builtin/collections/updateTool.ts +72 -110
  198. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  199. package/src/mcp/builtin/formatEntityError.ts +77 -0
  200. package/src/mcp/builtin/getConfigInfoTool.ts +29 -5
  201. package/src/mcp/builtin/globals/countVersionsTool.ts +60 -0
  202. package/src/mcp/builtin/globals/findTool.ts +27 -57
  203. package/src/mcp/builtin/globals/findVersionByIDTool.ts +64 -0
  204. package/src/mcp/builtin/globals/findVersionsTool.ts +69 -0
  205. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +52 -7
  206. package/src/mcp/builtin/globals/restoreVersionTool.ts +68 -0
  207. package/src/mcp/builtin/globals/updateTool.ts +49 -72
  208. package/src/mcp/builtinTools.ts +81 -18
  209. package/src/mcp/sanitizeMCPConfig.ts +53 -30
  210. package/src/stdio.ts +80 -47
  211. package/src/types.ts +232 -99
  212. package/src/utils/getPluginConfig.ts +1 -1
  213. package/src/utils/seal.ts +46 -0
  214. package/src/utils/toStandardSchema.ts +1 -1
  215. package/src/views/Authorize/AllowButtons/index.tsx +97 -0
  216. package/src/views/Authorize/index.css +19 -0
  217. package/src/views/Authorize/index.tsx +100 -0
  218. package/dist/collection/getAccessField.d.ts +0 -12
  219. package/dist/collection/getAccessField.d.ts.map +0 -1
  220. package/dist/collection/getAccessField.js +0 -72
  221. package/dist/collection/getAccessField.js.map +0 -1
  222. package/dist/collection/index.d.ts +0 -6
  223. package/dist/collection/index.d.ts.map +0 -1
  224. package/dist/collection/index.js +0 -105
  225. package/dist/collection/index.js.map +0 -1
  226. package/dist/components/APIKeyField/index.client.d.ts +0 -9
  227. package/dist/components/APIKeyField/index.client.d.ts.map +0 -1
  228. package/dist/components/APIKeyField/index.client.js +0 -85
  229. package/dist/components/APIKeyField/index.client.js.map +0 -1
  230. package/dist/components/APIKeyField/index.css +0 -105
  231. package/dist/components/APIKeysEmptyState/index.client.d.ts +0 -4
  232. package/dist/components/APIKeysEmptyState/index.client.d.ts.map +0 -1
  233. package/dist/components/APIKeysEmptyState/index.client.js +0 -21
  234. package/dist/components/APIKeysEmptyState/index.client.js.map +0 -1
  235. package/dist/components/AccessField/index.client.d.ts +0 -10
  236. package/dist/components/AccessField/index.client.d.ts.map +0 -1
  237. package/dist/components/AccessField/index.client.js +0 -247
  238. package/dist/components/AccessField/index.client.js.map +0 -1
  239. package/dist/components/AccessField/index.css +0 -99
  240. package/dist/components/SettingsMenu/index.client.d.ts +0 -8
  241. package/dist/components/SettingsMenu/index.client.d.ts.map +0 -1
  242. package/dist/components/SettingsMenu/index.client.js +0 -29
  243. package/dist/components/SettingsMenu/index.client.js.map +0 -1
  244. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +0 -9
  245. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +0 -1
  246. package/dist/mcp/builtin/collections/formatCollectionError.js +0 -60
  247. package/dist/mcp/builtin/collections/formatCollectionError.js.map +0 -1
  248. package/dist/mcp/builtin/validateEntityData.d.ts +0 -14
  249. package/dist/mcp/builtin/validateEntityData.d.ts.map +0 -1
  250. package/dist/mcp/builtin/validateEntityData.js +0 -82
  251. package/dist/mcp/builtin/validateEntityData.js.map +0 -1
  252. package/dist/translations/index.d.ts +0 -11
  253. package/dist/translations/index.d.ts.map +0 -1
  254. package/dist/translations/index.js +0 -92
  255. package/dist/translations/index.js.map +0 -1
  256. package/dist/translations/languages/ar.d.ts +0 -31
  257. package/dist/translations/languages/ar.d.ts.map +0 -1
  258. package/dist/translations/languages/ar.js +0 -34
  259. package/dist/translations/languages/ar.js.map +0 -1
  260. package/dist/translations/languages/az.d.ts +0 -31
  261. package/dist/translations/languages/az.d.ts.map +0 -1
  262. package/dist/translations/languages/az.js +0 -34
  263. package/dist/translations/languages/az.js.map +0 -1
  264. package/dist/translations/languages/bg.d.ts +0 -31
  265. package/dist/translations/languages/bg.d.ts.map +0 -1
  266. package/dist/translations/languages/bg.js +0 -34
  267. package/dist/translations/languages/bg.js.map +0 -1
  268. package/dist/translations/languages/bnBd.d.ts +0 -31
  269. package/dist/translations/languages/bnBd.d.ts.map +0 -1
  270. package/dist/translations/languages/bnBd.js +0 -34
  271. package/dist/translations/languages/bnBd.js.map +0 -1
  272. package/dist/translations/languages/bnIn.d.ts +0 -31
  273. package/dist/translations/languages/bnIn.d.ts.map +0 -1
  274. package/dist/translations/languages/bnIn.js +0 -34
  275. package/dist/translations/languages/bnIn.js.map +0 -1
  276. package/dist/translations/languages/ca.d.ts +0 -31
  277. package/dist/translations/languages/ca.d.ts.map +0 -1
  278. package/dist/translations/languages/ca.js +0 -34
  279. package/dist/translations/languages/ca.js.map +0 -1
  280. package/dist/translations/languages/cs.d.ts +0 -31
  281. package/dist/translations/languages/cs.d.ts.map +0 -1
  282. package/dist/translations/languages/cs.js +0 -34
  283. package/dist/translations/languages/cs.js.map +0 -1
  284. package/dist/translations/languages/da.d.ts +0 -31
  285. package/dist/translations/languages/da.d.ts.map +0 -1
  286. package/dist/translations/languages/da.js +0 -34
  287. package/dist/translations/languages/da.js.map +0 -1
  288. package/dist/translations/languages/de.d.ts +0 -31
  289. package/dist/translations/languages/de.d.ts.map +0 -1
  290. package/dist/translations/languages/de.js +0 -34
  291. package/dist/translations/languages/de.js.map +0 -1
  292. package/dist/translations/languages/en.d.ts +0 -31
  293. package/dist/translations/languages/en.d.ts.map +0 -1
  294. package/dist/translations/languages/en.js +0 -34
  295. package/dist/translations/languages/en.js.map +0 -1
  296. package/dist/translations/languages/es.d.ts +0 -31
  297. package/dist/translations/languages/es.d.ts.map +0 -1
  298. package/dist/translations/languages/es.js +0 -34
  299. package/dist/translations/languages/es.js.map +0 -1
  300. package/dist/translations/languages/et.d.ts +0 -31
  301. package/dist/translations/languages/et.d.ts.map +0 -1
  302. package/dist/translations/languages/et.js +0 -34
  303. package/dist/translations/languages/et.js.map +0 -1
  304. package/dist/translations/languages/fa.d.ts +0 -31
  305. package/dist/translations/languages/fa.d.ts.map +0 -1
  306. package/dist/translations/languages/fa.js +0 -34
  307. package/dist/translations/languages/fa.js.map +0 -1
  308. package/dist/translations/languages/fr.d.ts +0 -31
  309. package/dist/translations/languages/fr.d.ts.map +0 -1
  310. package/dist/translations/languages/fr.js +0 -34
  311. package/dist/translations/languages/fr.js.map +0 -1
  312. package/dist/translations/languages/he.d.ts +0 -31
  313. package/dist/translations/languages/he.d.ts.map +0 -1
  314. package/dist/translations/languages/he.js +0 -34
  315. package/dist/translations/languages/he.js.map +0 -1
  316. package/dist/translations/languages/hr.d.ts +0 -31
  317. package/dist/translations/languages/hr.d.ts.map +0 -1
  318. package/dist/translations/languages/hr.js +0 -34
  319. package/dist/translations/languages/hr.js.map +0 -1
  320. package/dist/translations/languages/hu.d.ts +0 -31
  321. package/dist/translations/languages/hu.d.ts.map +0 -1
  322. package/dist/translations/languages/hu.js +0 -34
  323. package/dist/translations/languages/hu.js.map +0 -1
  324. package/dist/translations/languages/hy.d.ts +0 -31
  325. package/dist/translations/languages/hy.d.ts.map +0 -1
  326. package/dist/translations/languages/hy.js +0 -34
  327. package/dist/translations/languages/hy.js.map +0 -1
  328. package/dist/translations/languages/id.d.ts +0 -31
  329. package/dist/translations/languages/id.d.ts.map +0 -1
  330. package/dist/translations/languages/id.js +0 -34
  331. package/dist/translations/languages/id.js.map +0 -1
  332. package/dist/translations/languages/is.d.ts +0 -31
  333. package/dist/translations/languages/is.d.ts.map +0 -1
  334. package/dist/translations/languages/is.js +0 -34
  335. package/dist/translations/languages/is.js.map +0 -1
  336. package/dist/translations/languages/it.d.ts +0 -31
  337. package/dist/translations/languages/it.d.ts.map +0 -1
  338. package/dist/translations/languages/it.js +0 -34
  339. package/dist/translations/languages/it.js.map +0 -1
  340. package/dist/translations/languages/ja.d.ts +0 -31
  341. package/dist/translations/languages/ja.d.ts.map +0 -1
  342. package/dist/translations/languages/ja.js +0 -34
  343. package/dist/translations/languages/ja.js.map +0 -1
  344. package/dist/translations/languages/ko.d.ts +0 -31
  345. package/dist/translations/languages/ko.d.ts.map +0 -1
  346. package/dist/translations/languages/ko.js +0 -34
  347. package/dist/translations/languages/ko.js.map +0 -1
  348. package/dist/translations/languages/lt.d.ts +0 -31
  349. package/dist/translations/languages/lt.d.ts.map +0 -1
  350. package/dist/translations/languages/lt.js +0 -34
  351. package/dist/translations/languages/lt.js.map +0 -1
  352. package/dist/translations/languages/lv.d.ts +0 -31
  353. package/dist/translations/languages/lv.d.ts.map +0 -1
  354. package/dist/translations/languages/lv.js +0 -34
  355. package/dist/translations/languages/lv.js.map +0 -1
  356. package/dist/translations/languages/my.d.ts +0 -31
  357. package/dist/translations/languages/my.d.ts.map +0 -1
  358. package/dist/translations/languages/my.js +0 -34
  359. package/dist/translations/languages/my.js.map +0 -1
  360. package/dist/translations/languages/nb.d.ts +0 -31
  361. package/dist/translations/languages/nb.d.ts.map +0 -1
  362. package/dist/translations/languages/nb.js +0 -34
  363. package/dist/translations/languages/nb.js.map +0 -1
  364. package/dist/translations/languages/nl.d.ts +0 -31
  365. package/dist/translations/languages/nl.d.ts.map +0 -1
  366. package/dist/translations/languages/nl.js +0 -34
  367. package/dist/translations/languages/nl.js.map +0 -1
  368. package/dist/translations/languages/pl.d.ts +0 -31
  369. package/dist/translations/languages/pl.d.ts.map +0 -1
  370. package/dist/translations/languages/pl.js +0 -34
  371. package/dist/translations/languages/pl.js.map +0 -1
  372. package/dist/translations/languages/pt.d.ts +0 -31
  373. package/dist/translations/languages/pt.d.ts.map +0 -1
  374. package/dist/translations/languages/pt.js +0 -34
  375. package/dist/translations/languages/pt.js.map +0 -1
  376. package/dist/translations/languages/ro.d.ts +0 -31
  377. package/dist/translations/languages/ro.d.ts.map +0 -1
  378. package/dist/translations/languages/ro.js +0 -34
  379. package/dist/translations/languages/ro.js.map +0 -1
  380. package/dist/translations/languages/rs.d.ts +0 -31
  381. package/dist/translations/languages/rs.d.ts.map +0 -1
  382. package/dist/translations/languages/rs.js +0 -34
  383. package/dist/translations/languages/rs.js.map +0 -1
  384. package/dist/translations/languages/rsLatin.d.ts +0 -31
  385. package/dist/translations/languages/rsLatin.d.ts.map +0 -1
  386. package/dist/translations/languages/rsLatin.js +0 -34
  387. package/dist/translations/languages/rsLatin.js.map +0 -1
  388. package/dist/translations/languages/ru.d.ts +0 -31
  389. package/dist/translations/languages/ru.d.ts.map +0 -1
  390. package/dist/translations/languages/ru.js +0 -34
  391. package/dist/translations/languages/ru.js.map +0 -1
  392. package/dist/translations/languages/sk.d.ts +0 -31
  393. package/dist/translations/languages/sk.d.ts.map +0 -1
  394. package/dist/translations/languages/sk.js +0 -34
  395. package/dist/translations/languages/sk.js.map +0 -1
  396. package/dist/translations/languages/sl.d.ts +0 -31
  397. package/dist/translations/languages/sl.d.ts.map +0 -1
  398. package/dist/translations/languages/sl.js +0 -34
  399. package/dist/translations/languages/sl.js.map +0 -1
  400. package/dist/translations/languages/sv.d.ts +0 -31
  401. package/dist/translations/languages/sv.d.ts.map +0 -1
  402. package/dist/translations/languages/sv.js +0 -34
  403. package/dist/translations/languages/sv.js.map +0 -1
  404. package/dist/translations/languages/ta.d.ts +0 -31
  405. package/dist/translations/languages/ta.d.ts.map +0 -1
  406. package/dist/translations/languages/ta.js +0 -34
  407. package/dist/translations/languages/ta.js.map +0 -1
  408. package/dist/translations/languages/th.d.ts +0 -31
  409. package/dist/translations/languages/th.d.ts.map +0 -1
  410. package/dist/translations/languages/th.js +0 -34
  411. package/dist/translations/languages/th.js.map +0 -1
  412. package/dist/translations/languages/tr.d.ts +0 -31
  413. package/dist/translations/languages/tr.d.ts.map +0 -1
  414. package/dist/translations/languages/tr.js +0 -34
  415. package/dist/translations/languages/tr.js.map +0 -1
  416. package/dist/translations/languages/uk.d.ts +0 -31
  417. package/dist/translations/languages/uk.d.ts.map +0 -1
  418. package/dist/translations/languages/uk.js +0 -34
  419. package/dist/translations/languages/uk.js.map +0 -1
  420. package/dist/translations/languages/vi.d.ts +0 -31
  421. package/dist/translations/languages/vi.d.ts.map +0 -1
  422. package/dist/translations/languages/vi.js +0 -34
  423. package/dist/translations/languages/vi.js.map +0 -1
  424. package/dist/translations/languages/zh.d.ts +0 -31
  425. package/dist/translations/languages/zh.d.ts.map +0 -1
  426. package/dist/translations/languages/zh.js +0 -34
  427. package/dist/translations/languages/zh.js.map +0 -1
  428. package/dist/translations/languages/zhTw.d.ts +0 -31
  429. package/dist/translations/languages/zhTw.d.ts.map +0 -1
  430. package/dist/translations/languages/zhTw.js +0 -34
  431. package/dist/translations/languages/zhTw.js.map +0 -1
  432. package/dist/translations/types.d.ts +0 -32
  433. package/dist/translations/types.d.ts.map +0 -1
  434. package/dist/translations/types.js +0 -3
  435. package/dist/translations/types.js.map +0 -1
  436. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  437. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  438. package/dist/utils/getVirtualFieldNames.js +0 -35
  439. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  440. package/dist/utils/localAPIDefaults.d.ts +0 -20
  441. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  442. package/dist/utils/localAPIDefaults.js +0 -19
  443. package/dist/utils/localAPIDefaults.js.map +0 -1
  444. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -11
  445. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  446. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -34
  447. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  448. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  449. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  450. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  451. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  452. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -15
  453. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  454. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -464
  455. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  456. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -158
  457. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  458. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  459. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  460. package/dist/utils/transformPointDataToPayload.js +0 -28
  461. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  462. package/dist/utils/whereSchema.d.ts +0 -9
  463. package/dist/utils/whereSchema.d.ts.map +0 -1
  464. package/dist/utils/whereSchema.js +0 -13
  465. package/dist/utils/whereSchema.js.map +0 -1
  466. package/src/collection/getAccessField.ts +0 -84
  467. package/src/collection/index.ts +0 -105
  468. package/src/components/APIKeyField/index.client.tsx +0 -73
  469. package/src/components/APIKeyField/index.css +0 -105
  470. package/src/components/APIKeysEmptyState/index.client.tsx +0 -36
  471. package/src/components/AccessField/index.client.tsx +0 -299
  472. package/src/components/AccessField/index.css +0 -99
  473. package/src/components/SettingsMenu/index.client.tsx +0 -34
  474. package/src/mcp/builtin/collections/formatCollectionError.ts +0 -84
  475. package/src/mcp/builtin/validateEntityData.ts +0 -132
  476. package/src/translations/index.ts +0 -108
  477. package/src/translations/languages/ar.ts +0 -35
  478. package/src/translations/languages/az.ts +0 -35
  479. package/src/translations/languages/bg.ts +0 -35
  480. package/src/translations/languages/bnBd.ts +0 -35
  481. package/src/translations/languages/bnIn.ts +0 -35
  482. package/src/translations/languages/ca.ts +0 -35
  483. package/src/translations/languages/cs.ts +0 -35
  484. package/src/translations/languages/da.ts +0 -35
  485. package/src/translations/languages/de.ts +0 -35
  486. package/src/translations/languages/en.ts +0 -35
  487. package/src/translations/languages/es.ts +0 -35
  488. package/src/translations/languages/et.ts +0 -35
  489. package/src/translations/languages/fa.ts +0 -35
  490. package/src/translations/languages/fr.ts +0 -35
  491. package/src/translations/languages/he.ts +0 -35
  492. package/src/translations/languages/hr.ts +0 -35
  493. package/src/translations/languages/hu.ts +0 -35
  494. package/src/translations/languages/hy.ts +0 -35
  495. package/src/translations/languages/id.ts +0 -35
  496. package/src/translations/languages/is.ts +0 -35
  497. package/src/translations/languages/it.ts +0 -35
  498. package/src/translations/languages/ja.ts +0 -35
  499. package/src/translations/languages/ko.ts +0 -35
  500. package/src/translations/languages/lt.ts +0 -35
  501. package/src/translations/languages/lv.ts +0 -35
  502. package/src/translations/languages/my.ts +0 -35
  503. package/src/translations/languages/nb.ts +0 -35
  504. package/src/translations/languages/nl.ts +0 -35
  505. package/src/translations/languages/pl.ts +0 -35
  506. package/src/translations/languages/pt.ts +0 -35
  507. package/src/translations/languages/ro.ts +0 -35
  508. package/src/translations/languages/rs.ts +0 -35
  509. package/src/translations/languages/rsLatin.ts +0 -35
  510. package/src/translations/languages/ru.ts +0 -35
  511. package/src/translations/languages/sk.ts +0 -35
  512. package/src/translations/languages/sl.ts +0 -35
  513. package/src/translations/languages/sv.ts +0 -35
  514. package/src/translations/languages/ta.ts +0 -35
  515. package/src/translations/languages/th.ts +0 -35
  516. package/src/translations/languages/tr.ts +0 -35
  517. package/src/translations/languages/uk.ts +0 -35
  518. package/src/translations/languages/vi.ts +0 -35
  519. package/src/translations/languages/zh.ts +0 -35
  520. package/src/translations/languages/zhTw.ts +0 -35
  521. package/src/translations/types.ts +0 -34
  522. package/src/utils/getVirtualFieldNames.ts +0 -53
  523. package/src/utils/localAPIDefaults.ts +0 -22
  524. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -78
  525. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
  526. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -103
  527. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -529
  528. package/src/utils/transformPointDataToPayload.ts +0 -40
  529. package/src/utils/whereSchema.ts +0 -24
package/src/types.ts CHANGED
@@ -1,23 +1,24 @@
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,
10
+ ToolAnnotations,
9
11
  } from '@modelcontextprotocol/server'
10
12
  import type {
11
13
  AuthCollectionSlug,
12
- CollectionConfig,
13
14
  CollectionSlug,
14
- DefaultDocumentIDType,
15
15
  GlobalSlug,
16
16
  MaybePromise,
17
17
  PayloadRequest,
18
- TypedUser,
18
+ SanitizedPermissions,
19
19
  } from 'payload'
20
20
 
21
+ import type { GetAuthorizedMCPArgs } from './endpoint/access.js'
21
22
  import type {
22
23
  MCPCollectionAuthToolName,
23
24
  MCPCollectionBuiltinName,
@@ -26,36 +27,16 @@ import type {
26
27
 
27
28
  export type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName }
28
29
 
29
- /** Re-exported from `@modelcontextprotocol/server` — the JSON Schema shape the MCP runtime validates against. */
30
- export type { JsonSchemaType, StandardSchemaWithJSON }
30
+ /** Re-exported from `@modelcontextprotocol/server` — common MCP types used in plugin config. */
31
+ export type { JsonSchemaType, StandardSchemaWithJSON, ToolAnnotations }
31
32
 
32
33
  /**
33
34
  * What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw
34
- * JSON Schema literal, or a Standard Schema instance (Zod, Valibot, …).
35
+ * JSON Schema 2020-12 literal, or a Standard Schema instance (Zod, Valibot, …).
36
+ * Raw schemas may omit `$schema`; when present it must declare the 2020-12 dialect.
35
37
  */
36
38
  export type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON
37
39
 
38
- /**
39
- * Serializable mirror of `SanitizedMCPPluginConfig` for client components —
40
- * the full sanitized config carries functions (tool handlers, etc.) that can't
41
- * cross the server→client boundary. Built by `sanitizeClientPluginConfig` and
42
- * passed to the `AccessField` component via `clientProps`.
43
- *
44
- * @internal
45
- */
46
- export type ClientMCPPluginConfig = {
47
- items: Array<{
48
- collectionSlug?: string
49
- configKey: string
50
- description?: string
51
- globalSlug?: string
52
- /** Admin-UI bucket for collection/global tools: built-in CRUD, auth, or custom. */
53
- group?: 'auth' | 'custom' | 'operations'
54
- label: string
55
- type: 'collectionTool' | 'globalTool' | 'prompt' | 'resource' | 'tool'
56
- }>
57
- }
58
-
59
40
  export type MCPToolResponse = {
60
41
  content: ContentBlock[]
61
42
  /**
@@ -72,6 +53,13 @@ export type MCPResponseOverride = (
72
53
  req: PayloadRequest,
73
54
  ) => MCPToolResponse
74
55
 
56
+ export type MCPAfterToolCallHook = (args: {
57
+ input: unknown
58
+ req: PayloadRequest
59
+ response: MCPToolResponse
60
+ toolName: string
61
+ }) => MaybePromise<MCPToolResponse>
62
+
75
63
  /**
76
64
  * The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets
77
65
  * its inferred output; anything else falls back to `Record<string, unknown>`.
@@ -82,6 +70,19 @@ export type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON
82
70
  : StandardSchemaWithJSON.InferOutput<TSchema>
83
71
  : Record<string, unknown>
84
72
 
73
+ export type MCPAccessArgs = {
74
+ permissions?: SanitizedPermissions
75
+ req: PayloadRequest
76
+ }
77
+
78
+ export type CollectionMCPAccessArgs = {
79
+ slug: CollectionSlug
80
+ } & MCPAccessArgs
81
+
82
+ export type GlobalMCPAccessArgs = {
83
+ slug: GlobalSlug
84
+ } & MCPAccessArgs
85
+
85
86
  export type ToolHandlerArgs<TSchema = undefined> = {
86
87
  authorizedMCP: AuthorizedMCP
87
88
  input: TypedInput<TSchema>
@@ -90,14 +91,21 @@ export type ToolHandlerArgs<TSchema = undefined> = {
90
91
  }
91
92
 
92
93
  export type CollectionToolHandlerArgs<TSchema = undefined> = {
93
- collectionSlug: CollectionSlug
94
+ slug: CollectionSlug
94
95
  } & ToolHandlerArgs<TSchema>
95
96
 
96
97
  export type GlobalToolHandlerArgs<TSchema = undefined> = {
97
- globalSlug: GlobalSlug
98
+ slug: GlobalSlug
98
99
  } & ToolHandlerArgs<TSchema>
99
100
 
100
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
+ */
107
+ access?: (args: MCPAccessArgs) => MaybePromise<boolean>
108
+ annotations?: ToolAnnotations
101
109
  description: string
102
110
  handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
103
111
  input?: TSchema
@@ -110,22 +118,54 @@ export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema |
110
118
  export type CollectionTool<
111
119
  TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
112
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
+ */
127
+ access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
113
128
  handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
114
129
  input?: TSchema
115
- } & Pick<Tool, 'description' | 'overrideResponse'>
130
+ } & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>
116
131
 
117
132
  export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =
118
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
+ */
140
+ access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
119
141
  handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
120
142
  input?: TSchema
121
- } & Pick<Tool, 'description' | 'overrideResponse'>
143
+ } & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>
122
144
 
123
145
  /**
124
146
  * Configures (or disables) a built-in tool without replacing it.
125
147
  * `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a
126
148
  * required handler) from being silently accepted at a built-in key slot.
127
149
  */
128
- export type MCPBuiltInToolOverride = {
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
+ */
155
+ access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
156
+ annotations?: ToolAnnotations
157
+ description?: string
158
+ handler?: never
159
+ overrideResponse?: MCPResponseOverride
160
+ }
161
+
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
+ */
167
+ access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
168
+ annotations?: ToolAnnotations
129
169
  description?: string
130
170
  handler?: never
131
171
  overrideResponse?: MCPResponseOverride
@@ -139,13 +179,13 @@ export type MCPBuiltInToolOverride = {
139
179
  export type MCPTopLevelToolEntry = Tool
140
180
 
141
181
  export type MCPCollectionToolsMap = {
142
- [customToolName: string]: boolean | CollectionTool | MCPBuiltInToolOverride | undefined
182
+ [customToolName: string]: boolean | CollectionTool | MCPBuiltInCollectionToolOverride | undefined
143
183
  } & {
144
- [K in MCPCollectionBuiltinName]?: false | MCPBuiltInToolOverride
184
+ [K in MCPCollectionBuiltinName]?: false | MCPBuiltInCollectionToolOverride
145
185
  }
146
186
 
147
187
  export type MCPAuthCollectionToolsMap = {
148
- [K in MCPCollectionAuthToolName]?: MCPBuiltInToolOverride | true
188
+ [K in MCPCollectionAuthToolName]?: MCPBuiltInCollectionToolOverride | true
149
189
  } & MCPCollectionToolsMap
150
190
 
151
191
  /** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */
@@ -154,9 +194,9 @@ export type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends
154
194
  : MCPCollectionToolsMap
155
195
 
156
196
  export type MCPGlobalToolsMap = {
157
- [customToolName: string]: boolean | GlobalTool | MCPBuiltInToolOverride | undefined
197
+ [customToolName: string]: boolean | GlobalTool | MCPBuiltInGlobalToolOverride | undefined
158
198
  } & {
159
- [K in MCPGlobalBuiltinName]?: false | MCPBuiltInToolOverride
199
+ [K in MCPGlobalBuiltinName]?: false | MCPBuiltInGlobalToolOverride
160
200
  }
161
201
 
162
202
  export type MCPTopLevelToolsMap = Record<string, Tool>
@@ -168,6 +208,12 @@ export type PromptHandlerArgs<TSchema = undefined> = {
168
208
  }
169
209
 
170
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
+ */
216
+ access?: (args: MCPAccessArgs) => MaybePromise<boolean>
171
217
  argsSchema: TSchema
172
218
  description: string
173
219
  handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{
@@ -185,6 +231,12 @@ export type ResourceHandlerArgs = {
185
231
  }
186
232
 
187
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
+ */
239
+ access?: (args: MCPAccessArgs) => MaybePromise<boolean>
188
240
  description: string
189
241
  handler: (args: ResourceHandlerArgs) => MaybePromise<{
190
242
  contents: Array<{ text: string; uri: string }>
@@ -215,90 +267,174 @@ export type MCPPluginGlobalConfig = {
215
267
  * actually works with.
216
268
  */
217
269
  export type MCPPluginConfig = {
270
+ /**
271
+ * Decides who can use MCP at all. Runs on every MCP request once the user is authenticated,
272
+ * before the `access` callbacks of tools, prompts, and resources, and when a user allows an MCP
273
+ * client on the built-in OAuth server's sign-in page. Return `false` to answer MCP requests with
274
+ * `403` and to refuse to sign the client in. This is skipped when `overrideAccess` is enabled.
275
+ * `overrideGetAuthorizedMCP` replaces it on MCP requests.
276
+ *
277
+ * It only applies to MCP, not to Payload's REST or GraphQL APIs, so it doesn't replace access
278
+ * control on collections and globals.
279
+ *
280
+ * @default no check, so tools, prompts, and resources decide on their own
281
+ */
282
+ access?: (args: MCPAccessArgs) => MaybePromise<boolean>
218
283
  collections?: {
219
284
  [Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>
220
285
  }
221
- /** Skip MCP registration. The API key collection is still added (so DB / types stay stable). */
286
+ /** Skip MCP endpoint registration. */
222
287
  disabled?: boolean
223
288
  globals?: {
224
289
  [Slug in GlobalSlug]?: MCPPluginGlobalConfig
225
290
  }
291
+ hooks?: {
292
+ /** Transform a tool response after its handler returns */
293
+ afterToolCall?: MCPAfterToolCallHook[]
294
+ }
226
295
  mcp?: {
296
+ /**
297
+ * Largest HTTP request body, in bytes, that the MCP endpoint accepts. Larger requests
298
+ * are answered with `413`. Base64 file uploads count toward this limit.
299
+ *
300
+ * @default 4194304 (4 MiB, the MCP SDK default)
301
+ */
302
+ maxRequestBodySize?: number
227
303
  serverOptions?: MCPServerOptions
228
304
  verboseLogs?: boolean
229
305
  }
230
- overrideApiKeyCollection?: (collection: CollectionConfig) => CollectionConfig
231
- /** Replace the default API-key auth with a custom resolver. */
232
- overrideAuth?: (args: {
233
- getAPIKeyDoc: (overrideApiKey?: string) => Promise<MCPAPIKeysDoc>
234
- getAuthorizedMCP: (args: { apiKeyDoc: MCPAPIKeysDoc }) => AuthorizedMCP
235
- pluginConfig: SanitizedMCPPluginConfig
236
- req: PayloadRequest
237
- }) => MaybePromise<AuthorizedMCP>
306
+ /**
307
+ * How MCP clients sign in. MCP requests without an authenticated user get a `401` that points
308
+ * to the protected resource metadata (RFC 9728). Set to `false` to only accept API keys and
309
+ * anonymous requests.
310
+ *
311
+ * @default { type: 'builtin' }
312
+ */
313
+ oauth?: false | MCPOAuthConfig
314
+ /**
315
+ * Replace the default MCP authorization resolver.
316
+ *
317
+ * This hook replaces the default authentication flow, including the plugin's `access`. It must
318
+ * set `req.user` to the authenticated Payload user, or to `null` for an anonymous caller, before
319
+ * returning.
320
+ */
321
+ overrideGetAuthorizedMCP?: (
322
+ args: {
323
+ pluginConfig: SanitizedMCPPluginConfig
324
+ } & GetAuthorizedMCPArgs,
325
+ ) => MaybePromise<AuthorizedMCP>
238
326
  prompts?: Record<string, Prompt>
239
327
  resources?: Record<string, Resource>
240
328
  /** Cross-cutting tools (not scoped to any collection or global). */
241
329
  tools?: MCPTopLevelToolsMap
242
- userCollection?: CollectionSlug
243
330
  }
244
331
 
245
- export type SanitizedMCPPluginConfig = {
246
- items: MCPItem[]
247
- userCollection: CollectionSlug
248
- } & Pick<MCPPluginConfig, 'disabled' | 'mcp' | 'overrideApiKeyCollection' | 'overrideAuth'>
249
-
250
- export type MCPServerOptions = {
251
- options?: ConstructorParameters<typeof McpServer>[1]
252
- serverInfo?: Partial<ConstructorParameters<typeof McpServer>[0]>
253
- }
332
+ export type MCPOAuthConfig = MCPBuiltinOAuthConfig | MCPExternalOAuthConfig
254
333
 
255
334
  /**
256
- * Nested access tree as stored in the collection.
257
- * A `false` leaf disables that tool; missing keys defer to
258
- * defaults (built-in CRUD is on, opt-in tools are off).
335
+ * This Payload app is the authorization server. Users sign in to the admin panel and allow the
336
+ * MCP client, which then gets an access token for them.
259
337
  */
260
- export type MCPAPIKeysDocAccessTree = {
261
- collections?: {
262
- [CollectionSlug: CollectionSlug]: {
263
- [ToolKey: string]: boolean
264
- }
265
- }
266
- globals?: {
267
- [GlobalSlug: GlobalSlug]: {
268
- [ToolKey: string]: boolean
269
- }
270
- }
271
- prompts?: {
272
- [PromptKey: string]: boolean
273
- }
274
- resources?: {
275
- [ResourceKey: string]: boolean
276
- }
277
- tools?: {
278
- [ToolKey: string]: boolean
279
- }
338
+ export type MCPBuiltinOAuthConfig = {
339
+ /**
340
+ * Creates the tokens the MCP client gets when the user clicks Allow. `req` is the user's own
341
+ * browser request, so `req.user` is the user who allowed it. Pass `authenticate` too if
342
+ * Payload's auth strategies don't accept the access token.
343
+ *
344
+ * @default a Payload login token for that user that only works for MCP, with a refresh token when
345
+ * the collection uses sessions. Its session is labelled with the client's name.
346
+ */
347
+ issueToken?: (args: {
348
+ /** The MCP client the user allowed, with the address it returns to. */
349
+ client: { name: string; redirectURI: string }
350
+ req: PayloadRequest
351
+ }) => MaybePromise<MCPOAuthTokens>
352
+ /**
353
+ * Trades a refresh token from `issueToken`, or from an earlier refresh, for new tokens. Return
354
+ * `null` when it's no longer valid, and the client sends the user through sign-in again. `req`
355
+ * is the MCP client's request, without a user. Only used together with `issueToken`.
356
+ *
357
+ * OAuth requires noticing copied refresh tokens: return a new refresh token every time, and
358
+ * revoke the tokens when an already used refresh token comes back.
359
+ *
360
+ * It also runs when the client trades its authorization code, on the refresh token from
361
+ * `issueToken`, with `reuseInterval: 0`. OAuth requires a code to work only once, so refuse that
362
+ * refresh token if it was used before, even moments ago.
363
+ */
364
+ refreshToken?: (args: {
365
+ refreshToken: string
366
+ req: PayloadRequest
367
+ /**
368
+ * How long a refresh token that was just used may still be accepted, in milliseconds, e.g. for
369
+ * clients that refresh twice at once. `0` means not at all. When it's missing, use your usual
370
+ * leeway.
371
+ */
372
+ reuseInterval?: number
373
+ }) => MaybePromise<MCPOAuthTokens | null>
374
+ type: 'builtin'
375
+ } & MCPOAuthSharedConfig
376
+
377
+ export type MCPOAuthTokens = {
378
+ accessToken: string
379
+ /** Seconds until the access token expires. */
380
+ expiresIn?: number
381
+ /** Lets the client get new tokens without the user, through `refreshToken`. */
382
+ refreshToken?: string
280
383
  }
281
384
 
282
- /**
283
- * Stored on `payload-mcp-api-keys` docs
284
- */
285
- export type MCPAPIKeysDoc = {
286
- access: MCPAPIKeysDocAccessTree
287
- apiKey?: string
288
- apiKeyIndex?: string
289
- id: DefaultDocumentIDType
290
- lastUsed?: string
291
- overrideAccess?: boolean
292
- user: null | TypedUser
385
+ /** Another service, e.g. your identity provider, is the authorization server. */
386
+ export type MCPExternalOAuthConfig = {
387
+ /**
388
+ * The authorization servers that issue access tokens for MCP clients. Clients require each one
389
+ * to exactly match the `issuer` in that server's metadata, so pass a function when the exact
390
+ * value is only known at runtime, e.g. from the server's OpenID configuration or per host.
391
+ */
392
+ authorizationServers: ((args: { req: PayloadRequest }) => MaybePromise<string[]>) | string[]
393
+ /**
394
+ * Scopes MCP clients should request, e.g. `['openid', 'email', 'profile']`. Without them,
395
+ * clients request none, which some authorization servers reject or answer with a token that
396
+ * doesn't identify the user.
397
+ */
398
+ scopes?: string[]
399
+ type: 'external'
400
+ } & MCPOAuthSharedConfig
401
+
402
+ type MCPOAuthSharedConfig = {
403
+ /**
404
+ * Called on MCP requests with a bearer token that Payload's auth strategies didn't accept.
405
+ * Return the Payload user, including its `collection`, or `null` to answer with the OAuth challenge.
406
+ */
407
+ authenticate?: (args: {
408
+ req: PayloadRequest
409
+ token: string
410
+ }) => MaybePromise<PayloadRequest['user']>
411
+ /**
412
+ * The URL clients call to reach the MCP endpoint. The metadata link and the built-in
413
+ * authorization server's issuer are based on it.
414
+ *
415
+ * @default the absolute URL of `/api/mcp`, based on `serverURL` or the request URL
416
+ */
417
+ resource?: ((args: { req: PayloadRequest }) => string) | string
418
+ }
419
+
420
+ export type SanitizedMCPPluginConfig = {
421
+ items: MCPItem[]
422
+ /** `undefined` when OAuth is turned off. */
423
+ oauth?: MCPOAuthConfig
424
+ } & Pick<MCPPluginConfig, 'access' | 'disabled' | 'hooks' | 'mcp' | 'overrideGetAuthorizedMCP'>
425
+
426
+ export type MCPServerOptions = {
427
+ options?: McpServerOptions
428
+ serverInfo?: Partial<Implementation>
293
429
  }
294
430
 
295
431
  /**
296
- * One MCP primitive plus the metadata needed for access checks, admin UI, and
432
+ * One MCP primitive plus the metadata needed for config-driven filtering and
297
433
  * registration.
298
434
  *
299
- * - `configKey`: the config/API-key identifier, e.g. `find` or `echo`.
435
+ * - `configKey`: the config identifier, e.g. `find` or `echo`.
300
436
  * - `mcpName`: the MCP wire name, e.g. `findDocuments` or `echo`.
301
- * - `label`: human-readable admin checkbox text.
437
+ * - `label`: human-readable display text.
302
438
  */
303
439
  export type MCPItemBase = {
304
440
  configKey: string
@@ -335,13 +471,10 @@ export type MCPItem =
335
471
  | GlobalMCPItem
336
472
 
337
473
  /**
338
- * The caller's identity + the MCP items they can use for this request. Returned
339
- * by `getAuthorizedMCP`; denied items are simply absent from `items`. Handlers
340
- * receive this via `args.authorizedMCP` so they can spread
341
- * `localAPIDefaults(authorizedMCP)` into every local API call.
474
+ * The MCP items and access mode authorized for this request. The authenticated user is available
475
+ * as `req.user`.
342
476
  */
343
477
  export type AuthorizedMCP = {
344
478
  items: MCPItem[]
345
479
  overrideAccess: boolean
346
- user: null | TypedUser
347
480
  }
@@ -5,7 +5,7 @@ import type { SanitizedMCPPluginConfig } from '../types.js'
5
5
  /**
6
6
  * Returns the sanitized plugin config — the form produced by
7
7
  * `sanitizeMCPConfig` and stashed back on the plugin's `options` during init.
8
- * Callers downstream of plugin init can rely on `items`, `userCollection`, etc.
8
+ * Callers downstream of plugin init can rely on `items` and other defaults
9
9
  * being fully resolved.
10
10
  */
11
11
  export const getPluginConfig: (args: { config: SanitizedConfig }) => SanitizedMCPPluginConfig = ({
@@ -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
+ expiresInSeconds,
11
+ req,
12
+ }: {
13
+ data: object
14
+ expiresInSeconds?: number
15
+ req: PayloadRequest
16
+ type: string
17
+ }): string =>
18
+ req.payload.encrypt(
19
+ JSON.stringify({
20
+ ...data,
21
+ type,
22
+ exp: expiresInSeconds && Date.now() + expiresInSeconds * 1000,
23
+ }),
24
+ )
25
+
26
+ export const unseal = <T>({
27
+ type,
28
+ req,
29
+ value,
30
+ }: {
31
+ req: PayloadRequest
32
+ type: string
33
+ value: null | string
34
+ }): T | undefined => {
35
+ // Only the v1 format is authenticated. Older formats decrypt anything without an error.
36
+ if (!value?.startsWith('v1:')) {
37
+ return undefined
38
+ }
39
+
40
+ try {
41
+ const data = JSON.parse(req.payload.decrypt(value, { secret: req.payload.config.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)
@@ -0,0 +1,97 @@
1
+ 'use client'
2
+
3
+ import { Button } from '@payloadcms/ui'
4
+ import React, { useEffect, useState, useSyncExternalStore } from 'react'
5
+
6
+ const baseClass = 'mcp-authorize'
7
+
8
+ /** How long the page must have been in front of the user before the buttons work, in ms. */
9
+ const enableDelay = 1000
10
+
11
+ // Whether the page is inside a frame never changes, so there's nothing to subscribe to
12
+ const subscribe = () => () => {}
13
+
14
+ /**
15
+ * The Allow and Deny buttons, protected against clicks the user didn't mean for this page:
16
+ *
17
+ * - Inside a frame they aren't shown, so other sites can't frame the page and trick users into
18
+ * clicking them. The server can't tell, so they're missing until the browser has checked.
19
+ * - They're disabled until the page has been visible and focused for a moment. Otherwise another
20
+ * site could open the page under the user's cursor while they double-click something else, so
21
+ * the second click lands on Allow. Leaving the page disables them again. Waiting works for every
22
+ * way of clicking, unlike requiring a mouse movement or key press first.
23
+ *
24
+ * @see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-17#section-7.11 for why the
25
+ * OAuth server must prevent clickjacking
26
+ * @see https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html#defending-against-doubleclickjacking
27
+ * for the double-click attack and its mitigation
28
+ */
29
+ export function AllowButtons() {
30
+ const isTopLevel = useSyncExternalStore(
31
+ subscribe,
32
+ () => window.top === window.self,
33
+ () => false,
34
+ )
35
+ const [isEnabled, setIsEnabled] = useState(false)
36
+
37
+ useEffect(() => {
38
+ let timeout: ReturnType<typeof setTimeout> | undefined
39
+
40
+ const enableAfterDelay = () => {
41
+ clearTimeout(timeout)
42
+ if (document.visibilityState === 'visible' && document.hasFocus()) {
43
+ timeout = setTimeout(() => setIsEnabled(true), enableDelay)
44
+ }
45
+ }
46
+ const disable = () => {
47
+ clearTimeout(timeout)
48
+ setIsEnabled(false)
49
+ }
50
+ const onVisibilityChange = () => {
51
+ if (document.visibilityState === 'visible') {
52
+ enableAfterDelay()
53
+ } else {
54
+ disable()
55
+ }
56
+ }
57
+
58
+ enableAfterDelay()
59
+ window.addEventListener('focus', enableAfterDelay)
60
+ window.addEventListener('blur', disable)
61
+ document.addEventListener('visibilitychange', onVisibilityChange)
62
+
63
+ return () => {
64
+ clearTimeout(timeout)
65
+ window.removeEventListener('focus', enableAfterDelay)
66
+ window.removeEventListener('blur', disable)
67
+ document.removeEventListener('visibilitychange', onVisibilityChange)
68
+ }
69
+ }, [])
70
+
71
+ if (!isTopLevel) {
72
+ return null
73
+ }
74
+
75
+ return (
76
+ <div className={`${baseClass}__actions`}>
77
+ <Button
78
+ buttonStyle="primary"
79
+ disabled={!isEnabled}
80
+ extraButtonProps={{ name: 'decision', value: 'allow' }}
81
+ margin={false}
82
+ type="submit"
83
+ >
84
+ Allow
85
+ </Button>
86
+ <Button
87
+ buttonStyle="secondary"
88
+ disabled={!isEnabled}
89
+ extraButtonProps={{ name: 'decision', value: 'deny' }}
90
+ margin={false}
91
+ type="submit"
92
+ >
93
+ Deny
94
+ </Button>
95
+ </div>
96
+ )
97
+ }
@@ -0,0 +1,19 @@
1
+ @layer payload-default {
2
+ .mcp-authorize {
3
+ overflow-wrap: anywhere;
4
+ }
5
+
6
+ .mcp-authorize__brand {
7
+ display: flex;
8
+ justify-content: center;
9
+ width: 100%;
10
+ margin-block-end: var(--spacer-5);
11
+ }
12
+
13
+ .mcp-authorize__actions {
14
+ display: flex;
15
+ flex-wrap: wrap;
16
+ justify-content: center;
17
+ gap: var(--spacer-2);
18
+ }
19
+ }