@payloadcms/plugin-mcp 4.0.0-internal.5b1e7cd → 4.0.0-internal.5d2e3d1

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 (446) hide show
  1. package/LICENSE.md +1 -1
  2. package/bin.js +39 -0
  3. package/dist/defaultAccess.d.ts +3 -0
  4. package/dist/defaultAccess.d.ts.map +1 -0
  5. package/dist/defaultAccess.js +3 -0
  6. package/dist/defaultAccess.js.map +1 -0
  7. package/dist/defineTool.d.ts +26 -0
  8. package/dist/defineTool.d.ts.map +1 -0
  9. package/dist/defineTool.js +37 -0
  10. package/dist/defineTool.js.map +1 -0
  11. package/dist/endpoint/access.d.ts +22 -0
  12. package/dist/endpoint/access.d.ts.map +1 -0
  13. package/dist/endpoint/access.js +130 -0
  14. package/dist/endpoint/access.js.map +1 -0
  15. package/dist/endpoint/index.d.ts +3 -0
  16. package/dist/endpoint/index.d.ts.map +1 -0
  17. package/dist/endpoint/index.js +141 -0
  18. package/dist/endpoint/index.js.map +1 -0
  19. package/dist/endpoint/oauth.d.ts +37 -0
  20. package/dist/endpoint/oauth.d.ts.map +1 -0
  21. package/dist/endpoint/oauth.js +105 -0
  22. package/dist/endpoint/oauth.js.map +1 -0
  23. package/dist/endpoint/oauthLoginToken.d.ts +23 -0
  24. package/dist/endpoint/oauthLoginToken.d.ts.map +1 -0
  25. package/dist/endpoint/oauthLoginToken.js +80 -0
  26. package/dist/endpoint/oauthLoginToken.js.map +1 -0
  27. package/dist/endpoint/oauthServer.d.ts +28 -0
  28. package/dist/endpoint/oauthServer.d.ts.map +1 -0
  29. package/dist/endpoint/oauthServer.js +423 -0
  30. package/dist/endpoint/oauthServer.js.map +1 -0
  31. package/dist/exports/client.d.ts +2 -0
  32. package/dist/exports/client.d.ts.map +1 -0
  33. package/dist/exports/client.js +4 -0
  34. package/dist/exports/client.js.map +1 -0
  35. package/dist/exports/internal.d.ts +2 -0
  36. package/dist/exports/internal.d.ts.map +1 -0
  37. package/dist/exports/internal.js +3 -0
  38. package/dist/exports/internal.js.map +1 -0
  39. package/dist/exports/rsc.d.ts +2 -0
  40. package/dist/exports/rsc.d.ts.map +1 -0
  41. package/dist/exports/rsc.js +3 -0
  42. package/dist/exports/rsc.js.map +1 -0
  43. package/dist/index.d.ts +14 -9
  44. package/dist/index.d.ts.map +1 -1
  45. package/dist/index.js +63 -67
  46. package/dist/index.js.map +1 -1
  47. package/dist/mcp/buildMcpServer.d.ts +19 -0
  48. package/dist/mcp/buildMcpServer.d.ts.map +1 -0
  49. package/dist/mcp/buildMcpServer.js +235 -0
  50. package/dist/mcp/buildMcpServer.js.map +1 -0
  51. package/dist/mcp/builtin/collections/authTools.d.ts +7 -0
  52. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -0
  53. package/dist/mcp/builtin/collections/authTools.js +312 -0
  54. package/dist/mcp/builtin/collections/authTools.js.map +1 -0
  55. package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
  56. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
  57. package/dist/mcp/builtin/collections/countTool.js +63 -0
  58. package/dist/mcp/builtin/collections/countTool.js.map +1 -0
  59. package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
  60. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
  61. package/dist/mcp/builtin/collections/countVersionsTool.js +60 -0
  62. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
  63. package/dist/mcp/builtin/collections/createTool.d.ts +2 -0
  64. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -0
  65. package/dist/mcp/builtin/collections/createTool.js +137 -0
  66. package/dist/mcp/builtin/collections/createTool.js.map +1 -0
  67. package/dist/mcp/builtin/collections/deleteTool.d.ts +2 -0
  68. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -0
  69. package/dist/mcp/builtin/collections/deleteTool.js +113 -0
  70. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -0
  71. package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
  72. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
  73. package/dist/mcp/builtin/collections/duplicateTool.js +90 -0
  74. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
  75. package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
  76. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  77. package/dist/mcp/builtin/collections/fileInput.js +88 -0
  78. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  79. package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
  80. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
  81. package/dist/mcp/builtin/collections/findDistinctTool.js +77 -0
  82. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
  83. package/dist/mcp/builtin/collections/findTool.d.ts +2 -0
  84. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -0
  85. package/dist/mcp/builtin/collections/findTool.js +146 -0
  86. package/dist/mcp/builtin/collections/findTool.js.map +1 -0
  87. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
  88. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
  89. package/dist/mcp/builtin/collections/findVersionByIDTool.js +74 -0
  90. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
  91. package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
  92. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
  93. package/dist/mcp/builtin/collections/findVersionsTool.js +84 -0
  94. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
  95. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
  96. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
  97. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +103 -0
  98. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
  99. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
  100. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
  101. package/dist/mcp/builtin/collections/restoreVersionTool.js +69 -0
  102. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
  103. package/dist/mcp/builtin/collections/updateTool.d.ts +2 -0
  104. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -0
  105. package/dist/mcp/builtin/collections/updateTool.js +172 -0
  106. package/dist/mcp/builtin/collections/updateTool.js.map +1 -0
  107. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
  108. package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
  109. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
  110. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
  111. package/dist/mcp/builtin/formatEntityError.d.ts +16 -0
  112. package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
  113. package/dist/mcp/builtin/formatEntityError.js +55 -0
  114. package/dist/mcp/builtin/formatEntityError.js.map +1 -0
  115. package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
  116. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
  117. package/dist/mcp/builtin/getConfigInfoTool.js +69 -0
  118. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
  119. package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
  120. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
  121. package/dist/mcp/builtin/globals/countVersionsTool.js +60 -0
  122. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
  123. package/dist/mcp/builtin/globals/findTool.d.ts +2 -0
  124. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -0
  125. package/dist/mcp/builtin/globals/findTool.js +67 -0
  126. package/dist/mcp/builtin/globals/findTool.js.map +1 -0
  127. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
  128. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
  129. package/dist/mcp/builtin/globals/findVersionByIDTool.js +68 -0
  130. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
  131. package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
  132. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
  133. package/dist/mcp/builtin/globals/findVersionsTool.js +78 -0
  134. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
  135. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
  136. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
  137. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +81 -0
  138. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
  139. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
  140. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
  141. package/dist/mcp/builtin/globals/restoreVersionTool.js +70 -0
  142. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
  143. package/dist/mcp/builtin/globals/updateTool.d.ts +2 -0
  144. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -0
  145. package/dist/mcp/builtin/globals/updateTool.js +78 -0
  146. package/dist/mcp/builtin/globals/updateTool.js.map +1 -0
  147. package/dist/mcp/builtinTools.d.ts +168 -0
  148. package/dist/mcp/builtinTools.d.ts.map +1 -0
  149. package/dist/mcp/builtinTools.js +169 -0
  150. package/dist/mcp/builtinTools.js.map +1 -0
  151. package/dist/mcp/sanitizeMCPConfig.d.ts +16 -0
  152. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -0
  153. package/dist/mcp/sanitizeMCPConfig.js +236 -0
  154. package/dist/mcp/sanitizeMCPConfig.js.map +1 -0
  155. package/dist/stdio.d.ts +8 -0
  156. package/dist/stdio.d.ts.map +1 -0
  157. package/dist/stdio.js +128 -0
  158. package/dist/stdio.js.map +1 -0
  159. package/dist/types.d.ts +352 -441
  160. package/dist/types.d.ts.map +1 -1
  161. package/dist/types.js +4 -1
  162. package/dist/types.js.map +1 -1
  163. package/dist/utils/getLogger.d.ts +10 -0
  164. package/dist/utils/getLogger.d.ts.map +1 -0
  165. package/dist/utils/getLogger.js +22 -0
  166. package/dist/utils/getLogger.js.map +1 -0
  167. package/dist/utils/getPluginConfig.d.ts +12 -0
  168. package/dist/utils/getPluginConfig.d.ts.map +1 -0
  169. package/dist/utils/getPluginConfig.js +15 -0
  170. package/dist/utils/getPluginConfig.js.map +1 -0
  171. package/dist/utils/resolveProjectRoot.d.ts +7 -0
  172. package/dist/utils/resolveProjectRoot.d.ts.map +1 -0
  173. package/dist/utils/resolveProjectRoot.js +15 -0
  174. package/dist/utils/resolveProjectRoot.js.map +1 -0
  175. package/dist/utils/seal.d.ts +17 -0
  176. package/dist/utils/seal.d.ts.map +1 -0
  177. package/dist/utils/seal.js +24 -0
  178. package/dist/utils/seal.js.map +1 -0
  179. package/dist/utils/toStandardSchema.d.ts +5 -0
  180. package/dist/utils/toStandardSchema.d.ts.map +1 -0
  181. package/dist/utils/toStandardSchema.js +4 -0
  182. package/dist/utils/toStandardSchema.js.map +1 -0
  183. package/dist/views/Authorize/AllowButtons/index.d.ts +18 -0
  184. package/dist/views/Authorize/AllowButtons/index.d.ts.map +1 -0
  185. package/dist/views/Authorize/AllowButtons/index.js +88 -0
  186. package/dist/views/Authorize/AllowButtons/index.js.map +1 -0
  187. package/dist/views/Authorize/index.css +19 -0
  188. package/dist/views/Authorize/index.d.ts +9 -0
  189. package/dist/views/Authorize/index.d.ts.map +1 -0
  190. package/dist/views/Authorize/index.js +86 -0
  191. package/dist/views/Authorize/index.js.map +1 -0
  192. package/package.json +48 -26
  193. package/src/defaultAccess.ts +3 -0
  194. package/src/defineTool.ts +44 -0
  195. package/src/endpoint/access.ts +153 -0
  196. package/src/endpoint/index.ts +123 -0
  197. package/src/endpoint/oauth.ts +108 -0
  198. package/src/endpoint/oauthLoginToken.ts +94 -0
  199. package/src/endpoint/oauthServer.ts +452 -0
  200. package/src/exports/client.ts +3 -0
  201. package/src/exports/internal.ts +1 -0
  202. package/src/exports/rsc.ts +1 -0
  203. package/src/index.ts +74 -88
  204. package/src/mcp/buildMcpServer.ts +294 -0
  205. package/src/mcp/builtin/collections/authTools.ts +280 -0
  206. package/src/mcp/builtin/collections/countTool.ts +61 -0
  207. package/src/mcp/builtin/collections/countVersionsTool.ts +60 -0
  208. package/src/mcp/builtin/collections/createTool.ts +143 -0
  209. package/src/mcp/builtin/collections/deleteTool.ts +99 -0
  210. package/src/mcp/builtin/collections/duplicateTool.ts +84 -0
  211. package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
  212. package/src/mcp/builtin/collections/fileInput.ts +127 -0
  213. package/src/mcp/builtin/collections/findDistinctTool.ts +67 -0
  214. package/src/mcp/builtin/collections/findTool.ts +134 -0
  215. package/src/mcp/builtin/collections/findVersionByIDTool.ts +66 -0
  216. package/src/mcp/builtin/collections/findVersionsTool.ts +83 -0
  217. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +91 -0
  218. package/src/mcp/builtin/collections/restoreVersionTool.ts +65 -0
  219. package/src/mcp/builtin/collections/updateTool.ts +173 -0
  220. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
  221. package/src/mcp/builtin/formatEntityError.ts +77 -0
  222. package/src/mcp/builtin/getConfigInfoTool.ts +68 -0
  223. package/src/mcp/builtin/globals/countVersionsTool.ts +60 -0
  224. package/src/mcp/builtin/globals/findTool.ts +66 -0
  225. package/src/mcp/builtin/globals/findVersionByIDTool.ts +64 -0
  226. package/src/mcp/builtin/globals/findVersionsTool.ts +69 -0
  227. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +73 -0
  228. package/src/mcp/builtin/globals/restoreVersionTool.ts +68 -0
  229. package/src/mcp/builtin/globals/updateTool.ts +92 -0
  230. package/src/mcp/builtinTools.ts +161 -0
  231. package/src/mcp/sanitizeMCPConfig.ts +282 -0
  232. package/src/stdio.ts +131 -0
  233. package/src/types.ts +401 -481
  234. package/src/utils/getLogger.ts +22 -0
  235. package/src/utils/getPluginConfig.ts +24 -0
  236. package/src/utils/resolveProjectRoot.ts +17 -0
  237. package/src/utils/seal.ts +46 -0
  238. package/src/utils/toStandardSchema.ts +9 -0
  239. package/src/views/Authorize/AllowButtons/index.tsx +97 -0
  240. package/src/views/Authorize/index.css +19 -0
  241. package/src/views/Authorize/index.tsx +93 -0
  242. package/dist/collections/createApiKeysCollection.d.ts +0 -7
  243. package/dist/collections/createApiKeysCollection.d.ts.map +0 -1
  244. package/dist/collections/createApiKeysCollection.js +0 -317
  245. package/dist/collections/createApiKeysCollection.js.map +0 -1
  246. package/dist/defaults.d.ts +0 -4
  247. package/dist/defaults.d.ts.map +0 -1
  248. package/dist/defaults.js +0 -5
  249. package/dist/defaults.js.map +0 -1
  250. package/dist/endpoints/mcp.d.ts +0 -4
  251. package/dist/endpoints/mcp.d.ts.map +0 -1
  252. package/dist/endpoints/mcp.js +0 -71
  253. package/dist/endpoints/mcp.js.map +0 -1
  254. package/dist/mcp/createRequest.d.ts +0 -3
  255. package/dist/mcp/createRequest.d.ts.map +0 -1
  256. package/dist/mcp/createRequest.js +0 -14
  257. package/dist/mcp/createRequest.js.map +0 -1
  258. package/dist/mcp/getMcpHandler.d.ts +0 -4
  259. package/dist/mcp/getMcpHandler.d.ts.map +0 -1
  260. package/dist/mcp/getMcpHandler.js +0 -231
  261. package/dist/mcp/getMcpHandler.js.map +0 -1
  262. package/dist/mcp/helpers/config.d.ts +0 -22
  263. package/dist/mcp/helpers/config.d.ts.map +0 -1
  264. package/dist/mcp/helpers/config.js +0 -153
  265. package/dist/mcp/helpers/config.js.map +0 -1
  266. package/dist/mcp/helpers/fields.d.ts +0 -19
  267. package/dist/mcp/helpers/fields.d.ts.map +0 -1
  268. package/dist/mcp/helpers/fields.js +0 -102
  269. package/dist/mcp/helpers/fields.js.map +0 -1
  270. package/dist/mcp/helpers/fileValidation.d.ts +0 -67
  271. package/dist/mcp/helpers/fileValidation.d.ts.map +0 -1
  272. package/dist/mcp/helpers/fileValidation.js +0 -267
  273. package/dist/mcp/helpers/fileValidation.js.map +0 -1
  274. package/dist/mcp/registerTool.d.ts +0 -6
  275. package/dist/mcp/registerTool.d.ts.map +0 -1
  276. package/dist/mcp/registerTool.js +0 -18
  277. package/dist/mcp/registerTool.js.map +0 -1
  278. package/dist/mcp/tools/auth/auth.d.ts +0 -4
  279. package/dist/mcp/tools/auth/auth.d.ts.map +0 -1
  280. package/dist/mcp/tools/auth/auth.js +0 -57
  281. package/dist/mcp/tools/auth/auth.js.map +0 -1
  282. package/dist/mcp/tools/auth/forgotPassword.d.ts +0 -4
  283. package/dist/mcp/tools/auth/forgotPassword.d.ts.map +0 -1
  284. package/dist/mcp/tools/auth/forgotPassword.js +0 -48
  285. package/dist/mcp/tools/auth/forgotPassword.js.map +0 -1
  286. package/dist/mcp/tools/auth/login.d.ts +0 -4
  287. package/dist/mcp/tools/auth/login.d.ts.map +0 -1
  288. package/dist/mcp/tools/auth/login.js +0 -51
  289. package/dist/mcp/tools/auth/login.js.map +0 -1
  290. package/dist/mcp/tools/auth/resetPassword.d.ts +0 -4
  291. package/dist/mcp/tools/auth/resetPassword.d.ts.map +0 -1
  292. package/dist/mcp/tools/auth/resetPassword.js +0 -49
  293. package/dist/mcp/tools/auth/resetPassword.js.map +0 -1
  294. package/dist/mcp/tools/auth/unlock.d.ts +0 -4
  295. package/dist/mcp/tools/auth/unlock.d.ts.map +0 -1
  296. package/dist/mcp/tools/auth/unlock.js +0 -48
  297. package/dist/mcp/tools/auth/unlock.js.map +0 -1
  298. package/dist/mcp/tools/auth/verify.d.ts +0 -4
  299. package/dist/mcp/tools/auth/verify.d.ts.map +0 -1
  300. package/dist/mcp/tools/auth/verify.js +0 -45
  301. package/dist/mcp/tools/auth/verify.js.map +0 -1
  302. package/dist/mcp/tools/collection/create.d.ts +0 -10
  303. package/dist/mcp/tools/collection/create.d.ts.map +0 -1
  304. package/dist/mcp/tools/collection/create.js +0 -139
  305. package/dist/mcp/tools/collection/create.js.map +0 -1
  306. package/dist/mcp/tools/collection/delete.d.ts +0 -10
  307. package/dist/mcp/tools/collection/delete.d.ts.map +0 -1
  308. package/dist/mcp/tools/collection/delete.js +0 -154
  309. package/dist/mcp/tools/collection/delete.js.map +0 -1
  310. package/dist/mcp/tools/collection/find.d.ts +0 -10
  311. package/dist/mcp/tools/collection/find.d.ts.map +0 -1
  312. package/dist/mcp/tools/collection/find.js +0 -165
  313. package/dist/mcp/tools/collection/find.js.map +0 -1
  314. package/dist/mcp/tools/collection/update.d.ts +0 -10
  315. package/dist/mcp/tools/collection/update.d.ts.map +0 -1
  316. package/dist/mcp/tools/collection/update.js +0 -209
  317. package/dist/mcp/tools/collection/update.js.map +0 -1
  318. package/dist/mcp/tools/config/find.d.ts +0 -10
  319. package/dist/mcp/tools/config/find.d.ts.map +0 -1
  320. package/dist/mcp/tools/config/find.js +0 -97
  321. package/dist/mcp/tools/config/find.js.map +0 -1
  322. package/dist/mcp/tools/config/update.d.ts +0 -10
  323. package/dist/mcp/tools/config/update.d.ts.map +0 -1
  324. package/dist/mcp/tools/config/update.js +0 -215
  325. package/dist/mcp/tools/config/update.js.map +0 -1
  326. package/dist/mcp/tools/global/find.d.ts +0 -5
  327. package/dist/mcp/tools/global/find.d.ts.map +0 -1
  328. package/dist/mcp/tools/global/find.js +0 -82
  329. package/dist/mcp/tools/global/find.js.map +0 -1
  330. package/dist/mcp/tools/global/update.d.ts +0 -6
  331. package/dist/mcp/tools/global/update.d.ts.map +0 -1
  332. package/dist/mcp/tools/global/update.js +0 -124
  333. package/dist/mcp/tools/global/update.js.map +0 -1
  334. package/dist/mcp/tools/job/create.d.ts +0 -10
  335. package/dist/mcp/tools/job/create.d.ts.map +0 -1
  336. package/dist/mcp/tools/job/create.js +0 -293
  337. package/dist/mcp/tools/job/create.js.map +0 -1
  338. package/dist/mcp/tools/job/run.d.ts +0 -10
  339. package/dist/mcp/tools/job/run.d.ts.map +0 -1
  340. package/dist/mcp/tools/job/run.js +0 -129
  341. package/dist/mcp/tools/job/run.js.map +0 -1
  342. package/dist/mcp/tools/job/update.d.ts +0 -11
  343. package/dist/mcp/tools/job/update.d.ts.map +0 -1
  344. package/dist/mcp/tools/job/update.js +0 -186
  345. package/dist/mcp/tools/job/update.js.map +0 -1
  346. package/dist/mcp/tools/resource/create.d.ts +0 -6
  347. package/dist/mcp/tools/resource/create.d.ts.map +0 -1
  348. package/dist/mcp/tools/resource/create.js +0 -124
  349. package/dist/mcp/tools/resource/create.js.map +0 -1
  350. package/dist/mcp/tools/resource/delete.d.ts +0 -5
  351. package/dist/mcp/tools/resource/delete.d.ts.map +0 -1
  352. package/dist/mcp/tools/resource/delete.js +0 -151
  353. package/dist/mcp/tools/resource/delete.js.map +0 -1
  354. package/dist/mcp/tools/resource/find.d.ts +0 -5
  355. package/dist/mcp/tools/resource/find.d.ts.map +0 -1
  356. package/dist/mcp/tools/resource/find.js +0 -170
  357. package/dist/mcp/tools/resource/find.js.map +0 -1
  358. package/dist/mcp/tools/resource/update.d.ts +0 -6
  359. package/dist/mcp/tools/resource/update.d.ts.map +0 -1
  360. package/dist/mcp/tools/resource/update.js +0 -256
  361. package/dist/mcp/tools/resource/update.js.map +0 -1
  362. package/dist/mcp/tools/schemas.d.ts +0 -457
  363. package/dist/mcp/tools/schemas.d.ts.map +0 -1
  364. package/dist/mcp/tools/schemas.js +0 -243
  365. package/dist/mcp/tools/schemas.js.map +0 -1
  366. package/dist/utils/adminEntitySettings.d.ts +0 -17
  367. package/dist/utils/adminEntitySettings.d.ts.map +0 -1
  368. package/dist/utils/adminEntitySettings.js +0 -41
  369. package/dist/utils/adminEntitySettings.js.map +0 -1
  370. package/dist/utils/createApiKeyFields.d.ts +0 -15
  371. package/dist/utils/createApiKeyFields.d.ts.map +0 -1
  372. package/dist/utils/createApiKeyFields.js +0 -57
  373. package/dist/utils/createApiKeyFields.js.map +0 -1
  374. package/dist/utils/getEnabledSlugs.d.ts +0 -13
  375. package/dist/utils/getEnabledSlugs.d.ts.map +0 -1
  376. package/dist/utils/getEnabledSlugs.js +0 -32
  377. package/dist/utils/getEnabledSlugs.js.map +0 -1
  378. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  379. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  380. package/dist/utils/getVirtualFieldNames.js +0 -35
  381. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  382. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts +0 -3
  383. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts.map +0 -1
  384. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js +0 -43
  385. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js.map +0 -1
  386. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
  387. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
  388. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
  389. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
  390. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +0 -13
  391. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +0 -1
  392. package/dist/utils/schemaConversion/sanitizeJsonSchema.js +0 -56
  393. package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +0 -1
  394. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +0 -20
  395. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +0 -1
  396. package/dist/utils/schemaConversion/simplifyRelationshipFields.js +0 -53
  397. package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +0 -1
  398. package/dist/utils/schemaConversion/transformPointFields.d.ts +0 -3
  399. package/dist/utils/schemaConversion/transformPointFields.d.ts.map +0 -1
  400. package/dist/utils/schemaConversion/transformPointFields.js +0 -51
  401. package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
  402. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  403. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  404. package/dist/utils/transformPointDataToPayload.js +0 -28
  405. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  406. package/src/collections/createApiKeysCollection.ts +0 -373
  407. package/src/defaults.ts +0 -3
  408. package/src/endpoints/mcp.ts +0 -91
  409. package/src/mcp/createRequest.ts +0 -13
  410. package/src/mcp/getMcpHandler.ts +0 -545
  411. package/src/mcp/helpers/config.ts +0 -213
  412. package/src/mcp/helpers/fields.ts +0 -154
  413. package/src/mcp/helpers/fileValidation.ts +0 -362
  414. package/src/mcp/registerTool.ts +0 -22
  415. package/src/mcp/tools/auth/auth.ts +0 -71
  416. package/src/mcp/tools/auth/forgotPassword.ts +0 -70
  417. package/src/mcp/tools/auth/login.ts +0 -72
  418. package/src/mcp/tools/auth/resetPassword.ts +0 -61
  419. package/src/mcp/tools/auth/unlock.ts +0 -64
  420. package/src/mcp/tools/auth/verify.ts +0 -57
  421. package/src/mcp/tools/collection/create.ts +0 -210
  422. package/src/mcp/tools/collection/delete.ts +0 -211
  423. package/src/mcp/tools/collection/find.ts +0 -224
  424. package/src/mcp/tools/collection/update.ts +0 -290
  425. package/src/mcp/tools/config/find.ts +0 -128
  426. package/src/mcp/tools/config/update.ts +0 -280
  427. package/src/mcp/tools/global/find.ts +0 -128
  428. package/src/mcp/tools/global/update.ts +0 -207
  429. package/src/mcp/tools/job/create.ts +0 -416
  430. package/src/mcp/tools/job/run.ts +0 -167
  431. package/src/mcp/tools/job/update.ts +0 -274
  432. package/src/mcp/tools/resource/create.ts +0 -211
  433. package/src/mcp/tools/resource/delete.ts +0 -218
  434. package/src/mcp/tools/resource/find.ts +0 -246
  435. package/src/mcp/tools/resource/update.ts +0 -383
  436. package/src/mcp/tools/schemas.ts +0 -520
  437. package/src/utils/adminEntitySettings.ts +0 -40
  438. package/src/utils/createApiKeyFields.ts +0 -72
  439. package/src/utils/getEnabledSlugs.ts +0 -42
  440. package/src/utils/getVirtualFieldNames.ts +0 -53
  441. package/src/utils/schemaConversion/convertCollectionSchemaToZod.ts +0 -52
  442. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
  443. package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
  444. package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -65
  445. package/src/utils/schemaConversion/transformPointFields.ts +0 -55
  446. package/src/utils/transformPointDataToPayload.ts +0 -40
