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

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 (617) hide show
  1. package/bin.js +39 -0
  2. package/dist/@types/assets.d.js +2 -0
  3. package/dist/@types/assets.d.js.map +1 -0
  4. package/dist/collection/getAccessField.d.ts +12 -0
  5. package/dist/collection/getAccessField.d.ts.map +1 -0
  6. package/dist/collection/getAccessField.js +72 -0
  7. package/dist/collection/getAccessField.js.map +1 -0
  8. package/dist/collection/index.d.ts +6 -0
  9. package/dist/collection/index.d.ts.map +1 -0
  10. package/dist/collection/index.js +105 -0
  11. package/dist/collection/index.js.map +1 -0
  12. package/dist/components/APIKeyField/index.client.d.ts +9 -0
  13. package/dist/components/APIKeyField/index.client.d.ts.map +1 -0
  14. package/dist/components/APIKeyField/index.client.js +85 -0
  15. package/dist/components/APIKeyField/index.client.js.map +1 -0
  16. package/dist/components/APIKeyField/index.css +105 -0
  17. package/dist/components/APIKeysEmptyState/index.client.d.ts +4 -0
  18. package/dist/components/APIKeysEmptyState/index.client.d.ts.map +1 -0
  19. package/dist/components/APIKeysEmptyState/index.client.js +21 -0
  20. package/dist/components/APIKeysEmptyState/index.client.js.map +1 -0
  21. package/dist/components/AccessField/index.client.d.ts +10 -0
  22. package/dist/components/AccessField/index.client.d.ts.map +1 -0
  23. package/dist/components/AccessField/index.client.js +247 -0
  24. package/dist/components/AccessField/index.client.js.map +1 -0
  25. package/dist/components/AccessField/index.css +99 -0
  26. package/dist/components/SettingsMenu/index.client.d.ts +8 -0
  27. package/dist/components/SettingsMenu/index.client.d.ts.map +1 -0
  28. package/dist/components/SettingsMenu/index.client.js +29 -0
  29. package/dist/components/SettingsMenu/index.client.js.map +1 -0
  30. package/dist/defineTool.d.ts +26 -0
  31. package/dist/defineTool.d.ts.map +1 -0
  32. package/dist/defineTool.js +37 -0
  33. package/dist/defineTool.js.map +1 -0
  34. package/dist/endpoint/access.d.ts +10 -0
  35. package/dist/endpoint/access.d.ts.map +1 -0
  36. package/dist/endpoint/access.js +122 -0
  37. package/dist/endpoint/access.js.map +1 -0
  38. package/dist/endpoint/index.d.ts +3 -0
  39. package/dist/endpoint/index.d.ts.map +1 -0
  40. package/dist/endpoint/index.js +36 -0
  41. package/dist/endpoint/index.js.map +1 -0
  42. package/dist/exports/client.d.ts +5 -0
  43. package/dist/exports/client.d.ts.map +1 -0
  44. package/dist/exports/client.js +7 -0
  45. package/dist/exports/client.js.map +1 -0
  46. package/dist/index.d.ts +4 -7
  47. package/dist/index.d.ts.map +1 -1
  48. package/dist/index.js +87 -67
  49. package/dist/index.js.map +1 -1
  50. package/dist/mcp/buildMcpServer.d.ts +19 -0
  51. package/dist/mcp/buildMcpServer.d.ts.map +1 -0
  52. package/dist/mcp/buildMcpServer.js +199 -0
  53. package/dist/mcp/buildMcpServer.js.map +1 -0
  54. package/dist/mcp/builtin/collections/authTools.d.ts +7 -0
  55. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -0
  56. package/dist/mcp/builtin/collections/authTools.js +250 -0
  57. package/dist/mcp/builtin/collections/authTools.js.map +1 -0
  58. package/dist/mcp/builtin/collections/createTool.d.ts +2 -0
  59. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -0
  60. package/dist/mcp/builtin/collections/createTool.js +94 -0
  61. package/dist/mcp/builtin/collections/createTool.js.map +1 -0
  62. package/dist/mcp/builtin/collections/deleteTool.d.ts +2 -0
  63. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -0
  64. package/dist/mcp/builtin/collections/deleteTool.js +102 -0
  65. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -0
  66. package/dist/mcp/builtin/collections/findTool.d.ts +2 -0
  67. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -0
  68. package/dist/mcp/builtin/collections/findTool.js +144 -0
  69. package/dist/mcp/builtin/collections/findTool.js.map +1 -0
  70. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +9 -0
  71. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -0
  72. package/dist/mcp/builtin/collections/formatCollectionError.js +60 -0
  73. package/dist/mcp/builtin/collections/formatCollectionError.js.map +1 -0
  74. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
  75. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
  76. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +35 -0
  77. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
  78. package/dist/mcp/builtin/collections/updateTool.d.ts +2 -0
  79. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -0
  80. package/dist/mcp/builtin/collections/updateTool.js +199 -0
  81. package/dist/mcp/builtin/collections/updateTool.js.map +1 -0
  82. package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
  83. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
  84. package/dist/mcp/builtin/getConfigInfoTool.js +49 -0
  85. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
  86. package/dist/mcp/builtin/globals/findTool.d.ts +2 -0
  87. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -0
  88. package/dist/mcp/builtin/globals/findTool.js +76 -0
  89. package/dist/mcp/builtin/globals/findTool.js.map +1 -0
  90. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
  91. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
  92. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +35 -0
  93. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
  94. package/dist/mcp/builtin/globals/updateTool.d.ts +2 -0
  95. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -0
  96. package/dist/mcp/builtin/globals/updateTool.js +94 -0
  97. package/dist/mcp/builtin/globals/updateTool.js.map +1 -0
  98. package/dist/mcp/builtin/validateEntityData.d.ts +14 -0
  99. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -0
  100. package/dist/mcp/builtin/validateEntityData.js +82 -0
  101. package/dist/mcp/builtin/validateEntityData.js.map +1 -0
  102. package/dist/mcp/builtinTools.d.ts +105 -0
  103. package/dist/mcp/builtinTools.d.ts.map +1 -0
  104. package/dist/mcp/builtinTools.js +107 -0
  105. package/dist/mcp/builtinTools.js.map +1 -0
  106. package/dist/mcp/sanitizeMCPConfig.d.ts +17 -0
  107. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -0
  108. package/dist/mcp/sanitizeMCPConfig.js +188 -0
  109. package/dist/mcp/sanitizeMCPConfig.js.map +1 -0
  110. package/dist/stdio.d.ts +8 -0
  111. package/dist/stdio.d.ts.map +1 -0
  112. package/dist/stdio.js +89 -0
  113. package/dist/stdio.js.map +1 -0
  114. package/dist/translations/index.d.ts +11 -0
  115. package/dist/translations/index.d.ts.map +1 -0
  116. package/dist/translations/index.js +92 -0
  117. package/dist/translations/index.js.map +1 -0
  118. package/dist/translations/languages/ar.d.ts +31 -0
  119. package/dist/translations/languages/ar.d.ts.map +1 -0
  120. package/dist/translations/languages/ar.js +34 -0
  121. package/dist/translations/languages/ar.js.map +1 -0
  122. package/dist/translations/languages/az.d.ts +31 -0
  123. package/dist/translations/languages/az.d.ts.map +1 -0
  124. package/dist/translations/languages/az.js +34 -0
  125. package/dist/translations/languages/az.js.map +1 -0
  126. package/dist/translations/languages/bg.d.ts +31 -0
  127. package/dist/translations/languages/bg.d.ts.map +1 -0
  128. package/dist/translations/languages/bg.js +34 -0
  129. package/dist/translations/languages/bg.js.map +1 -0
  130. package/dist/translations/languages/bnBd.d.ts +31 -0
  131. package/dist/translations/languages/bnBd.d.ts.map +1 -0
  132. package/dist/translations/languages/bnBd.js +34 -0
  133. package/dist/translations/languages/bnBd.js.map +1 -0
  134. package/dist/translations/languages/bnIn.d.ts +31 -0
  135. package/dist/translations/languages/bnIn.d.ts.map +1 -0
  136. package/dist/translations/languages/bnIn.js +34 -0
  137. package/dist/translations/languages/bnIn.js.map +1 -0
  138. package/dist/translations/languages/ca.d.ts +31 -0
  139. package/dist/translations/languages/ca.d.ts.map +1 -0
  140. package/dist/translations/languages/ca.js +34 -0
  141. package/dist/translations/languages/ca.js.map +1 -0
  142. package/dist/translations/languages/cs.d.ts +31 -0
  143. package/dist/translations/languages/cs.d.ts.map +1 -0
  144. package/dist/translations/languages/cs.js +34 -0
  145. package/dist/translations/languages/cs.js.map +1 -0
  146. package/dist/translations/languages/da.d.ts +31 -0
  147. package/dist/translations/languages/da.d.ts.map +1 -0
  148. package/dist/translations/languages/da.js +34 -0
  149. package/dist/translations/languages/da.js.map +1 -0
  150. package/dist/translations/languages/de.d.ts +31 -0
  151. package/dist/translations/languages/de.d.ts.map +1 -0
  152. package/dist/translations/languages/de.js +34 -0
  153. package/dist/translations/languages/de.js.map +1 -0
  154. package/dist/translations/languages/en.d.ts +31 -0
  155. package/dist/translations/languages/en.d.ts.map +1 -0
  156. package/dist/translations/languages/en.js +34 -0
  157. package/dist/translations/languages/en.js.map +1 -0
  158. package/dist/translations/languages/es.d.ts +31 -0
  159. package/dist/translations/languages/es.d.ts.map +1 -0
  160. package/dist/translations/languages/es.js +34 -0
  161. package/dist/translations/languages/es.js.map +1 -0
  162. package/dist/translations/languages/et.d.ts +31 -0
  163. package/dist/translations/languages/et.d.ts.map +1 -0
  164. package/dist/translations/languages/et.js +34 -0
  165. package/dist/translations/languages/et.js.map +1 -0
  166. package/dist/translations/languages/fa.d.ts +31 -0
  167. package/dist/translations/languages/fa.d.ts.map +1 -0
  168. package/dist/translations/languages/fa.js +34 -0
  169. package/dist/translations/languages/fa.js.map +1 -0
  170. package/dist/translations/languages/fr.d.ts +31 -0
  171. package/dist/translations/languages/fr.d.ts.map +1 -0
  172. package/dist/translations/languages/fr.js +34 -0
  173. package/dist/translations/languages/fr.js.map +1 -0
  174. package/dist/translations/languages/he.d.ts +31 -0
  175. package/dist/translations/languages/he.d.ts.map +1 -0
  176. package/dist/translations/languages/he.js +34 -0
  177. package/dist/translations/languages/he.js.map +1 -0
  178. package/dist/translations/languages/hr.d.ts +31 -0
  179. package/dist/translations/languages/hr.d.ts.map +1 -0
  180. package/dist/translations/languages/hr.js +34 -0
  181. package/dist/translations/languages/hr.js.map +1 -0
  182. package/dist/translations/languages/hu.d.ts +31 -0
  183. package/dist/translations/languages/hu.d.ts.map +1 -0
  184. package/dist/translations/languages/hu.js +34 -0
  185. package/dist/translations/languages/hu.js.map +1 -0
  186. package/dist/translations/languages/hy.d.ts +31 -0
  187. package/dist/translations/languages/hy.d.ts.map +1 -0
  188. package/dist/translations/languages/hy.js +34 -0
  189. package/dist/translations/languages/hy.js.map +1 -0
  190. package/dist/translations/languages/id.d.ts +31 -0
  191. package/dist/translations/languages/id.d.ts.map +1 -0
  192. package/dist/translations/languages/id.js +34 -0
  193. package/dist/translations/languages/id.js.map +1 -0
  194. package/dist/translations/languages/is.d.ts +31 -0
  195. package/dist/translations/languages/is.d.ts.map +1 -0
  196. package/dist/translations/languages/is.js +34 -0
  197. package/dist/translations/languages/is.js.map +1 -0
  198. package/dist/translations/languages/it.d.ts +31 -0
  199. package/dist/translations/languages/it.d.ts.map +1 -0
  200. package/dist/translations/languages/it.js +34 -0
  201. package/dist/translations/languages/it.js.map +1 -0
  202. package/dist/translations/languages/ja.d.ts +31 -0
  203. package/dist/translations/languages/ja.d.ts.map +1 -0
  204. package/dist/translations/languages/ja.js +34 -0
  205. package/dist/translations/languages/ja.js.map +1 -0
  206. package/dist/translations/languages/ko.d.ts +31 -0
  207. package/dist/translations/languages/ko.d.ts.map +1 -0
  208. package/dist/translations/languages/ko.js +34 -0
  209. package/dist/translations/languages/ko.js.map +1 -0
  210. package/dist/translations/languages/lt.d.ts +31 -0
  211. package/dist/translations/languages/lt.d.ts.map +1 -0
  212. package/dist/translations/languages/lt.js +34 -0
  213. package/dist/translations/languages/lt.js.map +1 -0
  214. package/dist/translations/languages/lv.d.ts +31 -0
  215. package/dist/translations/languages/lv.d.ts.map +1 -0
  216. package/dist/translations/languages/lv.js +34 -0
  217. package/dist/translations/languages/lv.js.map +1 -0
  218. package/dist/translations/languages/my.d.ts +31 -0
  219. package/dist/translations/languages/my.d.ts.map +1 -0
  220. package/dist/translations/languages/my.js +34 -0
  221. package/dist/translations/languages/my.js.map +1 -0
  222. package/dist/translations/languages/nb.d.ts +31 -0
  223. package/dist/translations/languages/nb.d.ts.map +1 -0
  224. package/dist/translations/languages/nb.js +34 -0
  225. package/dist/translations/languages/nb.js.map +1 -0
  226. package/dist/translations/languages/nl.d.ts +31 -0
  227. package/dist/translations/languages/nl.d.ts.map +1 -0
  228. package/dist/translations/languages/nl.js +34 -0
  229. package/dist/translations/languages/nl.js.map +1 -0
  230. package/dist/translations/languages/pl.d.ts +31 -0
  231. package/dist/translations/languages/pl.d.ts.map +1 -0
  232. package/dist/translations/languages/pl.js +34 -0
  233. package/dist/translations/languages/pl.js.map +1 -0
  234. package/dist/translations/languages/pt.d.ts +31 -0
  235. package/dist/translations/languages/pt.d.ts.map +1 -0
  236. package/dist/translations/languages/pt.js +34 -0
  237. package/dist/translations/languages/pt.js.map +1 -0
  238. package/dist/translations/languages/ro.d.ts +31 -0
  239. package/dist/translations/languages/ro.d.ts.map +1 -0
  240. package/dist/translations/languages/ro.js +34 -0
  241. package/dist/translations/languages/ro.js.map +1 -0
  242. package/dist/translations/languages/rs.d.ts +31 -0
  243. package/dist/translations/languages/rs.d.ts.map +1 -0
  244. package/dist/translations/languages/rs.js +34 -0
  245. package/dist/translations/languages/rs.js.map +1 -0
  246. package/dist/translations/languages/rsLatin.d.ts +31 -0
  247. package/dist/translations/languages/rsLatin.d.ts.map +1 -0
  248. package/dist/translations/languages/rsLatin.js +34 -0
  249. package/dist/translations/languages/rsLatin.js.map +1 -0
  250. package/dist/translations/languages/ru.d.ts +31 -0
  251. package/dist/translations/languages/ru.d.ts.map +1 -0
  252. package/dist/translations/languages/ru.js +34 -0
  253. package/dist/translations/languages/ru.js.map +1 -0
  254. package/dist/translations/languages/sk.d.ts +31 -0
  255. package/dist/translations/languages/sk.d.ts.map +1 -0
  256. package/dist/translations/languages/sk.js +34 -0
  257. package/dist/translations/languages/sk.js.map +1 -0
  258. package/dist/translations/languages/sl.d.ts +31 -0
  259. package/dist/translations/languages/sl.d.ts.map +1 -0
  260. package/dist/translations/languages/sl.js +34 -0
  261. package/dist/translations/languages/sl.js.map +1 -0
  262. package/dist/translations/languages/sv.d.ts +31 -0
  263. package/dist/translations/languages/sv.d.ts.map +1 -0
  264. package/dist/translations/languages/sv.js +34 -0
  265. package/dist/translations/languages/sv.js.map +1 -0
  266. package/dist/translations/languages/ta.d.ts +31 -0
  267. package/dist/translations/languages/ta.d.ts.map +1 -0
  268. package/dist/translations/languages/ta.js +34 -0
  269. package/dist/translations/languages/ta.js.map +1 -0
  270. package/dist/translations/languages/th.d.ts +31 -0
  271. package/dist/translations/languages/th.d.ts.map +1 -0
  272. package/dist/translations/languages/th.js +34 -0
  273. package/dist/translations/languages/th.js.map +1 -0
  274. package/dist/translations/languages/tr.d.ts +31 -0
  275. package/dist/translations/languages/tr.d.ts.map +1 -0
  276. package/dist/translations/languages/tr.js +34 -0
  277. package/dist/translations/languages/tr.js.map +1 -0
  278. package/dist/translations/languages/uk.d.ts +31 -0
  279. package/dist/translations/languages/uk.d.ts.map +1 -0
  280. package/dist/translations/languages/uk.js +34 -0
  281. package/dist/translations/languages/uk.js.map +1 -0
  282. package/dist/translations/languages/vi.d.ts +31 -0
  283. package/dist/translations/languages/vi.d.ts.map +1 -0
  284. package/dist/translations/languages/vi.js +34 -0
  285. package/dist/translations/languages/vi.js.map +1 -0
  286. package/dist/translations/languages/zh.d.ts +31 -0
  287. package/dist/translations/languages/zh.d.ts.map +1 -0
  288. package/dist/translations/languages/zh.js +34 -0
  289. package/dist/translations/languages/zh.js.map +1 -0
  290. package/dist/translations/languages/zhTw.d.ts +31 -0
  291. package/dist/translations/languages/zhTw.d.ts.map +1 -0
  292. package/dist/translations/languages/zhTw.js +34 -0
  293. package/dist/translations/languages/zhTw.js.map +1 -0
  294. package/dist/translations/types.d.ts +32 -0
  295. package/dist/translations/types.d.ts.map +1 -0
  296. package/dist/translations/types.js +3 -0
  297. package/dist/translations/types.js.map +1 -0
  298. package/dist/types.d.ts +255 -454
  299. package/dist/types.d.ts.map +1 -1
  300. package/dist/types.js +6 -1
  301. package/dist/types.js.map +1 -1
  302. package/dist/utils/camelCase.d.ts.map +1 -1
  303. package/dist/utils/getLogger.d.ts +10 -0
  304. package/dist/utils/getLogger.d.ts.map +1 -0
  305. package/dist/utils/getLogger.js +22 -0
  306. package/dist/utils/getLogger.js.map +1 -0
  307. package/dist/utils/getPluginConfig.d.ts +12 -0
  308. package/dist/utils/getPluginConfig.d.ts.map +1 -0
  309. package/dist/utils/getPluginConfig.js +15 -0
  310. package/dist/utils/getPluginConfig.js.map +1 -0
  311. package/dist/utils/localAPIDefaults.d.ts +20 -0
  312. package/dist/utils/localAPIDefaults.d.ts.map +1 -0
  313. package/dist/utils/localAPIDefaults.js +19 -0
  314. package/dist/utils/localAPIDefaults.js.map +1 -0
  315. package/dist/utils/resolveProjectRoot.d.ts +7 -0
  316. package/dist/utils/resolveProjectRoot.d.ts.map +1 -0
  317. package/dist/utils/resolveProjectRoot.js +15 -0
  318. package/dist/utils/resolveProjectRoot.js.map +1 -0
  319. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +11 -0
  320. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -0
  321. package/dist/utils/schemaConversion/getEntityInputSchema.js +34 -0
  322. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -0
  323. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +2 -2
  324. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +1 -1
  325. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +1 -1
  326. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +15 -0
  327. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -0
  328. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +464 -0
  329. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -0
  330. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +158 -0
  331. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -0
  332. package/dist/utils/toStandardSchema.d.ts +5 -0
  333. package/dist/utils/toStandardSchema.d.ts.map +1 -0
  334. package/dist/utils/toStandardSchema.js +4 -0
  335. package/dist/utils/toStandardSchema.js.map +1 -0
  336. package/dist/utils/whereSchema.d.ts +9 -0
  337. package/dist/utils/whereSchema.d.ts.map +1 -0
  338. package/dist/utils/whereSchema.js +13 -0
  339. package/dist/utils/whereSchema.js.map +1 -0
  340. package/package.json +36 -10
  341. package/src/@types/assets.d.ts +3 -0
  342. package/src/collection/getAccessField.ts +84 -0
  343. package/src/collection/index.ts +105 -0
  344. package/src/components/APIKeyField/index.client.tsx +73 -0
  345. package/src/components/APIKeyField/index.css +105 -0
  346. package/src/components/APIKeysEmptyState/index.client.tsx +36 -0
  347. package/src/components/AccessField/index.client.tsx +299 -0
  348. package/src/components/AccessField/index.css +99 -0
  349. package/src/components/SettingsMenu/index.client.tsx +34 -0
  350. package/src/defineTool.ts +44 -0
  351. package/src/endpoint/access.ts +144 -0
  352. package/src/endpoint/index.ts +35 -0
  353. package/src/exports/client.ts +5 -0
  354. package/src/index.ts +82 -86
  355. package/src/mcp/buildMcpServer.ts +257 -0
  356. package/src/mcp/builtin/collections/authTools.ts +233 -0
  357. package/src/mcp/builtin/collections/createTool.ts +112 -0
  358. package/src/mcp/builtin/collections/deleteTool.ts +116 -0
  359. package/src/mcp/builtin/collections/findTool.ts +177 -0
  360. package/src/mcp/builtin/collections/formatCollectionError.ts +84 -0
  361. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +28 -0
  362. package/src/mcp/builtin/collections/updateTool.ts +211 -0
  363. package/src/mcp/builtin/getConfigInfoTool.ts +44 -0
  364. package/src/mcp/builtin/globals/findTool.ts +96 -0
  365. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +28 -0
  366. package/src/mcp/builtin/globals/updateTool.ts +115 -0
  367. package/src/mcp/builtin/validateEntityData.ts +132 -0
  368. package/src/mcp/builtinTools.ts +98 -0
  369. package/src/mcp/sanitizeMCPConfig.ts +260 -0
  370. package/src/stdio.ts +98 -0
  371. package/src/translations/index.ts +108 -0
  372. package/src/translations/languages/ar.ts +35 -0
  373. package/src/translations/languages/az.ts +35 -0
  374. package/src/translations/languages/bg.ts +35 -0
  375. package/src/translations/languages/bnBd.ts +35 -0
  376. package/src/translations/languages/bnIn.ts +35 -0
  377. package/src/translations/languages/ca.ts +35 -0
  378. package/src/translations/languages/cs.ts +35 -0
  379. package/src/translations/languages/da.ts +35 -0
  380. package/src/translations/languages/de.ts +35 -0
  381. package/src/translations/languages/en.ts +35 -0
  382. package/src/translations/languages/es.ts +35 -0
  383. package/src/translations/languages/et.ts +35 -0
  384. package/src/translations/languages/fa.ts +35 -0
  385. package/src/translations/languages/fr.ts +35 -0
  386. package/src/translations/languages/he.ts +35 -0
  387. package/src/translations/languages/hr.ts +35 -0
  388. package/src/translations/languages/hu.ts +35 -0
  389. package/src/translations/languages/hy.ts +35 -0
  390. package/src/translations/languages/id.ts +35 -0
  391. package/src/translations/languages/is.ts +35 -0
  392. package/src/translations/languages/it.ts +35 -0
  393. package/src/translations/languages/ja.ts +35 -0
  394. package/src/translations/languages/ko.ts +35 -0
  395. package/src/translations/languages/lt.ts +35 -0
  396. package/src/translations/languages/lv.ts +35 -0
  397. package/src/translations/languages/my.ts +35 -0
  398. package/src/translations/languages/nb.ts +35 -0
  399. package/src/translations/languages/nl.ts +35 -0
  400. package/src/translations/languages/pl.ts +35 -0
  401. package/src/translations/languages/pt.ts +35 -0
  402. package/src/translations/languages/ro.ts +35 -0
  403. package/src/translations/languages/rs.ts +35 -0
  404. package/src/translations/languages/rsLatin.ts +35 -0
  405. package/src/translations/languages/ru.ts +35 -0
  406. package/src/translations/languages/sk.ts +35 -0
  407. package/src/translations/languages/sl.ts +35 -0
  408. package/src/translations/languages/sv.ts +35 -0
  409. package/src/translations/languages/ta.ts +35 -0
  410. package/src/translations/languages/th.ts +35 -0
  411. package/src/translations/languages/tr.ts +35 -0
  412. package/src/translations/languages/uk.ts +35 -0
  413. package/src/translations/languages/vi.ts +35 -0
  414. package/src/translations/languages/zh.ts +35 -0
  415. package/src/translations/languages/zhTw.ts +35 -0
  416. package/src/translations/types.ts +34 -0
  417. package/src/types.ts +295 -490
  418. package/src/utils/getLogger.ts +22 -0
  419. package/src/utils/getPluginConfig.ts +24 -0
  420. package/src/utils/localAPIDefaults.ts +22 -0
  421. package/src/utils/resolveProjectRoot.ts +17 -0
  422. package/src/utils/schemaConversion/getEntityInputSchema.ts +78 -0
  423. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +3 -3
  424. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +103 -0
  425. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +529 -0
  426. package/src/utils/toStandardSchema.ts +9 -0
  427. package/src/utils/whereSchema.ts +24 -0
  428. package/dist/collections/createApiKeysCollection.d.ts +0 -7
  429. package/dist/collections/createApiKeysCollection.d.ts.map +0 -1
  430. package/dist/collections/createApiKeysCollection.js +0 -317
  431. package/dist/collections/createApiKeysCollection.js.map +0 -1
  432. package/dist/defaults.d.ts +0 -4
  433. package/dist/defaults.d.ts.map +0 -1
  434. package/dist/defaults.js +0 -5
  435. package/dist/defaults.js.map +0 -1
  436. package/dist/endpoints/mcp.d.ts +0 -4
  437. package/dist/endpoints/mcp.d.ts.map +0 -1
  438. package/dist/endpoints/mcp.js +0 -71
  439. package/dist/endpoints/mcp.js.map +0 -1
  440. package/dist/mcp/createRequest.d.ts +0 -3
  441. package/dist/mcp/createRequest.d.ts.map +0 -1
  442. package/dist/mcp/createRequest.js +0 -14
  443. package/dist/mcp/createRequest.js.map +0 -1
  444. package/dist/mcp/getMcpHandler.d.ts +0 -4
  445. package/dist/mcp/getMcpHandler.d.ts.map +0 -1
  446. package/dist/mcp/getMcpHandler.js +0 -231
  447. package/dist/mcp/getMcpHandler.js.map +0 -1
  448. package/dist/mcp/helpers/config.d.ts +0 -22
  449. package/dist/mcp/helpers/config.d.ts.map +0 -1
  450. package/dist/mcp/helpers/config.js +0 -153
  451. package/dist/mcp/helpers/config.js.map +0 -1
  452. package/dist/mcp/helpers/fields.d.ts +0 -19
  453. package/dist/mcp/helpers/fields.d.ts.map +0 -1
  454. package/dist/mcp/helpers/fields.js +0 -102
  455. package/dist/mcp/helpers/fields.js.map +0 -1
  456. package/dist/mcp/helpers/fileValidation.d.ts +0 -67
  457. package/dist/mcp/helpers/fileValidation.d.ts.map +0 -1
  458. package/dist/mcp/helpers/fileValidation.js +0 -267
  459. package/dist/mcp/helpers/fileValidation.js.map +0 -1
  460. package/dist/mcp/registerTool.d.ts +0 -6
  461. package/dist/mcp/registerTool.d.ts.map +0 -1
  462. package/dist/mcp/registerTool.js +0 -18
  463. package/dist/mcp/registerTool.js.map +0 -1
  464. package/dist/mcp/tools/auth/auth.d.ts +0 -4
  465. package/dist/mcp/tools/auth/auth.d.ts.map +0 -1
  466. package/dist/mcp/tools/auth/auth.js +0 -57
  467. package/dist/mcp/tools/auth/auth.js.map +0 -1
  468. package/dist/mcp/tools/auth/forgotPassword.d.ts +0 -4
  469. package/dist/mcp/tools/auth/forgotPassword.d.ts.map +0 -1
  470. package/dist/mcp/tools/auth/forgotPassword.js +0 -48
  471. package/dist/mcp/tools/auth/forgotPassword.js.map +0 -1
  472. package/dist/mcp/tools/auth/login.d.ts +0 -4
  473. package/dist/mcp/tools/auth/login.d.ts.map +0 -1
  474. package/dist/mcp/tools/auth/login.js +0 -51
  475. package/dist/mcp/tools/auth/login.js.map +0 -1
  476. package/dist/mcp/tools/auth/resetPassword.d.ts +0 -4
  477. package/dist/mcp/tools/auth/resetPassword.d.ts.map +0 -1
  478. package/dist/mcp/tools/auth/resetPassword.js +0 -49
  479. package/dist/mcp/tools/auth/resetPassword.js.map +0 -1
  480. package/dist/mcp/tools/auth/unlock.d.ts +0 -4
  481. package/dist/mcp/tools/auth/unlock.d.ts.map +0 -1
  482. package/dist/mcp/tools/auth/unlock.js +0 -48
  483. package/dist/mcp/tools/auth/unlock.js.map +0 -1
  484. package/dist/mcp/tools/auth/verify.d.ts +0 -4
  485. package/dist/mcp/tools/auth/verify.d.ts.map +0 -1
  486. package/dist/mcp/tools/auth/verify.js +0 -45
  487. package/dist/mcp/tools/auth/verify.js.map +0 -1
  488. package/dist/mcp/tools/collection/create.d.ts +0 -10
  489. package/dist/mcp/tools/collection/create.d.ts.map +0 -1
  490. package/dist/mcp/tools/collection/create.js +0 -139
  491. package/dist/mcp/tools/collection/create.js.map +0 -1
  492. package/dist/mcp/tools/collection/delete.d.ts +0 -10
  493. package/dist/mcp/tools/collection/delete.d.ts.map +0 -1
  494. package/dist/mcp/tools/collection/delete.js +0 -154
  495. package/dist/mcp/tools/collection/delete.js.map +0 -1
  496. package/dist/mcp/tools/collection/find.d.ts +0 -10
  497. package/dist/mcp/tools/collection/find.d.ts.map +0 -1
  498. package/dist/mcp/tools/collection/find.js +0 -165
  499. package/dist/mcp/tools/collection/find.js.map +0 -1
  500. package/dist/mcp/tools/collection/update.d.ts +0 -10
  501. package/dist/mcp/tools/collection/update.d.ts.map +0 -1
  502. package/dist/mcp/tools/collection/update.js +0 -209
  503. package/dist/mcp/tools/collection/update.js.map +0 -1
  504. package/dist/mcp/tools/config/find.d.ts +0 -10
  505. package/dist/mcp/tools/config/find.d.ts.map +0 -1
  506. package/dist/mcp/tools/config/find.js +0 -97
  507. package/dist/mcp/tools/config/find.js.map +0 -1
  508. package/dist/mcp/tools/config/update.d.ts +0 -10
  509. package/dist/mcp/tools/config/update.d.ts.map +0 -1
  510. package/dist/mcp/tools/config/update.js +0 -215
  511. package/dist/mcp/tools/config/update.js.map +0 -1
  512. package/dist/mcp/tools/global/find.d.ts +0 -5
  513. package/dist/mcp/tools/global/find.d.ts.map +0 -1
  514. package/dist/mcp/tools/global/find.js +0 -82
  515. package/dist/mcp/tools/global/find.js.map +0 -1
  516. package/dist/mcp/tools/global/update.d.ts +0 -6
  517. package/dist/mcp/tools/global/update.d.ts.map +0 -1
  518. package/dist/mcp/tools/global/update.js +0 -124
  519. package/dist/mcp/tools/global/update.js.map +0 -1
  520. package/dist/mcp/tools/job/create.d.ts +0 -10
  521. package/dist/mcp/tools/job/create.d.ts.map +0 -1
  522. package/dist/mcp/tools/job/create.js +0 -293
  523. package/dist/mcp/tools/job/create.js.map +0 -1
  524. package/dist/mcp/tools/job/run.d.ts +0 -10
  525. package/dist/mcp/tools/job/run.d.ts.map +0 -1
  526. package/dist/mcp/tools/job/run.js +0 -129
  527. package/dist/mcp/tools/job/run.js.map +0 -1
  528. package/dist/mcp/tools/job/update.d.ts +0 -11
  529. package/dist/mcp/tools/job/update.d.ts.map +0 -1
  530. package/dist/mcp/tools/job/update.js +0 -186
  531. package/dist/mcp/tools/job/update.js.map +0 -1
  532. package/dist/mcp/tools/resource/create.d.ts +0 -6
  533. package/dist/mcp/tools/resource/create.d.ts.map +0 -1
  534. package/dist/mcp/tools/resource/create.js +0 -124
  535. package/dist/mcp/tools/resource/create.js.map +0 -1
  536. package/dist/mcp/tools/resource/delete.d.ts +0 -5
  537. package/dist/mcp/tools/resource/delete.d.ts.map +0 -1
  538. package/dist/mcp/tools/resource/delete.js +0 -151
  539. package/dist/mcp/tools/resource/delete.js.map +0 -1
  540. package/dist/mcp/tools/resource/find.d.ts +0 -5
  541. package/dist/mcp/tools/resource/find.d.ts.map +0 -1
  542. package/dist/mcp/tools/resource/find.js +0 -170
  543. package/dist/mcp/tools/resource/find.js.map +0 -1
  544. package/dist/mcp/tools/resource/update.d.ts +0 -6
  545. package/dist/mcp/tools/resource/update.d.ts.map +0 -1
  546. package/dist/mcp/tools/resource/update.js +0 -256
  547. package/dist/mcp/tools/resource/update.js.map +0 -1
  548. package/dist/mcp/tools/schemas.d.ts +0 -457
  549. package/dist/mcp/tools/schemas.d.ts.map +0 -1
  550. package/dist/mcp/tools/schemas.js +0 -243
  551. package/dist/mcp/tools/schemas.js.map +0 -1
  552. package/dist/utils/adminEntitySettings.d.ts +0 -17
  553. package/dist/utils/adminEntitySettings.d.ts.map +0 -1
  554. package/dist/utils/adminEntitySettings.js +0 -41
  555. package/dist/utils/adminEntitySettings.js.map +0 -1
  556. package/dist/utils/createApiKeyFields.d.ts +0 -15
  557. package/dist/utils/createApiKeyFields.d.ts.map +0 -1
  558. package/dist/utils/createApiKeyFields.js +0 -57
  559. package/dist/utils/createApiKeyFields.js.map +0 -1
  560. package/dist/utils/getEnabledSlugs.d.ts +0 -13
  561. package/dist/utils/getEnabledSlugs.d.ts.map +0 -1
  562. package/dist/utils/getEnabledSlugs.js +0 -32
  563. package/dist/utils/getEnabledSlugs.js.map +0 -1
  564. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts +0 -3
  565. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts.map +0 -1
  566. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js +0 -43
  567. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js.map +0 -1
  568. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +0 -13
  569. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +0 -1
  570. package/dist/utils/schemaConversion/sanitizeJsonSchema.js +0 -56
  571. package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +0 -1
  572. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +0 -20
  573. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +0 -1
  574. package/dist/utils/schemaConversion/simplifyRelationshipFields.js +0 -53
  575. package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +0 -1
  576. package/dist/utils/schemaConversion/transformPointFields.d.ts +0 -3
  577. package/dist/utils/schemaConversion/transformPointFields.d.ts.map +0 -1
  578. package/dist/utils/schemaConversion/transformPointFields.js +0 -51
  579. package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
  580. package/src/collections/createApiKeysCollection.ts +0 -373
  581. package/src/defaults.ts +0 -3
  582. package/src/endpoints/mcp.ts +0 -91
  583. package/src/mcp/createRequest.ts +0 -13
  584. package/src/mcp/getMcpHandler.ts +0 -545
  585. package/src/mcp/helpers/config.ts +0 -213
  586. package/src/mcp/helpers/fields.ts +0 -154
  587. package/src/mcp/helpers/fileValidation.ts +0 -362
  588. package/src/mcp/registerTool.ts +0 -22
  589. package/src/mcp/tools/auth/auth.ts +0 -71
  590. package/src/mcp/tools/auth/forgotPassword.ts +0 -70
  591. package/src/mcp/tools/auth/login.ts +0 -72
  592. package/src/mcp/tools/auth/resetPassword.ts +0 -61
  593. package/src/mcp/tools/auth/unlock.ts +0 -64
  594. package/src/mcp/tools/auth/verify.ts +0 -57
  595. package/src/mcp/tools/collection/create.ts +0 -210
  596. package/src/mcp/tools/collection/delete.ts +0 -211
  597. package/src/mcp/tools/collection/find.ts +0 -224
  598. package/src/mcp/tools/collection/update.ts +0 -290
  599. package/src/mcp/tools/config/find.ts +0 -128
  600. package/src/mcp/tools/config/update.ts +0 -280
  601. package/src/mcp/tools/global/find.ts +0 -128
  602. package/src/mcp/tools/global/update.ts +0 -207
  603. package/src/mcp/tools/job/create.ts +0 -416
  604. package/src/mcp/tools/job/run.ts +0 -167
  605. package/src/mcp/tools/job/update.ts +0 -274
  606. package/src/mcp/tools/resource/create.ts +0 -211
  607. package/src/mcp/tools/resource/delete.ts +0 -218
  608. package/src/mcp/tools/resource/find.ts +0 -246
  609. package/src/mcp/tools/resource/update.ts +0 -383
  610. package/src/mcp/tools/schemas.ts +0 -520
  611. package/src/utils/adminEntitySettings.ts +0 -40
  612. package/src/utils/createApiKeyFields.ts +0 -72
  613. package/src/utils/getEnabledSlugs.ts +0 -42
  614. package/src/utils/schemaConversion/convertCollectionSchemaToZod.ts +0 -52
  615. package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
  616. package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -65
  617. package/src/utils/schemaConversion/transformPointFields.ts +0 -55