@@ -0,0 +1,86 @@
1
+ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
2
+ import { FormHeader, Logo, MinimalTemplate } from '@payloadcms/ui/rsc';
3
+ import { formatAdminURL } from 'payload/shared';
4
+ import React from 'react';
5
+ // eslint-disable-next-line payload/no-imports-from-exports-dir -- Server component must reference exports dir for proper client boundary
6
+ import { AllowButtons } from '../../exports/client.js';
7
+ import { unseal } from '../../utils/seal.js';
8
+ import './index.css';
9
+ const baseClass = 'mcp-authorize';
10
+ const errorTitles = {
11
+ expired: 'This sign-in request expired',
12
+ 'invalid-link': 'This sign-in link is invalid'
13
+ };
14
+ /**
15
+ * The admin page where users allow an MCP client to use their account, for the built-in OAuth
16
+ * server. Its authorize endpoint sends users here with the consent to show, or with an error.
17
+ */ export function MCPAuthorizeView({ initPageResult, params, searchParams, server, user }) {
18
+ const { locale, permissions, req } = initPageResult;
19
+ const { i18n, payload } = req;
20
+ const sealedConsent = getSearchParam(searchParams?.consent);
21
+ const consent = unseal({
22
+ type: 'consent',
23
+ req,
24
+ value: sealedConsent
25
+ });
26
+ const client = consent && unseal({
27
+ type: 'client',
28
+ req,
29
+ value: consent.clientID
30
+ });
31
+ // The consent is only valid for the user it was made for
32
+ const isConsentValid = client && consent && req.user?.id === consent.userID && req.user.collection === consent.collection;
33
+ const error = getSearchParam(searchParams?.error) === 'invalid-link' ? 'invalid-link' : 'expired';
34
+ const account = String(user?.email ?? consent?.userID);
35
+ const returnHost = consent && (new URL(consent.redirectURI).host || consent.redirectURI);
36
+ return /*#__PURE__*/ _jsxs(MinimalTemplate, {
37
+ className: baseClass,
38
+ children: [
39
+ /*#__PURE__*/ _jsx("div", {
40
+ className: `${baseClass}__brand`,
41
+ children: /*#__PURE__*/ _jsx(Logo, {
42
+ i18n: i18n,
43
+ locale: locale,
44
+ params: params,
45
+ payload: payload,
46
+ permissions: permissions,
47
+ searchParams: searchParams,
48
+ server: server,
49
+ user: user
50
+ })
51
+ }),
52
+ /*#__PURE__*/ _jsx("div", {
53
+ lang: "en",
54
+ children: isConsentValid ? /*#__PURE__*/ _jsxs(_Fragment, {
55
+ children: [
56
+ /*#__PURE__*/ _jsx(FormHeader, {
57
+ description: `It will be able to use this app's MCP tools as ${account}, and you will return to ${returnHost}.`,
58
+ heading: `Allow ${client.name} to use your account?`
59
+ }),
60
+ /*#__PURE__*/ _jsxs("form", {
61
+ action: formatAdminURL({
62
+ apiRoute: payload.config.routes.api,
63
+ path: '/mcp/oauth/authorize'
64
+ }),
65
+ method: "post",
66
+ children: [
67
+ /*#__PURE__*/ _jsx("input", {
68
+ name: "consent",
69
+ type: "hidden",
70
+ value: sealedConsent
71
+ }),
72
+ /*#__PURE__*/ _jsx(AllowButtons, {})
73
+ ]
74
+ })
75
+ ]
76
+ }) : /*#__PURE__*/ _jsx(FormHeader, {
77
+ description: "Start the sign-in again from your MCP client.",
78
+ heading: errorTitles[error]
79
+ })
80
+ })
81
+ ]
82
+ });
83
+ }
84
+ const getSearchParam = (value)=>typeof value === 'string' ? value : null;
85
+
86
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/views/Authorize/index.tsx"],"sourcesContent":["import type { AdminViewServerProps } from 'payload'\n\nimport { FormHeader, Logo, MinimalTemplate } from '@payloadcms/ui/rsc'\nimport { formatAdminURL } from 'payload/shared'\nimport React from 'react'\n\nimport type { AuthorizeViewError, Client, Consent } from '../../endpoint/oauthServer.js'\n\n// eslint-disable-next-line payload/no-imports-from-exports-dir -- Server component must reference exports dir for proper client boundary\nimport { AllowButtons } from '../../exports/client.js'\nimport { unseal } from '../../utils/seal.js'\nimport './index.css'\n\nconst baseClass = 'mcp-authorize'\n\nconst errorTitles: Record<AuthorizeViewError, string> = {\n expired: 'This sign-in request expired',\n 'invalid-link': 'This sign-in link is invalid',\n}\n\n/**\n * The admin page where users allow an MCP client to use their account, for the built-in OAuth\n * server. Its authorize endpoint sends users here with the consent to show, or with an error.\n */\nexport function MCPAuthorizeView({\n initPageResult,\n params,\n searchParams,\n server,\n user,\n}: AdminViewServerProps) {\n const { locale, permissions, req } = initPageResult\n const { i18n, payload } = req\n const sealedConsent = getSearchParam(searchParams?.consent)\n const consent = unseal<Consent>({ type: 'consent', req, value: sealedConsent })\n const client = consent && unseal<Client>({ type: 'client', req, value: consent.clientID })\n // The consent is only valid for the user it was made for\n const isConsentValid =\n client &&\n consent &&\n req.user?.id === consent.userID &&\n req.user.collection === consent.collection\n const error: AuthorizeViewError =\n getSearchParam(searchParams?.error) === 'invalid-link' ? 'invalid-link' : 'expired'\n const account = String(user?.email ?? consent?.userID)\n const returnHost = consent && (new URL(consent.redirectURI).host || consent.redirectURI)\n\n return (\n <MinimalTemplate className={baseClass}>\n <div className={`${baseClass}__brand`}>\n <Logo\n i18n={i18n}\n locale={locale}\n params={params}\n payload={payload}\n permissions={permissions}\n searchParams={searchParams}\n server={server}\n user={user}\n />\n </div>\n {/* Not translated yet, so screen readers in other admin languages read it as English */}\n <div lang=\"en\">\n {isConsentValid ? (\n <>\n <FormHeader\n description={`It will be able to use this app's MCP tools as ${account}, and you will return to ${returnHost}.`}\n heading={`Allow ${client.name} to use your account?`}\n />\n <form\n action={formatAdminURL({\n apiRoute: payload.config.routes.api,\n path: '/mcp/oauth/authorize',\n })}\n method=\"post\"\n >\n <input name=\"consent\" type=\"hidden\" value={sealedConsent!} />\n <AllowButtons />\n </form>\n </>\n ) : (\n <FormHeader\n description=\"Start the sign-in again from your MCP client.\"\n heading={errorTitles[error]}\n />\n )}\n </div>\n </MinimalTemplate>\n )\n}\n\nconst getSearchParam = (value: string | string[] | undefined): null | string =>\n typeof value === 'string' ? value : null\n"],"names":["FormHeader","Logo","MinimalTemplate","formatAdminURL","React","AllowButtons","unseal","baseClass","errorTitles","expired","MCPAuthorizeView","initPageResult","params","searchParams","server","user","locale","permissions","req","i18n","payload","sealedConsent","getSearchParam","consent","type","value","client","clientID","isConsentValid","id","userID","collection","error","account","String","email","returnHost","URL","redirectURI","host","className","div","lang","description","heading","name","form","action","apiRoute","config","routes","api","path","method","input"],"mappings":";AAEA,SAASA,UAAU,EAAEC,IAAI,EAAEC,eAAe,QAAQ,qBAAoB;AACtE,SAASC,cAAc,QAAQ,iBAAgB;AAC/C,OAAOC,WAAW,QAAO;AAIzB,yIAAyI;AACzI,SAASC,YAAY,QAAQ,0BAAyB;AACtD,SAASC,MAAM,QAAQ,sBAAqB;AAC5C,OAAO,cAAa;AAEpB,MAAMC,YAAY;AAElB,MAAMC,cAAkD;IACtDC,SAAS;IACT,gBAAgB;AAClB;AAEA;;;CAGC,GACD,OAAO,SAASC,iBAAiB,EAC/BC,cAAc,EACdC,MAAM,EACNC,YAAY,EACZC,MAAM,EACNC,IAAI,EACiB;IACrB,MAAM,EAAEC,MAAM,EAAEC,WAAW,EAAEC,GAAG,EAAE,GAAGP;IACrC,MAAM,EAAEQ,IAAI,EAAEC,OAAO,EAAE,GAAGF;IAC1B,MAAMG,gBAAgBC,eAAeT,cAAcU;IACnD,MAAMA,UAAUjB,OAAgB;QAAEkB,MAAM;QAAWN;QAAKO,OAAOJ;IAAc;IAC7E,MAAMK,SAASH,WAAWjB,OAAe;QAAEkB,MAAM;QAAUN;QAAKO,OAAOF,QAAQI,QAAQ;IAAC;IACxF,yDAAyD;IACzD,MAAMC,iBACJF,UACAH,WACAL,IAAIH,IAAI,EAAEc,OAAON,QAAQO,MAAM,IAC/BZ,IAAIH,IAAI,CAACgB,UAAU,KAAKR,QAAQQ,UAAU;IAC5C,MAAMC,QACJV,eAAeT,cAAcmB,WAAW,iBAAiB,iBAAiB;IAC5E,MAAMC,UAAUC,OAAOnB,MAAMoB,SAASZ,SAASO;IAC/C,MAAMM,aAAab,WAAY,CAAA,IAAIc,IAAId,QAAQe,WAAW,EAAEC,IAAI,IAAIhB,QAAQe,WAAW,AAAD;IAEtF,qBACE,MAACpC;QAAgBsC,WAAWjC;;0BAC1B,KAACkC;gBAAID,WAAW,GAAGjC,UAAU,OAAO,CAAC;0BACnC,cAAA,KAACN;oBACCkB,MAAMA;oBACNH,QAAQA;oBACRJ,QAAQA;oBACRQ,SAASA;oBACTH,aAAaA;oBACbJ,cAAcA;oBACdC,QAAQA;oBACRC,MAAMA;;;0BAIV,KAAC0B;gBAAIC,MAAK;0BACPd,+BACC;;sCACE,KAAC5B;4BACC2C,aAAa,CAAC,+CAA+C,EAAEV,QAAQ,yBAAyB,EAAEG,WAAW,CAAC,CAAC;4BAC/GQ,SAAS,CAAC,MAAM,EAAElB,OAAOmB,IAAI,CAAC,qBAAqB,CAAC;;sCAEtD,MAACC;4BACCC,QAAQ5C,eAAe;gCACrB6C,UAAU5B,QAAQ6B,MAAM,CAACC,MAAM,CAACC,GAAG;gCACnCC,MAAM;4BACR;4BACAC,QAAO;;8CAEP,KAACC;oCAAMT,MAAK;oCAAUrB,MAAK;oCAASC,OAAOJ;;8CAC3C,KAAChB;;;;mCAIL,KAACL;oBACC2C,aAAY;oBACZC,SAASpC,WAAW,CAACwB,MAAM;;;;;AAMvC;AAEA,MAAMV,iBAAiB,CAACG,QACtB,OAAOA,UAAU,WAAWA,QAAQ"}
package/package.json CHANGED
@@ -1,17 +1,12 @@
1
1
  {
2
2
  "name": "@payloadcms/plugin-mcp",
3
- "version": "4.0.0-internal.5b1e7cd",
3
+ "version": "4.0.0-internal.5d2e3d1",
4
4
  "description": "MCP (Model Context Protocol) capabilities with Payload",
5
5
  "keywords": [
6
- "plugin",
7
6
  "mcp",
8
- "model context protocol"
7
+ "model context protocol",
8
+ "plugin"
9
9
  ],
10
- "repository": {
11
- "type": "git",
12
- "url": "https://github.com/payloadcms/payload.git",
13
- "directory": "packages/plugin-mcp"
14
- },
15
10
  "license": "MIT",
16
11
  "author": "Payload <dev@payloadcms.com> (https://payloadcms.com)",
17
12
  "maintainers": [
@@ -21,34 +16,63 @@
21
16
  "url": "https://payloadcms.com"
22
17
  }
23
18
  ],
24
- "sideEffects": false,
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "https://github.com/payloadcms/payload.git",
22
+ "directory": "packages/plugin-mcp"
23
+ },
24
+ "bin": {
25
+ "payload-mcp": "./bin.js"
26
+ },
27
+ "files": [
28
+ "src",
29
+ "dist",
30
+ "bin.js"
31
+ ],
25
32
  "type": "module",
33
+ "main": "./dist/index.js",
34
+ "types": "./dist/index.d.ts",
26
35
  "exports": {
27
36
  ".": {
28
37
  "import": "./dist/index.js",
29
38
  "types": "./dist/index.d.ts",
30
39
  "default": "./dist/index.js"
40
+ },
41
+ "./client": {
42
+ "import": "./dist/exports/client.js",
43
+ "types": "./dist/exports/client.d.ts",
44
+ "default": "./dist/exports/client.js"
45
+ },
46
+ "./stdio": {
47
+ "import": "./dist/stdio.js",
48
+ "types": "./dist/stdio.d.ts",
49
+ "default": "./dist/stdio.js"
50
+ },
51
+ "./internal": {
52
+ "import": "./dist/exports/internal.js",
53
+ "types": "./dist/exports/internal.d.ts",
54
+ "default": "./dist/exports/internal.js"
55
+ },
56
+ "./rsc": {
57
+ "import": "./dist/exports/rsc.js",
58
+ "types": "./dist/exports/rsc.d.ts",
59
+ "default": "./dist/exports/rsc.js"
31
60
  }
32
61
  },