package/dist/types.d.ts CHANGED
@@ -1,482 +1,283 @@
1
- import type { CollectionConfig, CollectionSlug, GlobalSlug, PayloadRequest, TypedUser } from 'payload';
2
- import type { z } from 'zod';
3
- import { type ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
4
- export type MCPPluginConfig = {
5
- /**
6
- * Set the collections that should be available as resources via MCP.
7
- */
8
- collections?: Partial<Record<CollectionSlug, {
9
- /**
10
- * Set the description of the collection. This is used by MCP clients to determine when to use the collecton as a resource.
11
- */
1
+ import type { CallToolResult, ContentBlock, JsonSchemaType, McpServer, ResourceTemplate, ServerContext, StandardSchemaWithJSON } from '@modelcontextprotocol/server';
2
+ import type { AuthCollectionSlug, CollectionConfig, CollectionSlug, DefaultDocumentIDType, GlobalSlug, MaybePromise, PayloadRequest, TypedUser } from 'payload';
3
+ import type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName } from './mcp/builtinTools.js';
4
+ export type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName };
5
+ /** Re-exported from `@modelcontextprotocol/server` — the JSON Schema shape the MCP runtime validates against. */
6
+ export type { JsonSchemaType, StandardSchemaWithJSON };
7
+ /**
8
+ * What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw
9
+ * JSON Schema literal, or a Standard Schema instance (Zod, Valibot, …).
10
+ */
11
+ export type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON;
12
+ /**
13
+ * Serializable mirror of `SanitizedMCPPluginConfig` for client components —
14
+ * the full sanitized config carries functions (tool handlers, etc.) that can't
15
+ * cross the server→client boundary. Built by `sanitizeClientPluginConfig` and
16
+ * passed to the `AccessField` component via `clientProps`.
17
+ *
18
+ * @internal
19
+ */
20
+ export type ClientMCPPluginConfig = {
21
+ items: Array<{
22
+ collectionSlug?: string;
23
+ configKey: string;
12
24
  description?: string;
13
- /**
14
- * Set the enabled capabilities of the collection. Admins can then allow or disallow the use of the capability by MCP clients.
15
- */
16
- enabled: {
17
- create?: boolean;
18
- delete?: boolean;
19
- find?: boolean;
20
- update?: boolean;
21
- } | boolean;
22
- /**
23
- * Override the response generated by the MCP client. This allows you to modify the response that is sent to the MCP client. This is useful for adding additional data to the response, data normalization, or verifying data.
24
- */
25
- overrideResponse?: (response: {
26
- content: Array<{
27
- text: string;
28
- type: string;
29
- }>;
30
- }, doc: Record<string, unknown>, req: PayloadRequest) => {
31
- content: Array<{
32
- text: string;
33
- type: string;
34
- }>;
35
- };
36
- }>>;
25
+ globalSlug?: string;
26
+ /** Admin-UI bucket for collection/global tools: built-in CRUD, auth, or custom. */
27
+ group?: 'auth' | 'custom' | 'operations';
28
+ label: string;
29
+ type: 'collectionTool' | 'globalTool' | 'prompt' | 'resource' | 'tool';
30
+ }>;
31
+ };
32
+ export type MCPToolResponse = {
33
+ content: ContentBlock[];
37
34
  /**
38
- * Disable the MCP plugin.
35
+ * If available, return the document fetched within the
36
+ * mcp tool. This is threaded as an additional argument to
37
+ * overrideResponse functions and stripped before going on the wire.
39
38
  */
40
- disabled?: boolean;
39
+ doc?: Record<string, unknown>;
40
+ } & Pick<CallToolResult, '_meta' | 'isError' | 'structuredContent'>;
41
+ export type MCPResponseOverride = (response: MCPToolResponse, doc: Record<string, unknown>, req: PayloadRequest) => MCPToolResponse;
42
+ /**
43
+ * The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets
44
+ * its inferred output; anything else falls back to `Record<string, unknown>`.
45
+ */
46
+ export type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON ? StandardSchemaWithJSON extends TSchema ? Record<string, unknown> : StandardSchemaWithJSON.InferOutput<TSchema> : Record<string, unknown>;
47
+ export type ToolHandlerArgs<TSchema = undefined> = {
48
+ authorizedMCP: AuthorizedMCP;
49
+ input: TypedInput<TSchema>;
50
+ req: PayloadRequest;
51
+ serverContext: ServerContext;
52
+ };
53
+ export type CollectionToolHandlerArgs<TSchema = undefined> = {
54
+ collectionSlug: CollectionSlug;
55
+ } & ToolHandlerArgs<TSchema>;
56
+ export type GlobalToolHandlerArgs<TSchema = undefined> = {
57
+ globalSlug: GlobalSlug;
58
+ } & ToolHandlerArgs<TSchema>;
59
+ export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
60
+ description: string;
61
+ handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>;
62
+ input?: TSchema;
41
63
  /**
42
- * Experimental features
43
- * **These features are for experimental purposes -- They are Disabled in Production by Default**
64
+ * Override the return value of the tool handler
44
65
  */