33
- "main": "./dist/index.js",
34
- "types": "./dist/index.d.ts",
35
- "files": [
36
- "src",
37
- "dist"
38
- ],
39
62
  "dependencies": {
40
- "@modelcontextprotocol/sdk": "1.27.1",
41
- "@types/json-schema": "7.0.15",
42
- "json-schema-to-zod": "2.6.1",
43
- "mcp-handler": "^1.0.7",
44
- "zod": "^3.25.50"
63
+ "@modelcontextprotocol/server": "2.4.0",
64
+ "tsx": "4.23.15"
45
65
  },
46
66
  "devDependencies": {
47
- "@payloadcms/eslint-config": "3.28.0",
48
- "payload": "4.0.0-internal.5b1e7cd"
67
+ "@payloadcms/ui": "4.0.0-internal.5d2e3d1",
68
+ "payload": "4.0.0-internal.5d2e3d1"
49
69
  },
50
70
  "peerDependencies": {
51
- "payload": "4.0.0-internal.5b1e7cd"
71
+ "@payloadcms/ui": "4.0.0-internal.5d2e3d1",
72
+ "payload": "4.0.0-internal.5d2e3d1"
73
+ },
74
+ "//deps_notes": {
75
+ "tsx": "Required by the `bin.js` stdio mcp. Keep the version pinned to whatever `payload` ships to avoid duplicate installs."
52
76
  },
53
77
  "homepage:": "https://payloadcms.com",
54
78
  "scripts": {
@@ -57,9 +81,7 @@
57
81
  "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
58
82
  "build:types": "tsc --emitDeclarationOnly --outDir dist",
59
83
  "clean": "rimraf {dist,*.tsbuildinfo}",
60
- "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
61
- "lint": "eslint .",
62
- "lint:fix": "eslint . --fix",
84
+ "copyfiles": "copyfiles -u 1 -e \"**/*.spec.*\" \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
63
85
  "pack:plugin": "pnpm build && pnpm pack"
64
86
  }
65
87
  }
@@ -0,0 +1,3 @@
1
+ import type { MCPAccessArgs } from './types.js'
2
+
3
+ export const defaultAccess = ({ req }: MCPAccessArgs): boolean => Boolean(req.user)
@@ -0,0 +1,44 @@
1
+ import type { CollectionTool, GlobalTool, Prompt, Tool, ToolInputSchema } from './types.js'
2
+
3
+ /**
4
+ * Two-stage builder: pass the schema/metadata first, then chain `.handler(fn)`. Splitting the
5
+ * call lets TypeScript resolve `TSchema` from `input` (call 1) before contextually typing the
6
+ * handler (call 2). A single-call API hit a TS limitation where property order in the literal
7
+ * decided whether `TSchema` was inferred or pinned to its default.
8
+ *
9
+ * defineCollectionTool({ description, input })
10
+ * .handler(({ input }) => …) // ← input is fully typed here regardless of order
11
+ *
12
+ * Config and handler signatures are derived from `Tool` / `CollectionTool` / `GlobalTool` /
13
+ * `Prompt` via `Omit` + indexed access so there's no duplication with `types.ts`.
14
+ */
15
+
16
+ export const defineTool = <
17
+ TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
18
+ >(
19
+ args: Omit<Tool<TSchema>, 'handler'>,
20
+ ): { handler: (fn: Tool<TSchema>['handler']) => Tool } => ({
21
+ handler: (fn) => ({ ...args, handler: fn }) as unknown as Tool,
22
+ })
23
+
24
+ export const defineCollectionTool = <
25
+ TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
26
+ >(
27
+ args: Omit<CollectionTool<TSchema>, 'handler'>,
28
+ ): { handler: (fn: CollectionTool<TSchema>['handler']) => CollectionTool } => ({
29
+ handler: (fn) => ({ ...args, handler: fn }) as unknown as CollectionTool,
30
+ })
31
+
32
+ export const defineGlobalTool = <
33
+ TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
34
+ >(
35
+ args: Omit<GlobalTool<TSchema>, 'handler'>,
36
+ ): { handler: (fn: GlobalTool<TSchema>['handler']) => GlobalTool } => ({
37
+ handler: (fn) => ({ ...args, handler: fn }) as unknown as GlobalTool,
38
+ })
39
+
40
+ export const definePrompt = <TSchema extends ToolInputSchema = ToolInputSchema>(
41
+ args: Omit<Prompt<TSchema>, 'handler'>,
42
+ ): { handler: (fn: Prompt<TSchema>['handler']) => Prompt } => ({
43
+ handler: (fn) => ({ ...args, handler: fn }) as unknown as Prompt,
44
+ })
@@ -0,0 +1,153 @@
1
+ import type { PayloadRequest, SanitizedPermissions } from 'payload'
2
+
3
+ import { executeAuthStrategies, getAccessResults, UnauthorizedError } from 'payload'
4
+ import { extractBearerToken } from 'payload/shared'
5
+
6
+ import type { AuthorizedMCP, MCPItem } from '../types.js'
7
+
8
+ import { getPluginConfig } from '../utils/getPluginConfig.js'
9
+ import { authenticateLoginToken } from './oauthLoginToken.js'
10
+
11
+ export type GetAuthorizedMCPArgs = {
12
+ /**
13
+ * Whether the request came through the HTTP endpoint, whose response can carry the OAuth
14
+ * challenge and headers from auth strategies. stdio has no response to carry them.
15
+ */
16
+ isHTTP?: boolean
17
+ overrideAccess: boolean
18
+ req: PayloadRequest
19
+ }
20
+
21
+ /**
22
+ * Authenticates an MCP request and removes items the user cannot access.
23
+ * `overrideAccess` skips Payload and MCP item access checks.
24
+ */
25
+ export const getAuthorizedMCP: (args: GetAuthorizedMCPArgs) => Promise<AuthorizedMCP> = async ({
26
+ isHTTP = false,
27
+ overrideAccess,
28
+ req,
29
+ }) => {
30
+ const pluginConfig = getPluginConfig({ config: req.payload.config })
31
+ const isChallengedWhenSignedOut = isHTTP && Boolean(pluginConfig.oauth)
32
+
33
+ if (pluginConfig.overrideGetAuthorizedMCP) {
34
+ return await pluginConfig.overrideGetAuthorizedMCP({
35
+ overrideAccess,
36
+ pluginConfig,
37
+ req,
38
+ })
39
+ }
40
+
41
+ if (req.headers) {
42
+ const headers = new Headers(req.headers)
43
+ const hasAuthorization = headers.has('Authorization')
44
+
45
+ headers.set('DisableAutologin', 'true')
46
+ // Not `payload.auth()`, which also computes permissions that filterMCPItems computes anyway
47
+ const { responseHeaders, user } = await executeAuthStrategies({
48
+ canSetHeaders: isHTTP,
49
+ headers,
50
+ payload: req.payload,
51
+ req,
52
+ })
53
+ req.user = user
54
+ if (responseHeaders) {
55
+ req.responseHeaders = responseHeaders
56
+ }
57
+
58
+ // Only bearer tokens that no auth strategy accepted get here, e.g. an OAuth access token.
59
+ // API keys use the `<collection> API-Key <key>` scheme instead of `Bearer`, so they never do.
60
+ const bearerToken = extractBearerToken({ headers })
61
+ // Sealed Payload login tokens from the built-in OAuth server
62
+ if (
63
+ !req.user &&
64
+ bearerToken &&
65
+ pluginConfig.oauth?.type === 'builtin' &&
66
+ !pluginConfig.oauth.issueToken
67
+ ) {
68
+ req.user = await authenticateLoginToken({ req, token: bearerToken })
69
+ }
70
+ if (!req.user && bearerToken && pluginConfig.oauth?.authenticate) {
71
+ req.user = await pluginConfig.oauth.authenticate({ req, token: bearerToken })
72
+ }
73
+
74
+ // With OAuth, the endpoint answers with a challenge that starts the client's sign-in
75
+ if (hasAuthorization && !req.user && !isChallengedWhenSignedOut) {
76
+ throw new UnauthorizedError(req.t)
77
+ }
78
+ }
79
+
80
+ // Signed-out users only get the challenge, so they can't use any MCP items. Skipping the access
81
+ // checks saves work, and access callbacks only see signed-in users.
82
+ if (isChallengedWhenSignedOut && !req.user) {
83
+ return { items: [], overrideAccess }
84
+ }
85
+
86
+ return {
87
+ items: await filterMCPItems({
88
+ items: pluginConfig.items,
89
+ overrideAccess,
90
+ req,
91
+ }),
92
+ overrideAccess,
93
+ }
94
+ }
95
+
96
+ export const filterMCPItems = async ({
97
+ items,
98
+ overrideAccess,
99
+ req,
100
+ }: {
101
+ items: MCPItem[]
102
+ overrideAccess: boolean
103
+ req: PayloadRequest
104
+ }): Promise<MCPItem[]> => {
105
+ // Match Payload core: overrideAccess bypasses access evaluation
106
+ if (overrideAccess) {
107
+ return items
108
+ }
109
+
110
+ const authorizedItems: MCPItem[] = []
111
+
112
+ const permissions = await getAccessResults({ req })
113
+
114
+ for (const item of items) {
115
+ if (!(await checkItemAccess({ item, permissions, req }))) {
116
+ continue
117
+ }
118
+ authorizedItems.push(item)
119
+ }
120
+
121
+ return authorizedItems
122
+ }
123
+
124
+ /**
125
+ * Runs MCP item access callbacks
126
+ */
127
+ const checkItemAccess = async ({
128
+ item,
129
+ permissions,
130
+ req,
131
+ }: {
132
+ item: MCPItem
133
+ permissions?: SanitizedPermissions
134
+ req: PayloadRequest
135
+ }): Promise<boolean> => {
136
+ switch (item.type) {
137
+ case 'collectionTool':
138
+ return (
139
+ !item.tool.access ||
140
+ (await item.tool.access({ slug: item.collectionSlug, permissions, req }))
141
+ )
142
+ case 'globalTool':
143
+ return (
144
+ !item.tool.access || (await item.tool.access({ slug: item.globalSlug, permissions, req }))
145
+ )
146
+ case 'prompt':
147
+ return !item.prompt.access || (await item.prompt.access({ permissions, req }))
148
+ case 'resource':
149
+ return !item.resource.access || (await item.resource.access({ permissions, req }))
150
+ case 'tool':
151
+ return !item.tool.access || (await item.tool.access({ permissions, req }))
152
+ }
153
+ }
@@ -0,0 +1,123 @@
1
+ import type { PayloadHandler, PayloadRequest } from 'payload'
2
+
3
+ import {
4
+ createMcpHandler,
5
+ isLegacyRequest,
6
+ readRequestBody,
7
+ WebStandardStreamableHTTPServerTransport,
8
+ } from '@modelcontextprotocol/server'
9
+ import { APIError } from 'payload'
10
+
11
+ import { buildMcpServer } from '../mcp/buildMcpServer.js'
12
+ import { getPluginConfig } from '../utils/getPluginConfig.js'
13
+ import { getAuthorizedMCP } from './access.js'
14
+ import { getMCPResource, oauthChallenge } from './oauth.js'
15
+
16
+ export const mcpEndpoint: PayloadHandler = async (req) => {
17
+ if (!req.url) {
18
+ throw new APIError('Missing request URL', 400)
19
+ }
20
+
21
+ req.payloadAPI = 'MCP' as const
22
+ // Lets auth strategies check that an OAuth access token was issued for this MCP server
23
+ req.context.mcp = { resource: getMCPResource({ req }) }
24
+
25
+ const pluginConfig = getPluginConfig({ config: req.payload.config })
26
+ const overrideAccessParam = new URL(req.url).searchParams.get('overrideAccess')
27
+
28
+ if (overrideAccessParam !== null && process.env.NODE_ENV !== 'development') {
29
+ throw new APIError('MCP overrideAccess is only available in development.', 400)
30
+ }
31
+
32
+ let overrideAccess = false
33
+ if (overrideAccessParam === 'true') {
34
+ overrideAccess = true
35
+ } else if (overrideAccessParam !== null && overrideAccessParam !== 'false') {
36
+ throw new APIError('MCP overrideAccess must be "true" or "false".', 400)
37
+ }
38
+
39
+ const authorizedMCP = await getAuthorizedMCP({ isHTTP: true, overrideAccess, req })
40
+
41
+ // Clients like Codex send a GET first to find out where to sign in, so this comes before the
42
+ // GET check
43
+ if (pluginConfig.oauth && !req.user) {
44
+ return oauthChallenge({ req })
45
+ }
46
+
47
+ // Streamable HTTP's optional server-to-client stream. We don't offer one, so answer 405 per
48
+ // spec, and clients skip it
49
+ if (req.method === 'GET') {
50
+ return new Response(null, { headers: { Allow: 'POST' }, status: 405 })
51
+ }
52
+
53
+ const maxRequestBodySize = pluginConfig.mcp?.maxRequestBodySize
54
+ // Payload augments the original web-standard Request in place.
55
+ const mcpRequest = req as PayloadRequest & Request
56
+ const parsedBody = await parseRequestBody({ maxRequestBodySize, request: mcpRequest })
57
+
58
+ // Keep the old JSON-only, stateless behavior because the SDK's 2025 fallback uses SSE.
59
+ if (await isLegacyRequest(mcpRequest, parsedBody, { maxRequestBodySize })) {
60
+ const server = buildMcpServer({ authorizedMCP, pluginConfig, req })
61
+ const transport = new WebStandardStreamableHTTPServerTransport({
62
+ enableJsonResponse: true,
63
+ maxRequestBodySize,
64
+ sessionIdGenerator: undefined, // stateless mode
65
+ })
66
+ transport.onerror = (err) => {
67
+ req.payload.logger.error({ err, msg: 'Error serving legacy MCP request' })
68
+ }
69
+
70
+ try {
71
+ await server.connect(transport)
72
+ return await transport.handleRequest(mcpRequest, { parsedBody })
73
+ } finally {
74
+ await server.close().catch((err) => {
75
+ req.payload.logger.error({ err, msg: 'Error closing MCP server' })
76
+ })
77
+ }
78
+ }
79
+
80
+ const handler = createMcpHandler(() => buildMcpServer({ authorizedMCP, pluginConfig, req }), {
81
+ legacy: 'reject',
82
+ maxRequestBodySize,
83
+ // SDK subscriptions always use SSE, so disable them to keep every response JSON-only.
84
+ maxSubscriptions: 0,
85
+ onerror: (err) => {
86
+ req.payload.logger.error({ err, msg: 'Error serving modern MCP request' })
87
+ },
88
+ responseMode: 'json',
89
+ })
90
+
91
+ try {
92
+ return await handler.fetch(mcpRequest, { parsedBody })
93
+ } finally {
94
+ await handler.close().catch((err) => {
95
+ req.payload.logger.error({ err, msg: 'Error closing modern MCP handler' })
96
+ })
97
+ }
98
+ }
99
+
100
+ /**
101
+ * Parses a POST body once so the era check and the SDK handler can share it. The SDK
102
+ * skips its size limit for a pre-parsed body, so this reads with the same limit. It reads
103
+ * a clone and returns `undefined` for any body the SDK should reject (too large, unreadable,
104
+ * or not JSON), leaving the original request for the SDK to read and answer.
105
+ */
106
+ const parseRequestBody = async ({
107
+ maxRequestBodySize,
108
+ request,
109
+ }: {
110
+ maxRequestBodySize?: number
111
+ request: Request
112
+ }): Promise<unknown> => {
113
+ if (request.method.toUpperCase() !== 'POST') {
114
+ return undefined
115
+ }
116
+
117
+ try {
118
+ const body = await readRequestBody(request.clone(), maxRequestBodySize)
119
+ return body.tooLarge ? undefined : JSON.parse(body.text)
120
+ } catch {
121
+ return undefined
122
+ }
123
+ }
@@ -0,0 +1,108 @@
1
+ import type { OAuthProtectedResourceMetadata } from '@modelcontextprotocol/server'
2
+ import type { PayloadHandler, PayloadRequest, SanitizedConfig } from 'payload'
3
+
4
+ import {
5
+ bearerAuthChallengeResponse,
6
+ OAuthError,
7
+ OAuthErrorCode,
8
+ } from '@modelcontextprotocol/server'
9
+ import { createPayloadRequest, getPayload } from 'payload'
10
+ import { formatAdminURL, stripTrailingSlash } from 'payload/shared'
11
+
12
+ import { getPluginConfig } from '../utils/getPluginConfig.js'
13
+
14
+ /**
15
+ * Serves the OAuth protected resource metadata (RFC 9728) at `/api/mcp/oauth-protected-resource`.
16
+ * The OAuth challenge links here, so MCP clients find the authorization server without setup.
17
+ */
18
+ export const oauthProtectedResourceEndpoint: PayloadHandler = (req) => getMetadataResponse({ req })
19
+
20
+ /**
21
+ * Serves the same metadata for clients that ignore the challenge's link and only look at
22
+ * `/.well-known/oauth-protected-resource`. Mount it at the site root, e.g. in Next.js at
23
+ * `app/.well-known/oauth-protected-resource/[[...path]]/route.ts`:
24
+ *
25
+ * ```ts
26
+ * import config from '@payload-config'
27
+ * import { oauthProtectedResourceHandler } from '@payloadcms/plugin-mcp'
28
+ *
29
+ * export const GET = oauthProtectedResourceHandler({ config })
30
+ * ```
31
+ */
32
+ export const oauthProtectedResourceHandler =
33
+ ({ config }: { config: Promise<SanitizedConfig> | SanitizedConfig }) =>
34
+ async (request: Request): Promise<Response> =>
35
+ getMetadataResponse({
36
+ req: await createPayloadRequest({ payload: await getPayload({ config }), req: request }),
37
+ })
38
+
39
+ /**
40
+ * Answers an unauthenticated MCP request with a challenge linking to the protected resource
41
+ * metadata, which starts the client's OAuth flow.
42
+ */
43
+ export const oauthChallenge = ({ req }: { req: PayloadRequest }): Response => {
44
+ const { oauth } = getPluginConfig({ config: req.payload.config })
45
+ const response = bearerAuthChallengeResponse(
46
+ new OAuthError(OAuthErrorCode.InvalidToken, req.t('error:unauthorized')),
47
+ {
48
+ requiredScopes: oauth?.type === 'external' ? oauth.scopes : undefined,
49
+ resourceMetadataUrl: `${getMCPResource({ req })}/oauth-protected-resource`,
50
+ },
51
+ )
52
+
53
+ // Lets browser-based MCP clients read the challenge, when Payload's `cors` setting allows them
54
+ response.headers.set('Access-Control-Expose-Headers', 'WWW-Authenticate')
55
+
56
+ return response
57
+ }
58
+
59
+ /**
60
+ * The MCP endpoint's address, as advertised in the metadata's `resource`. The metadata link and
61
+ * the built-in authorization server's issuer are based on it. Clients send it when they sign in,
62
+ * and authorization servers that support it put it in the access token's audience.
63
+ */
64
+ export const getMCPResource = ({ req }: { req: PayloadRequest }): string => {
65
+ const { config } = req.payload
66
+ const resource = getPluginConfig({ config }).oauth?.resource
67
+
68
+ if (typeof resource === 'function') {
69
+ return resource({ req })
70
+ }
71
+
72
+ if (resource) {
73
+ return resource
74
+ }
75
+
76
+ // Without the slash Next.js's `trailingSlash` would add, since the metadata link appends to it
77
+ const path = stripTrailingSlash(formatAdminURL({ apiRoute: config.routes.api, path: '/mcp' }))
78
+
79
+ return new URL(path, config.serverURL || req.url).href
80
+ }
81
+
82
+ const getMetadataResponse = async ({ req }: { req: PayloadRequest }): Promise<Response> => {
83
+ const { config } = req.payload
84
+ const { oauth } = getPluginConfig({ config })
85
+
86
+ if (!oauth) {
87
+ return new Response(null, { status: 404 })
88
+ }
89
+
90
+ const resource = getMCPResource({ req })
91
+
92
+ return Response.json(
93
+ {
94
+ authorization_servers:
95
+ oauth.type === 'builtin'
96
+ ? [`${resource}/oauth`]
97
+ : typeof oauth.authorizationServers === 'function'
98
+ ? await oauth.authorizationServers({ req })
99
+ : oauth.authorizationServers,
100
+ bearer_methods_supported: ['header'],
101
+ resource,
102
+ scopes_supported: oauth.type === 'external' ? oauth.scopes : undefined,
103
+ } satisfies OAuthProtectedResourceMetadata,
104
+ // Public document, readable by browser-based MCP clients on any origin. Not cached, since its
105
+ // URLs can depend on the request.
106
+ { headers: { 'Access-Control-Allow-Origin': '*', 'Cache-Control': 'no-store' } },
107
+ )
108
+ }