45
- experimental?: {
46
- /**
47
- * These are MCP tools that can be used by a client to modify Payload.
48
- */
49
- tools: {
50
- /**
51
- * **Experimental** -- Auth MCP tools allow a client to change authentication priviliages for users. This is for developing ideas that help Admins with authentication tasks.
52
- */
53
- auth?: {
54
- /**
55
- * Enable the auth MCP tools. This allows Admins to enable or disable the auth capabilities.
56
- * @default false
57
- */
58
- enabled: boolean;
59
- };
60
- /**
61
- * **Experimental** -- Collection MCP tools allow for the creation, modification, and deletion of Payload collections. This is for developing ideas that help Developers with collection tasks.
62
- */
63
- collections?: {
64
- /**
65
- * Set the directory path to the collections directory. This can be a directory outside of your default directory, or another Payload project.
66
- */
67
- collectionsDirPath: string;
68
- /**
69
- * Enable the collection MCP tools. This allows Admins to enable or disable the Collection modification capabilities.
70
- * @default false
71
- */
72
- enabled: boolean;
73
- };
74
- /**
75
- * **Experimental** -- Config MCP tools allow for the modification of a Payload Config. This is for developing ideas that help Developers with config tasks.
76
- */
77
- config?: {
78
- /**
79
- * Set the directory path to the config directory. This can be a directory outside of your default directory, or another Payload project.
80
- */
81
- configFilePath: string;
82
- /**
83
- * Enable the config MCP tools. This allows Admins to enable or disable the Payload Config modification capabilities.
84
- * @default false
85
- */
86
- enabled: boolean;
87
- };
88
- /**
89
- * **Experimental** -- Jobs MCP tools allow for the modification of Payload jobs. This is for developing ideas that help Developers with job tasks.
90
- */
91
- jobs?: {
92
- /**
93
- * Enable the jobs MCP tools. This allows Admins to enable or disable the Job modification capabilities.
94
- * @default false
95
- */
96
- enabled: boolean;
97
- /**
98
- * Set the directory path to the jobs directory. This can be a directory outside of your default directory, or another Payload project.
99
- */
100
- jobsDirPath: string;
66
+ overrideResponse?: MCPResponseOverride;
67
+ };
68
+ export type CollectionTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
69
+ handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>;
70
+ input?: TSchema;
71
+ } & Pick<Tool, 'description' | 'overrideResponse'>;
72
+ export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
73
+ handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>;
74
+ input?: TSchema;
75
+ } & Pick<Tool, 'description' | 'overrideResponse'>;
76
+ /**
77
+ * Configures (or disables) a built-in tool without replacing it.
78
+ * `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a
79
+ * required handler) from being silently accepted at a built-in key slot.
80
+ */
81
+ export type MCPBuiltInToolOverride = {
82
+ description?: string;
83
+ handler?: never;
84
+ overrideResponse?: MCPResponseOverride;
85
+ };
86
+ /**
87
+ * Value at a custom (non-built-in) tool key. Either the tool itself, or `false`
88
+ * to disable it (useful when one plugin defines a custom tool and another
89
+ * wants to opt out per-collection).
90
+ */
91
+ export type MCPTopLevelToolEntry = Tool;
92
+ export type MCPCollectionToolsMap = {
93
+ [customToolName: string]: boolean | CollectionTool | MCPBuiltInToolOverride | undefined;
94
+ } & {
95
+ [K in MCPCollectionBuiltinName]?: false | MCPBuiltInToolOverride;
96
+ };
97
+ export type MCPAuthCollectionToolsMap = {
98
+ [K in MCPCollectionAuthToolName]?: MCPBuiltInToolOverride | true;
99
+ } & MCPCollectionToolsMap;
100
+ /** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */
101
+ export type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends AuthCollectionSlug ? MCPAuthCollectionToolsMap : MCPCollectionToolsMap;
102
+ export type MCPGlobalToolsMap = {
103
+ [customToolName: string]: boolean | GlobalTool | MCPBuiltInToolOverride | undefined;
104
+ } & {
105
+ [K in MCPGlobalBuiltinName]?: false | MCPBuiltInToolOverride;
106
+ };
107
+ export type MCPTopLevelToolsMap = Record<string, Tool>;
108
+ export type PromptHandlerArgs<TSchema = undefined> = {
109
+ input: TypedInput<TSchema>;
110
+ req: PayloadRequest;
111
+ serverContext: ServerContext;
112
+ };
113
+ export type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {
114
+ argsSchema: TSchema;
115
+ description: string;
116
+ handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{
117
+ messages: Array<{
118
+ content: {
119
+ text: string;
120
+ type: 'text';
101
121
  };
102
- };
122
+ role: 'assistant' | 'user';
123
+ }>;
124
+ }>;
125
+ title: string;
126
+ };
127
+ export type ResourceHandlerArgs = {
128
+ /** Variables extracted from a `ResourceTemplate` URI. Empty for static-URI resources. */
129
+ params: Record<string, string>;
130
+ req: PayloadRequest;
131
+ serverContext: ServerContext;
132
+ uri: URL;
133
+ };
134
+ export type Resource = {
135
+ description: string;
136
+ handler: (args: ResourceHandlerArgs) => MaybePromise<{
137
+ contents: Array<{
138
+ text: string;
139
+ uri: string;
140
+ }>;
141
+ }>;
142
+ mimeType: string;
143
+ title: string;
144
+ uri: ResourceTemplate | string;
145
+ };
146
+ export type MCPPluginCollectionConfig<TSlug extends CollectionSlug> = {
147
+ description?: string;
148
+ /** Fallback for built-in tools that don't set their own `overrideResponse`. */
149
+ overrideResponse?: MCPResponseOverride;
150
+ tools?: MCPToolsMapForCollection<TSlug>;
151
+ };
152
+ export type MCPPluginGlobalConfig = {
153
+ description?: string;
154
+ overrideResponse?: MCPResponseOverride;
155
+ tools?: MCPGlobalToolsMap;
156
+ };
157
+ /**
158
+ * The user-facing config shape passed to `mcpPlugin({ ... })`. Tools, prompts,
159
+ * resources, and per-collection/global tool maps live in their own nested
160
+ * fields. `sanitizeMCPConfig` flattens those into `items` and applies defaults
161
+ * to produce a `SanitizedMCPPluginConfig` — the form every internal consumer
162
+ * actually works with.
163
+ */
164
+ export type MCPPluginConfig = {
165
+ collections?: {
166
+ [Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>;
167
+ };
168
+ /** Skip MCP registration. The API key collection is still added (so DB / types stay stable). */
169
+ disabled?: boolean;
170
+ globals?: {
171
+ [Slug in GlobalSlug]?: MCPPluginGlobalConfig;
103
172
  };
104
- /**
105
- * Set the globals that should be available as resources via MCP.
106
- * Globals are singleton configuration objects (e.g., site settings, navigation).
107
- * Note: Globals only support find and update operations.
108
- */
109
- globals?: Partial<Record<GlobalSlug, {
110
- /**
111
- * Set the description of the global. This is used by MCP clients to determine when to use the global as a resource.
112
- */
113
- description?: string;
114
- /**
115
- * Set the enabled capabilities of the global. Admins can then allow or disallow the use of the capability by MCP clients.
116
- * Note: Globals only support find and update operations as they are singletons.
117
- */
118
- enabled: {
119
- find?: boolean;
120
- update?: boolean;
121
- } | boolean;
122
- /**
123
- * Override the response generated by the MCP client. This allows you to modify the response that is sent to the MCP client. This is useful for adding additional data to the response, data normalization, or verifying data.
124
- */
125
- overrideResponse?: (response: {
126
- content: Array<{
127
- text: string;
128
- type: string;
129
- }>;
130
- }, doc: Record<string, unknown>, req: PayloadRequest) => {
131
- content: Array<{
132
- text: string;
133
- type: string;
134
- }>;
135
- };
136
- }>>;
137
- /**
138
- * MCP Server options.
139
- */
140
173
  mcp?: {
141
- handlerOptions?: MCPHandlerOptions;
142
- /**
143
- * Add custom MCP Prompts.
144
- */
145
- prompts?: {
146
- /**
147
- * Set the args schema of the prompt. This is the args schema that will be passed to the prompt. This is used by MCP clients to determine the arguments that will be passed to the prompt.
148
- */
149
- argsSchema: z.ZodRawShape;
150
- /**
151
- * Set the description of the prompt. This is used by MCP clients to determine when to use the prompt.
152
- */
153
- description: string;
154
- /**
155
- * Set the handler of the prompt. This is the function that will be called when the prompt is used.
156
- */
157
- handler: (args: Record<string, unknown>, req: PayloadRequest, _extra: unknown) => {
158
- messages: Array<{
159
- content: {
160
- text: string;
161
- type: 'text';
162
- };
163
- role: 'assistant' | 'user';
164
- }>;
165
- } | Promise<{
166
- messages: Array<{
167
- content: {
168
- text: string;
169
- type: 'text';
170
- };
171
- role: 'assistant' | 'user';
172
- }>;
173
- }>;
174
- /**
175
- * Set the function name of the prompt.
176
- */
177
- name: string;
178
- /**
179
- * Set the title of the prompt. LLMs will interperate the title to determine when to use the prompt.
180
- */
181
- title: string;
182
- }[];
183
- /**
184
- * Add custom MCP Resource.
185
- */
186
- resources?: {
187
- /**
188
- * Set the description of the resource. This is used by MCP clients to determine when to use the resource.
189
- * example: 'Data is a resource that contains special data.'
190
- */
191
- description: string;
192
- /**
193
- * Set the handler of the resource. This is the function that will be called when the resource is used.
194
- * The handler can have either 3 arguments (when no args are passed) or 4 arguments (when args are passed).
195
- */
196
- handler: (...args: any[]) => {
197
- contents: Array<{
198
- text: string;
199
- uri: string;
200
- }>;
201
- } | Promise<{
202
- contents: Array<{
203
- text: string;
204
- uri: string;
205
- }>;
206
- }>;
207
- /**
208
- * Set the mime type of the resource.
209
- * example: 'text/plain'
210
- */
211
- mimeType: string;
212
- /**
213
- * Set the function name of the resource.
214
- * example: 'data'
215
- */
216
- name: string;
217
- /**
218
- * Set the title of the resource. LLMs will interperate the title to determine when to use the resource.
219
- * example: 'Data'
220
- */
221
- title: string;
222
- /**
223
- * Set the uri of the resource.
224
- * example: 'data://app'
225
- */
226
- uri: ResourceTemplate | string;
227
- }[];
228
174
  serverOptions?: MCPServerOptions;
229
- /**
230
- * Add custom MCP Tools.
231
- */
232
- tools?: {
233
- /**
234
- * Set the description of the tool. This is used by MCP clients to determine when to use the tool.
235
- */
236
- description: string;
237
- /**
238
- * Set the handler of the tool. This is the function that will be called when the tool is used.
239
- */
240
- handler: (args: Record<string, unknown>, req: PayloadRequest, _extra: unknown) => {
241
- content: Array<{
242
- text: string;
243
- type: 'text';
244
- }>;
245
- role?: string;
246
- } | Promise<{
247
- content: Array<{
248
- text: string;
249
- type: 'text';
250
- }>;
251
- role?: string;
252
- }>;
253
- /**
254
- * Set the name of the tool. This is the name that will be used to identify the tool. LLMs will interperate the name to determine when to use the tool.
255
- */
256
- name: string;
257
- /**
258
- * Set the parameters of the tool. This is the parameters that will be passed to the tool.
259
- */
260
- parameters: z.ZodRawShape;
261
- }[];
175
+ verboseLogs?: boolean;
262
176
  };
263
- /**
264
- * Override the API key collection.
265
- * This allows you to add fields to the API key collection or modify the collection in any way you want.
266
- * @param collection - The API key collection.
267
- * @returns The modified API key collection.
268
- */
269
177
  overrideApiKeyCollection?: (collection: CollectionConfig) => CollectionConfig;
270
- /**
271
- * Override the authentication method.
272
- * This allows you to use a custom authentication method instead of the default API key authentication.
273
- * @param req - The request object.
274
- * @returns The MCP access settings.
275
- */
276
- overrideAuth?: (req: PayloadRequest, getDefaultMcpAccessSettings: (overrideApiKey?: null | string) => Promise<MCPAccessSettings>) => MCPAccessSettings | Promise<MCPAccessSettings>;
277
- /**
278
- * Set the users collection that API keys should be associated with.
279
- */
178
+ /** Replace the default API-key auth with a custom resolver. */
179
+ overrideAuth?: (args: {
180
+ getAPIKeyDoc: (overrideApiKey?: string) => Promise<MCPAPIKeysDoc>;
181
+ getAuthorizedMCP: (args: {
182
+ apiKeyDoc: MCPAPIKeysDoc;
183
+ }) => AuthorizedMCP;
184
+ pluginConfig: SanitizedMCPPluginConfig;
185
+ req: PayloadRequest;
186
+ }) => MaybePromise<AuthorizedMCP>;
187
+ prompts?: Record<string, Prompt>;
188
+ resources?: Record<string, Resource>;
189
+ /** Cross-cutting tools (not scoped to any collection or global). */
190
+ tools?: MCPTopLevelToolsMap;
280
191
  userCollection?: CollectionSlug;
281
192
  };
282
- /**
283
- * MCP Handler options.
284
- */
285
- export type MCPHandlerOptions = {
286
- /**
287
- * Set the base path of the MCP handler. This is the path that will be used to access the MCP handler.
288
- * @default /api
289
- */
290
- basePath?: string;
291
- /**
292
- * If true, disables the SSE endpoint. Only Streamable HTTP will be available.
293
- * @default true
294
- */
295
- disableSse?: boolean;
296
- /**
297
- * Set the maximum duration of the MCP handler. This is the maximum duration that the MCP handler will run for.
298
- * @default 60
299
- */
300
- maxDuration?: number;
301
- /**
302
- * Callback function that receives MCP events.
303
- * This can be used to track analytics, debug issues, or implement custom behaviors.
304
- */
305
- onEvent?: (event: unknown) => void;
306
- /**
307
- * Set the Redis URL for the MCP handler. This is the URL that will be used to access the Redis server.
308
- * @default process.env.REDIS_URL
309
- */
310
- redisUrl?: string;
311
- /**
312
- * Set verbose logging.
313
- * @default false
314
- */
315
- verboseLogs?: boolean;
193
+ export type SanitizedMCPPluginConfig = {
194
+ items: MCPItem[];
195
+ userCollection: CollectionSlug;
196
+ } & Pick<MCPPluginConfig, 'disabled' | 'mcp' | 'overrideApiKeyCollection' | 'overrideAuth'>;
197
+ export type MCPServerOptions = {
198
+ options?: ConstructorParameters<typeof McpServer>[1];
199
+ serverInfo?: Partial<ConstructorParameters<typeof McpServer>[0]>;
316
200
  };
317
201
  /**
318
- * MCP Server options.
202
+ * Nested access tree as stored in the collection.
203
+ * A `false` leaf disables that tool; missing keys defer to
204
+ * defaults (built-in CRUD is on, opt-in tools are off).
319
205
  */
320
- export type MCPServerOptions = {
321
- /**
322
- * Optional instructions describing how to use the server and its features.
323
- */
324
- instructions?: string;
325
- /**
326
- * Set the server info of the MCP server.
327
- */
328
- serverInfo?: {
329
- /**
330
- * Set the name of the MCP server.
331
- * @default 'Payload MCP Server'
332
- */
333
- name: string;
334
- /**
335
- * Set the version of the MCP server.
336
- * @default '1.0.0'
337
- */
338
- version: string;
339
- };
340
- };
341
- export type MCPAccessSettings = {
342
- auth?: {
343
- auth?: boolean;
344
- forgotPassword?: boolean;
345
- login?: boolean;
346
- resetPassword?: boolean;
347
- unlock?: boolean;
348
- verify?: boolean;
349
- };
206
+ export type MCPAPIKeysDocAccessTree = {
350
207
  collections?: {
351
- create?: boolean;
352
- delete?: boolean;
353
- find?: boolean;
354
- update?: boolean;
355
- };
356
- config?: {
357
- find?: boolean;
358
- update?: boolean;
208
+ [CollectionSlug: CollectionSlug]: {
209
+ [ToolKey: string]: boolean;
210
+ };
359
211
  };
360
- custom?: Record<string, boolean>;
361
212
  globals?: {
362
- find?: boolean;
363
- update?: boolean;
213
+ [GlobalSlug: GlobalSlug]: {
214
+ [ToolKey: string]: boolean;
215
+ };
364
216
  };
365
- jobs?: {
366
- create?: boolean;
367
- run?: boolean;
368
- update?: boolean;
217
+ prompts?: {
218
+ [PromptKey: string]: boolean;
369
219
  };
370
- 'payload-mcp-prompt'?: Record<string, boolean>;
371
- 'payload-mcp-resource'?: Record<string, boolean>;
372
- 'payload-mcp-tool'?: Record<string, boolean>;
373
- user: TypedUser;
374
- } & Record<string, unknown>;
375
- export type EntityConfig = MCPPluginConfig['collections'] | MCPPluginConfig['globals'];
376
- export type FieldDefinition = {
377
- description?: string;
378
- name: string;
379
- options?: {
380
- label: string;
381
- value: string;
382
- }[];
383
- position?: 'main' | 'sidebar';
384
- required?: boolean;
385
- type: string;
386
- };
387
- export type FieldModification = {
388
- changes: {
389
- description?: string;
390
- options?: {
391
- label: string;
392
- value: string;
393
- }[];
394
- position?: 'main' | 'sidebar';
395
- required?: boolean;
396
- type?: string;
220
+ resources?: {
221
+ [ResourceKey: string]: boolean;
397
222
  };
398
- fieldName: string;
399
- };
400
- export type CollectionConfigUpdates = {
401
- access?: {
402
- create?: string;
403
- delete?: string;
404
- read?: string;
405
- update?: string;
223
+ tools?: {
224
+ [ToolKey: string]: boolean;
406
225
  };
407
- description?: string;
408
- slug?: string;
409
- timestamps?: boolean;
410
- versioning?: boolean;
411
226
  };
412
- export type AdminConfig = {
413
- avatar?: string;
414
- css?: string;
415
- dateFormat?: string;
416
- inactivityRoute?: string;
417
- livePreview?: {
418
- breakpoints?: Array<{
419
- height: number;
420
- label: string;
421
- name: string;
422
- width: number;
423
- }>;
424
- };
425
- logoutRoute?: string;
426
- meta?: {
427
- favicon?: string;
428
- ogImage?: string;
429
- titleSuffix?: string;
430
- };
431
- user?: string;
432
- };
433
- export type DatabaseConfig = {
434
- connectOptions?: string;
435
- type?: 'mongodb' | 'postgres';
436
- url?: string;
227
+ /**
228
+ * Stored on `payload-mcp-api-keys` docs
229
+ */
230
+ export type MCPAPIKeysDoc = {
231
+ access: MCPAPIKeysDocAccessTree;
232
+ apiKey?: string;
233
+ apiKeyIndex?: string;
234
+ id: DefaultDocumentIDType;
235
+ lastUsed?: string;
236
+ overrideAccess?: boolean;
237
+ user: null | TypedUser;
437
238
  };
438
- export type PluginUpdates = {
439
- add?: string[];
440
- remove?: string[];
239
+ /**
240
+ * One MCP primitive plus the metadata needed for access checks, admin UI, and
241
+ * registration.
242
+ *
243
+ * - `configKey`: the config/API-key identifier, e.g. `find` or `echo`.
244
+ * - `mcpName`: the MCP wire name, e.g. `findDocuments` or `echo`.
245
+ * - `label`: human-readable admin checkbox text.
246
+ */
247
+ export type MCPItemBase = {
248
+ configKey: string;
249
+ label: string;
250
+ mcpName: string;
441
251
  };
442
- export type GeneralConfig = {
443
- cookiePrefix?: string;
444
- cors?: string;
445
- csrf?: string;
446
- graphQL?: {
447
- disable?: boolean;
448
- schemaOutputFile?: string;
449
- };
450
- rateLimit?: {
451
- max?: number;
452
- skip?: string;
453
- window?: number;
454
- };
455
- secret?: string;
456
- serverURL?: string;
457
- typescript?: {
458
- declare?: boolean;
459
- outputFile?: string;
460
- };
252
+ export type CollectionMCPItem = {
253
+ collectionSlug: CollectionSlug;
254
+ tool: CollectionTool;
255
+ type: 'collectionTool';
256
+ } & MCPItemBase;
257
+ export type GlobalMCPItem = {
258
+ globalSlug: GlobalSlug;
259
+ tool: GlobalTool;
260
+ type: 'globalTool';
261
+ } & MCPItemBase;
262
+ export type MCPItem = ({
263
+ prompt: Prompt;
264
+ type: 'prompt';
265
+ } & MCPItemBase) | ({
266
+ resource: Resource;
267
+ type: 'resource';
268
+ } & MCPItemBase) | ({
269
+ tool: Tool;
270
+ type: 'tool';
271
+ } & MCPItemBase) | CollectionMCPItem | GlobalMCPItem;
272
+ /**
273
+ * The caller's identity + the MCP items they can use for this request. Returned
274
+ * by `getAuthorizedMCP`; denied items are simply absent from `items`. Handlers
275
+ * receive this via `args.authorizedMCP` so they can spread
276
+ * `localAPIDefaults(authorizedMCP)` into every local API call.
277
+ */
278
+ export type AuthorizedMCP = {
279
+ items: MCPItem[];
280
+ overrideAccess: boolean;
281
+ user: null | TypedUser;
461
282
  };
462
- export interface SchemaField {
463
- description?: string;
464
- name: string;
465
- options?: string[];
466
- required?: boolean;
467
- type: string;
468
- }
469
- export interface TaskSequenceItem {
470
- description?: string;
471
- retries?: number;
472
- taskId: string;
473
- taskSlug: string;
474
- timeout?: number;
475
- }
476
- export interface JobConfigUpdate {
477
- description?: string;
478
- queue?: string;
479
- retries?: number;
480
- timeout?: number;
481
- }
482
283
  //# sourceMappingURL=types.d.ts.map