@payloadcms/plugin-mcp 4.0.0-internal.38b7f1d → 4.0.0-internal.5f0cd13

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 (328) hide show
  1. package/bin.js +39 -0
  2. package/dist/collection/getAccessField.d.ts +12 -0
  3. package/dist/collection/getAccessField.d.ts.map +1 -0
  4. package/dist/collection/getAccessField.js +57 -0
  5. package/dist/collection/getAccessField.js.map +1 -0
  6. package/dist/collection/index.d.ts +6 -0
  7. package/dist/collection/index.d.ts.map +1 -0
  8. package/dist/collection/index.js +59 -0
  9. package/dist/collection/index.js.map +1 -0
  10. package/dist/components/AccessField/index.client.d.ts +10 -0
  11. package/dist/components/AccessField/index.client.d.ts.map +1 -0
  12. package/dist/components/AccessField/index.client.js +305 -0
  13. package/dist/components/AccessField/index.client.js.map +1 -0
  14. package/dist/components/AccessField/index.css +93 -0
  15. package/dist/defineTool.d.ts +26 -0
  16. package/dist/defineTool.d.ts.map +1 -0
  17. package/dist/defineTool.js +37 -0
  18. package/dist/defineTool.js.map +1 -0
  19. package/dist/endpoint/access.d.ts +10 -0
  20. package/dist/endpoint/access.d.ts.map +1 -0
  21. package/dist/endpoint/access.js +106 -0
  22. package/dist/endpoint/access.js.map +1 -0
  23. package/dist/endpoint/index.d.ts +3 -0
  24. package/dist/endpoint/index.d.ts.map +1 -0
  25. package/dist/endpoint/index.js +36 -0
  26. package/dist/endpoint/index.js.map +1 -0
  27. package/dist/exports/client.d.ts +2 -0
  28. package/dist/exports/client.d.ts.map +1 -0
  29. package/dist/exports/client.js +4 -0
  30. package/dist/exports/client.js.map +1 -0
  31. package/dist/index.d.ts +4 -7
  32. package/dist/index.d.ts.map +1 -1
  33. package/dist/index.js +44 -67
  34. package/dist/index.js.map +1 -1
  35. package/dist/mcp/buildMcpServer.d.ts +19 -0
  36. package/dist/mcp/buildMcpServer.d.ts.map +1 -0
  37. package/dist/mcp/buildMcpServer.js +163 -0
  38. package/dist/mcp/buildMcpServer.js.map +1 -0
  39. package/dist/mcp/builtin/collections/authTools.d.ts +7 -0
  40. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -0
  41. package/dist/mcp/builtin/collections/authTools.js +250 -0
  42. package/dist/mcp/builtin/collections/authTools.js.map +1 -0
  43. package/dist/mcp/builtin/collections/createTool.d.ts +2 -0
  44. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -0
  45. package/dist/mcp/builtin/collections/createTool.js +87 -0
  46. package/dist/mcp/builtin/collections/createTool.js.map +1 -0
  47. package/dist/mcp/builtin/collections/deleteTool.d.ts +2 -0
  48. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -0
  49. package/dist/mcp/builtin/collections/deleteTool.js +117 -0
  50. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -0
  51. package/dist/mcp/builtin/collections/findTool.d.ts +2 -0
  52. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -0
  53. package/dist/mcp/builtin/collections/findTool.js +159 -0
  54. package/dist/mcp/builtin/collections/findTool.js.map +1 -0
  55. package/dist/mcp/builtin/collections/updateTool.d.ts +2 -0
  56. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -0
  57. package/dist/mcp/builtin/collections/updateTool.js +187 -0
  58. package/dist/mcp/builtin/collections/updateTool.js.map +1 -0
  59. package/dist/mcp/builtin/globals/findTool.d.ts +2 -0
  60. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -0
  61. package/dist/mcp/builtin/globals/findTool.js +76 -0
  62. package/dist/mcp/builtin/globals/findTool.js.map +1 -0
  63. package/dist/mcp/builtin/globals/updateTool.d.ts +2 -0
  64. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -0
  65. package/dist/mcp/builtin/globals/updateTool.js +92 -0
  66. package/dist/mcp/builtin/globals/updateTool.js.map +1 -0
  67. package/dist/mcp/builtinTools.d.ts +37 -0
  68. package/dist/mcp/builtinTools.d.ts.map +1 -0
  69. package/dist/mcp/builtinTools.js +64 -0
  70. package/dist/mcp/builtinTools.js.map +1 -0
  71. package/dist/mcp/sanitizeMCPConfig.d.ts +17 -0
  72. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -0
  73. package/dist/mcp/sanitizeMCPConfig.js +167 -0
  74. package/dist/mcp/sanitizeMCPConfig.js.map +1 -0
  75. package/dist/stdio.d.ts +8 -0
  76. package/dist/stdio.d.ts.map +1 -0
  77. package/dist/stdio.js +89 -0
  78. package/dist/stdio.js.map +1 -0
  79. package/dist/types.d.ts +262 -455
  80. package/dist/types.d.ts.map +1 -1
  81. package/dist/types.js +6 -1
  82. package/dist/types.js.map +1 -1
  83. package/dist/utils/camelCase.d.ts.map +1 -1
  84. package/dist/utils/getLogger.d.ts +10 -0
  85. package/dist/utils/getLogger.d.ts.map +1 -0
  86. package/dist/utils/getLogger.js +22 -0
  87. package/dist/utils/getLogger.js.map +1 -0
  88. package/dist/utils/getPluginConfig.d.ts +12 -0
  89. package/dist/utils/getPluginConfig.d.ts.map +1 -0
  90. package/dist/utils/getPluginConfig.js +15 -0
  91. package/dist/utils/getPluginConfig.js.map +1 -0
  92. package/dist/utils/localAPIDefaults.d.ts +20 -0
  93. package/dist/utils/localAPIDefaults.d.ts.map +1 -0
  94. package/dist/utils/localAPIDefaults.js +19 -0
  95. package/dist/utils/localAPIDefaults.js.map +1 -0
  96. package/dist/utils/resolveProjectRoot.d.ts +7 -0
  97. package/dist/utils/resolveProjectRoot.d.ts.map +1 -0
  98. package/dist/utils/resolveProjectRoot.js +15 -0
  99. package/dist/utils/resolveProjectRoot.js.map +1 -0
  100. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts +7 -0
  101. package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts.map +1 -0
  102. package/dist/utils/schemaConversion/prepareCollectionSchema.js +37 -0
  103. package/dist/utils/schemaConversion/prepareCollectionSchema.js.map +1 -0
  104. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +2 -2
  105. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +1 -1
  106. package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +1 -1
  107. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +2 -2
  108. package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +1 -1
  109. package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +1 -1
  110. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +2 -2
  111. package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +1 -1
  112. package/dist/utils/schemaConversion/simplifyRelationshipFields.js +7 -4
  113. package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +1 -1
  114. package/dist/utils/schemaConversion/transformPointFields.d.ts +2 -2
  115. package/dist/utils/schemaConversion/transformPointFields.d.ts.map +1 -1
  116. package/dist/utils/schemaConversion/transformPointFields.js +7 -1
  117. package/dist/utils/schemaConversion/transformPointFields.js.map +1 -1
  118. package/dist/utils/toStandardSchema.d.ts +5 -0
  119. package/dist/utils/toStandardSchema.d.ts.map +1 -0
  120. package/dist/utils/toStandardSchema.js +4 -0
  121. package/dist/utils/toStandardSchema.js.map +1 -0
  122. package/package.json +35 -10
  123. package/src/collection/getAccessField.ts +64 -0
  124. package/src/collection/index.ts +63 -0
  125. package/src/components/AccessField/index.client.tsx +344 -0
  126. package/src/components/AccessField/index.css +93 -0
  127. package/src/defineTool.ts +44 -0
  128. package/src/endpoint/access.ts +132 -0
  129. package/src/endpoint/index.ts +35 -0
  130. package/src/exports/client.ts +2 -0
  131. package/src/index.ts +35 -85
  132. package/src/mcp/buildMcpServer.ts +224 -0
  133. package/src/mcp/builtin/collections/authTools.ts +233 -0
  134. package/src/mcp/builtin/collections/createTool.ts +116 -0
  135. package/src/mcp/builtin/collections/deleteTool.ts +123 -0
  136. package/src/mcp/builtin/collections/findTool.ts +187 -0
  137. package/src/mcp/builtin/collections/updateTool.ts +205 -0
  138. package/src/mcp/builtin/globals/findTool.ts +96 -0
  139. package/src/mcp/builtin/globals/updateTool.ts +118 -0
  140. package/src/mcp/builtinTools.ts +84 -0
  141. package/src/mcp/sanitizeMCPConfig.ts +239 -0
  142. package/src/stdio.ts +98 -0
  143. package/src/types.ts +295 -490
  144. package/src/utils/getLogger.ts +22 -0
  145. package/src/utils/getPluginConfig.ts +24 -0
  146. package/src/utils/localAPIDefaults.ts +22 -0
  147. package/src/utils/resolveProjectRoot.ts +17 -0
  148. package/src/utils/schemaConversion/prepareCollectionSchema.ts +39 -0
  149. package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +3 -3
  150. package/src/utils/schemaConversion/sanitizeJsonSchema.ts +4 -4
  151. package/src/utils/schemaConversion/simplifyRelationshipFields.ts +11 -6
  152. package/src/utils/schemaConversion/transformPointFields.ts +6 -5
  153. package/src/utils/toStandardSchema.ts +9 -0
  154. package/dist/collections/createApiKeysCollection.d.ts +0 -7
  155. package/dist/collections/createApiKeysCollection.d.ts.map +0 -1
  156. package/dist/collections/createApiKeysCollection.js +0 -317
  157. package/dist/collections/createApiKeysCollection.js.map +0 -1
  158. package/dist/defaults.d.ts +0 -4
  159. package/dist/defaults.d.ts.map +0 -1
  160. package/dist/defaults.js +0 -5
  161. package/dist/defaults.js.map +0 -1
  162. package/dist/endpoints/mcp.d.ts +0 -4
  163. package/dist/endpoints/mcp.d.ts.map +0 -1
  164. package/dist/endpoints/mcp.js +0 -71
  165. package/dist/endpoints/mcp.js.map +0 -1
  166. package/dist/mcp/createRequest.d.ts +0 -3
  167. package/dist/mcp/createRequest.d.ts.map +0 -1
  168. package/dist/mcp/createRequest.js +0 -14
  169. package/dist/mcp/createRequest.js.map +0 -1
  170. package/dist/mcp/getMcpHandler.d.ts +0 -4
  171. package/dist/mcp/getMcpHandler.d.ts.map +0 -1
  172. package/dist/mcp/getMcpHandler.js +0 -231
  173. package/dist/mcp/getMcpHandler.js.map +0 -1
  174. package/dist/mcp/helpers/config.d.ts +0 -22
  175. package/dist/mcp/helpers/config.d.ts.map +0 -1
  176. package/dist/mcp/helpers/config.js +0 -153
  177. package/dist/mcp/helpers/config.js.map +0 -1
  178. package/dist/mcp/helpers/fields.d.ts +0 -19
  179. package/dist/mcp/helpers/fields.d.ts.map +0 -1
  180. package/dist/mcp/helpers/fields.js +0 -102
  181. package/dist/mcp/helpers/fields.js.map +0 -1
  182. package/dist/mcp/helpers/fileValidation.d.ts +0 -67
  183. package/dist/mcp/helpers/fileValidation.d.ts.map +0 -1
  184. package/dist/mcp/helpers/fileValidation.js +0 -267
  185. package/dist/mcp/helpers/fileValidation.js.map +0 -1
  186. package/dist/mcp/registerTool.d.ts +0 -6
  187. package/dist/mcp/registerTool.d.ts.map +0 -1
  188. package/dist/mcp/registerTool.js +0 -18
  189. package/dist/mcp/registerTool.js.map +0 -1
  190. package/dist/mcp/tools/auth/auth.d.ts +0 -4
  191. package/dist/mcp/tools/auth/auth.d.ts.map +0 -1
  192. package/dist/mcp/tools/auth/auth.js +0 -57
  193. package/dist/mcp/tools/auth/auth.js.map +0 -1
  194. package/dist/mcp/tools/auth/forgotPassword.d.ts +0 -4
  195. package/dist/mcp/tools/auth/forgotPassword.d.ts.map +0 -1
  196. package/dist/mcp/tools/auth/forgotPassword.js +0 -48
  197. package/dist/mcp/tools/auth/forgotPassword.js.map +0 -1
  198. package/dist/mcp/tools/auth/login.d.ts +0 -4
  199. package/dist/mcp/tools/auth/login.d.ts.map +0 -1
  200. package/dist/mcp/tools/auth/login.js +0 -51
  201. package/dist/mcp/tools/auth/login.js.map +0 -1
  202. package/dist/mcp/tools/auth/resetPassword.d.ts +0 -4
  203. package/dist/mcp/tools/auth/resetPassword.d.ts.map +0 -1
  204. package/dist/mcp/tools/auth/resetPassword.js +0 -49
  205. package/dist/mcp/tools/auth/resetPassword.js.map +0 -1
  206. package/dist/mcp/tools/auth/unlock.d.ts +0 -4
  207. package/dist/mcp/tools/auth/unlock.d.ts.map +0 -1
  208. package/dist/mcp/tools/auth/unlock.js +0 -48
  209. package/dist/mcp/tools/auth/unlock.js.map +0 -1
  210. package/dist/mcp/tools/auth/verify.d.ts +0 -4
  211. package/dist/mcp/tools/auth/verify.d.ts.map +0 -1
  212. package/dist/mcp/tools/auth/verify.js +0 -45
  213. package/dist/mcp/tools/auth/verify.js.map +0 -1
  214. package/dist/mcp/tools/collection/create.d.ts +0 -10
  215. package/dist/mcp/tools/collection/create.d.ts.map +0 -1
  216. package/dist/mcp/tools/collection/create.js +0 -139
  217. package/dist/mcp/tools/collection/create.js.map +0 -1
  218. package/dist/mcp/tools/collection/delete.d.ts +0 -10
  219. package/dist/mcp/tools/collection/delete.d.ts.map +0 -1
  220. package/dist/mcp/tools/collection/delete.js +0 -154
  221. package/dist/mcp/tools/collection/delete.js.map +0 -1
  222. package/dist/mcp/tools/collection/find.d.ts +0 -10
  223. package/dist/mcp/tools/collection/find.d.ts.map +0 -1
  224. package/dist/mcp/tools/collection/find.js +0 -165
  225. package/dist/mcp/tools/collection/find.js.map +0 -1
  226. package/dist/mcp/tools/collection/update.d.ts +0 -10
  227. package/dist/mcp/tools/collection/update.d.ts.map +0 -1
  228. package/dist/mcp/tools/collection/update.js +0 -209
  229. package/dist/mcp/tools/collection/update.js.map +0 -1
  230. package/dist/mcp/tools/config/find.d.ts +0 -10
  231. package/dist/mcp/tools/config/find.d.ts.map +0 -1
  232. package/dist/mcp/tools/config/find.js +0 -97
  233. package/dist/mcp/tools/config/find.js.map +0 -1
  234. package/dist/mcp/tools/config/update.d.ts +0 -10
  235. package/dist/mcp/tools/config/update.d.ts.map +0 -1
  236. package/dist/mcp/tools/config/update.js +0 -215
  237. package/dist/mcp/tools/config/update.js.map +0 -1
  238. package/dist/mcp/tools/global/find.d.ts +0 -5
  239. package/dist/mcp/tools/global/find.d.ts.map +0 -1
  240. package/dist/mcp/tools/global/find.js +0 -82
  241. package/dist/mcp/tools/global/find.js.map +0 -1
  242. package/dist/mcp/tools/global/update.d.ts +0 -6
  243. package/dist/mcp/tools/global/update.d.ts.map +0 -1
  244. package/dist/mcp/tools/global/update.js +0 -124
  245. package/dist/mcp/tools/global/update.js.map +0 -1
  246. package/dist/mcp/tools/job/create.d.ts +0 -10
  247. package/dist/mcp/tools/job/create.d.ts.map +0 -1
  248. package/dist/mcp/tools/job/create.js +0 -293
  249. package/dist/mcp/tools/job/create.js.map +0 -1
  250. package/dist/mcp/tools/job/run.d.ts +0 -10
  251. package/dist/mcp/tools/job/run.d.ts.map +0 -1
  252. package/dist/mcp/tools/job/run.js +0 -129
  253. package/dist/mcp/tools/job/run.js.map +0 -1
  254. package/dist/mcp/tools/job/update.d.ts +0 -11
  255. package/dist/mcp/tools/job/update.d.ts.map +0 -1
  256. package/dist/mcp/tools/job/update.js +0 -186
  257. package/dist/mcp/tools/job/update.js.map +0 -1
  258. package/dist/mcp/tools/resource/create.d.ts +0 -6
  259. package/dist/mcp/tools/resource/create.d.ts.map +0 -1
  260. package/dist/mcp/tools/resource/create.js +0 -124
  261. package/dist/mcp/tools/resource/create.js.map +0 -1
  262. package/dist/mcp/tools/resource/delete.d.ts +0 -5
  263. package/dist/mcp/tools/resource/delete.d.ts.map +0 -1
  264. package/dist/mcp/tools/resource/delete.js +0 -151
  265. package/dist/mcp/tools/resource/delete.js.map +0 -1
  266. package/dist/mcp/tools/resource/find.d.ts +0 -5
  267. package/dist/mcp/tools/resource/find.d.ts.map +0 -1
  268. package/dist/mcp/tools/resource/find.js +0 -170
  269. package/dist/mcp/tools/resource/find.js.map +0 -1
  270. package/dist/mcp/tools/resource/update.d.ts +0 -6
  271. package/dist/mcp/tools/resource/update.d.ts.map +0 -1
  272. package/dist/mcp/tools/resource/update.js +0 -256
  273. package/dist/mcp/tools/resource/update.js.map +0 -1
  274. package/dist/mcp/tools/schemas.d.ts +0 -457
  275. package/dist/mcp/tools/schemas.d.ts.map +0 -1
  276. package/dist/mcp/tools/schemas.js +0 -243
  277. package/dist/mcp/tools/schemas.js.map +0 -1
  278. package/dist/utils/adminEntitySettings.d.ts +0 -17
  279. package/dist/utils/adminEntitySettings.d.ts.map +0 -1
  280. package/dist/utils/adminEntitySettings.js +0 -41
  281. package/dist/utils/adminEntitySettings.js.map +0 -1
  282. package/dist/utils/createApiKeyFields.d.ts +0 -15
  283. package/dist/utils/createApiKeyFields.d.ts.map +0 -1
  284. package/dist/utils/createApiKeyFields.js +0 -57
  285. package/dist/utils/createApiKeyFields.js.map +0 -1
  286. package/dist/utils/getEnabledSlugs.d.ts +0 -13
  287. package/dist/utils/getEnabledSlugs.d.ts.map +0 -1
  288. package/dist/utils/getEnabledSlugs.js +0 -32
  289. package/dist/utils/getEnabledSlugs.js.map +0 -1
  290. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts +0 -3
  291. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts.map +0 -1
  292. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js +0 -43
  293. package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js.map +0 -1
  294. package/src/collections/createApiKeysCollection.ts +0 -373
  295. package/src/defaults.ts +0 -3
  296. package/src/endpoints/mcp.ts +0 -91
  297. package/src/mcp/createRequest.ts +0 -13
  298. package/src/mcp/getMcpHandler.ts +0 -545
  299. package/src/mcp/helpers/config.ts +0 -213
  300. package/src/mcp/helpers/fields.ts +0 -154
  301. package/src/mcp/helpers/fileValidation.ts +0 -362
  302. package/src/mcp/registerTool.ts +0 -22
  303. package/src/mcp/tools/auth/auth.ts +0 -71
  304. package/src/mcp/tools/auth/forgotPassword.ts +0 -70
  305. package/src/mcp/tools/auth/login.ts +0 -72
  306. package/src/mcp/tools/auth/resetPassword.ts +0 -61
  307. package/src/mcp/tools/auth/unlock.ts +0 -64
  308. package/src/mcp/tools/auth/verify.ts +0 -57
  309. package/src/mcp/tools/collection/create.ts +0 -210
  310. package/src/mcp/tools/collection/delete.ts +0 -211
  311. package/src/mcp/tools/collection/find.ts +0 -224
  312. package/src/mcp/tools/collection/update.ts +0 -290
  313. package/src/mcp/tools/config/find.ts +0 -128
  314. package/src/mcp/tools/config/update.ts +0 -280
  315. package/src/mcp/tools/global/find.ts +0 -128
  316. package/src/mcp/tools/global/update.ts +0 -207
  317. package/src/mcp/tools/job/create.ts +0 -416
  318. package/src/mcp/tools/job/run.ts +0 -167
  319. package/src/mcp/tools/job/update.ts +0 -274
  320. package/src/mcp/tools/resource/create.ts +0 -211
  321. package/src/mcp/tools/resource/delete.ts +0 -218
  322. package/src/mcp/tools/resource/find.ts +0 -246
  323. package/src/mcp/tools/resource/update.ts +0 -383
  324. package/src/mcp/tools/schemas.ts +0 -520
  325. package/src/utils/adminEntitySettings.ts +0 -40
  326. package/src/utils/createApiKeyFields.ts +0 -72
  327. package/src/utils/getEnabledSlugs.ts +0 -42
  328. package/src/utils/schemaConversion/convertCollectionSchemaToZod.ts +0 -52
@@ -0,0 +1,117 @@
1
+ import { z } from 'zod';
2
+ import { defineCollectionTool } from '../../../defineTool.js';
3
+ import { getLogger } from '../../../utils/getLogger.js';
4
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
+ const DEFAULT_DESCRIPTION = 'Delete documents in a collection by ID or where clause.';
6
+ export const deleteCollectionTool = defineCollectionTool({
7
+ description: DEFAULT_DESCRIPTION,
8
+ input: z.object({
9
+ id: z.union([
10
+ z.string(),
11
+ z.number()
12
+ ]).describe('Optional: specific document ID to delete').optional(),
13
+ depth: z.number().int().min(0).max(10).describe('Depth of population for relationships in response').optional().default(0),
14
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
15
+ locale: z.string().describe('Optional: locale code for the operation (e.g., "en", "es"). Defaults to the default locale').optional(),
16
+ where: z.string().describe('Optional: JSON string for where clause to delete multiple documents').optional()
17
+ })
18
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
19
+ const payload = req.payload;
20
+ const logger = getLogger({
21
+ payload
22
+ });
23
+ const { id, depth, fallbackLocale, locale, where } = input;
24
+ logger.info(`Deleting document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`);
25
+ try {
26
+ if (!id && !where) {
27
+ return {
28
+ content: [
29
+ {
30
+ type: 'text',
31
+ text: 'Error: Either id or where clause must be provided'
32
+ }
33
+ ]
34
+ };
35
+ }
36
+ let whereClause = {};
37
+ if (where) {
38
+ try {
39
+ whereClause = JSON.parse(where);
40
+ } catch {
41
+ logger.warn(`Invalid where clause JSON: ${where}`);
42
+ return {
43
+ content: [
44
+ {
45
+ type: 'text',
46
+ text: 'Error: Invalid JSON in where clause'
47
+ }
48
+ ]
49
+ };
50
+ }
51
+ }
52
+ const deleteOptions = {
53
+ collection: collectionSlug,
54
+ depth,
55
+ req,
56
+ ...localAPIDefaults(authorizedMCP),
57
+ ...locale && {
58
+ locale
59
+ },
60
+ ...fallbackLocale && {
61
+ fallbackLocale
62
+ }
63
+ };
64
+ if (id) {
65
+ deleteOptions.id = id;
66
+ } else {
67
+ deleteOptions.where = whereClause;
68
+ }
69
+ const result = await payload.delete(deleteOptions);
70
+ if (id) {
71
+ return {
72
+ content: [
73
+ {
74
+ type: 'text',
75
+ text: `Document deleted successfully from collection "${collectionSlug}"!\nDeleted document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
76
+ }
77
+ ],
78
+ doc: result
79
+ };
80
+ }
81
+ const bulkResult = result;
82
+ const docs = bulkResult.docs || [];
83
+ const errors = bulkResult.errors || [];
84
+ let responseText = `Document deleted successfully from collection "${collectionSlug}"!\nDeleted: ${docs.length} documents\nErrors: ${errors.length}\n---`;
85
+ if (docs.length > 0) {
86
+ responseText += `\n\nDeleted documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``;
87
+ }
88
+ if (errors.length > 0) {
89
+ responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``;
90
+ }
91
+ return {
92
+ content: [
93
+ {
94
+ type: 'text',
95
+ text: responseText
96
+ }
97
+ ],
98
+ doc: {
99
+ docs,
100
+ errors
101
+ }
102
+ };
103
+ } catch (error) {
104
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
105
+ logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`);
106
+ return {
107
+ content: [
108
+ {
109
+ type: 'text',
110
+ text: `Error deleting document from collection "${collectionSlug}": ${errorMessage}`
111
+ }
112
+ ]
113
+ };
114
+ }
115
+ });
116
+
117
+ //# sourceMappingURL=deleteTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION = 'Delete documents in a collection by ID or where clause.'\n\nexport const deleteCollectionTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z\n .union([z.string(), z.number()])\n .describe('Optional: specific document ID to delete')\n .optional(),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('Depth of population for relationships in response')\n .optional()\n .default(0),\n fallbackLocale: z\n .string()\n .describe('Optional: fallback locale code to use when requested locale is not available')\n .optional(),\n locale: z\n .string()\n .describe(\n 'Optional: locale code for the operation (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n where: z\n .string()\n .describe('Optional: JSON string for where clause to delete multiple documents')\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { id, depth, fallbackLocale, locale, where } = input\n\n logger.info(\n `Deleting document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n if (!id && !where) {\n return {\n content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n }\n }\n\n let whereClause: Record<string, unknown> = {}\n if (where) {\n try {\n whereClause = JSON.parse(where) as Record<string, unknown>\n } catch {\n logger.warn(`Invalid where clause JSON: ${where}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n }\n }\n\n const deleteOptions: Record<string, unknown> = {\n collection: collectionSlug,\n depth,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale && { locale }),\n ...(fallbackLocale && { fallbackLocale }),\n }\n\n if (id) {\n deleteOptions.id = id\n } else {\n deleteOptions.where = whereClause\n }\n\n const result = await payload.delete(deleteOptions as Parameters<typeof payload.delete>[0])\n\n if (id) {\n return {\n content: [\n {\n type: 'text',\n text: `Document deleted successfully from collection \"${collectionSlug}\"!\\nDeleted document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n }\n\n const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }\n const docs = bulkResult.docs || []\n const errors = bulkResult.errors || []\n\n let responseText = `Document deleted successfully from collection \"${collectionSlug}\"!\\nDeleted: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n if (docs.length > 0) {\n responseText += `\\n\\nDeleted documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n }\n if (errors.length > 0) {\n responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error deleting document from ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `Error deleting document from collection \"${collectionSlug}\": ${errorMessage}`,\n },\n ],\n }\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","deleteCollectionTool","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","fallbackLocale","locale","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","content","type","text","whereClause","JSON","parse","warn","deleteOptions","collection","result","delete","stringify","doc","bulkResult","docs","errors","responseText","length","error","errorMessage","Error","message"],"mappings":"AAAA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBAAsB;AAE5B,OAAO,MAAMC,uBAAuBJ,qBAAqB;IACvDK,aAAaF;IACbG,OAAOP,EAAEQ,MAAM,CAAC;QACdC,IAAIT,EACDU,KAAK,CAAC;YAACV,EAAEW,MAAM;YAAIX,EAAEY,MAAM;SAAG,EAC9BC,QAAQ,CAAC,4CACTC,QAAQ;QACXC,OAAOf,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,qDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,gBAAgBpB,EACbW,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXO,QAAQrB,EACLW,MAAM,GACNE,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,OAAOtB,EACJW,MAAM,GACNE,QAAQ,CAAC,uEACTC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAElB,KAAK,EAAEmB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS1B,UAAU;QAAEyB;IAAQ;IAEnC,MAAM,EAAElB,EAAE,EAAEM,KAAK,EAAEK,cAAc,EAAEC,MAAM,EAAEC,KAAK,EAAE,GAAGf;IAErDqB,OAAOC,IAAI,CACT,CAAC,mCAAmC,EAAEJ,iBAAiBhB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,uBAAuBY,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG9I,IAAI;QACF,IAAI,CAACZ,MAAM,CAACa,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,IAAIC,cAAuC,CAAC;QAC5C,IAAIX,OAAO;YACT,IAAI;gBACFW,cAAcC,KAAKC,KAAK,CAACb;YAC3B,EAAE,OAAM;gBACNM,OAAOQ,IAAI,CAAC,CAAC,2BAA2B,EAAEd,OAAO;gBACjD,OAAO;oBAAEQ,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,MAAMK,gBAAyC;YAC7CC,YAAYb;YACZV;YACAW;YACA,GAAGvB,iBAAiBqB,cAAc;YAClC,GAAIH,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,kBAAkB;gBAAEA;YAAe,CAAC;QAC1C;QAEA,IAAIX,IAAI;YACN4B,cAAc5B,EAAE,GAAGA;QACrB,OAAO;YACL4B,cAAcf,KAAK,GAAGW;QACxB;QAEA,MAAMM,SAAS,MAAMZ,QAAQa,MAAM,CAACH;QAEpC,IAAI5B,IAAI;YACN,OAAO;gBACLqB,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAEP,eAAe,mCAAmC,EAAES,KAAKO,SAAS,CAACF,QAAQ,QAAQ,CAAC;oBAC9I;iBACD;gBACDG,KAAKH;YACP;QACF;QAEA,MAAMI,aAAaJ;QACnB,MAAMK,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,+CAA+C,EAAErB,eAAe,aAAa,EAAEmB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACzJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEZ,KAAKO,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEZ,KAAKO,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLf,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMc;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DvB,OAAOoB,KAAK,CAAC,CAAC,6BAA6B,EAAEvB,eAAe,EAAE,EAAEwB,cAAc;QAC9E,OAAO;YACLnB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAEP,eAAe,GAAG,EAAEwB,cAAc;gBACtF;aACD;QACH;IACF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const findCollectionTool: import("../../../types.js").CollectionTool;
2
+ //# sourceMappingURL=findTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,kBAAkB,4CA+K7B,CAAA"}
@@ -0,0 +1,159 @@
1
+ import { z } from 'zod';
2
+ import { defineCollectionTool } from '../../../defineTool.js';
3
+ import { getLogger } from '../../../utils/getLogger.js';
4
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
+ const DEFAULT_DESCRIPTION = 'Find documents in a collection by ID or where clause using Find or FindByID.';
6
+ export const findCollectionTool = defineCollectionTool({
7
+ description: DEFAULT_DESCRIPTION,
8
+ input: z.object({
9
+ id: z.union([
10
+ z.string(),
11
+ z.number()
12
+ ]).describe('Optional: specific document ID to retrieve. If not provided, returns all documents').optional(),
13
+ depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships (default: 0)').optional().default(0),
14
+ draft: z.boolean().describe('Optional: whether the document should be queried from the versions table/collection or not.').optional(),
15
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
16
+ limit: z.number().int().min(1).max(100).describe('Maximum number of documents to return (default: 10, max: 100)').optional().default(10),
17
+ locale: z.string().describe('Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields').optional(),
18
+ page: z.number().int().min(1).describe('Page number for pagination (default: 1)').optional().default(1),
19
+ select: z.string().describe("Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'").optional(),
20
+ sort: z.string().describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)').optional(),
21
+ where: z.string().describe('Optional JSON string for where clause filtering (e.g., \'{"title": {"contains": "test"}}\')').optional()
22
+ })
23
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
24
+ const payload = req.payload;
25
+ const logger = getLogger({
26
+ payload
27
+ });
28
+ const { id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where } = input;
29
+ logger.info(`Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`);
30
+ try {
31
+ let whereClause = {};
32
+ if (where) {
33
+ try {
34
+ whereClause = JSON.parse(where);
35
+ } catch {
36
+ logger.warn(`Invalid where clause JSON: ${where}`);
37
+ return {
38
+ content: [
39
+ {
40
+ type: 'text',
41
+ text: 'Error: Invalid JSON in where clause'
42
+ }
43
+ ]
44
+ };
45
+ }
46
+ }
47
+ let selectClause;
48
+ if (select) {
49
+ try {
50
+ selectClause = JSON.parse(select);
51
+ } catch {
52
+ logger.warn(`Invalid select clause JSON: ${select}`);
53
+ return {
54
+ content: [
55
+ {
56
+ type: 'text',
57
+ text: 'Error: Invalid JSON in select clause'
58
+ }
59
+ ]
60
+ };
61
+ }
62
+ }
63
+ if (id) {
64
+ try {
65
+ const doc = await payload.findByID({
66
+ id,
67
+ collection: collectionSlug,
68
+ depth,
69
+ req,
70
+ ...localAPIDefaults(authorizedMCP),
71
+ ...selectClause && {
72
+ select: selectClause
73
+ },
74
+ ...locale && {
75
+ locale
76
+ },
77
+ ...fallbackLocale && {
78
+ fallbackLocale
79
+ },
80
+ ...draft !== undefined && {
81
+ draft
82
+ }
83
+ });
84
+ return {
85
+ content: [
86
+ {
87
+ type: 'text',
88
+ text: `Document from collection "${collectionSlug}":\n${JSON.stringify(doc)}`
89
+ }
90
+ ],
91
+ doc: doc
92
+ };
93
+ } catch {
94
+ logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`);
95
+ return {
96
+ content: [
97
+ {
98
+ type: 'text',
99
+ text: `Error: Document with ID "${id}" not found in collection "${collectionSlug}"`
100
+ }
101
+ ]
102
+ };
103
+ }
104
+ }
105
+ const findOptions = {
106
+ collection: collectionSlug,
107
+ depth,
108
+ limit,
109
+ page,
110
+ req,
111
+ ...localAPIDefaults(authorizedMCP),
112
+ ...selectClause && {
113
+ select: selectClause
114
+ },
115
+ ...locale && {
116
+ locale
117
+ },
118
+ ...fallbackLocale && {
119
+ fallbackLocale
120
+ },
121
+ ...draft !== undefined && {
122
+ draft
123
+ }
124
+ };
125
+ if (sort) {
126
+ findOptions.sort = sort;
127
+ }
128
+ if (Object.keys(whereClause).length > 0) {
129
+ findOptions.where = whereClause;
130
+ }
131
+ const result = await payload.find(findOptions);
132
+ let responseText = `Collection: "${collectionSlug}"\nTotal: ${result.totalDocs} documents\nPage: ${result.page} of ${result.totalPages}\n`;
133
+ for (const doc of result.docs){
134
+ responseText += `\n\`\`\`json\n${JSON.stringify(doc)}\n\`\`\``;
135
+ }
136
+ return {
137
+ content: [
138
+ {
139
+ type: 'text',
140
+ text: responseText
141
+ }
142
+ ],
143
+ doc: result
144
+ };
145
+ } catch (error) {
146
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
147
+ logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`);
148
+ return {
149
+ content: [
150
+ {
151
+ type: 'text',
152
+ text: `❌ **Error reading documents from collection "${collectionSlug}":** ${errorMessage}`
153
+ }
154
+ ]
155
+ };
156
+ }
157
+ });
158
+
159
+ //# sourceMappingURL=findTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Find documents in a collection by ID or where clause using Find or FindByID.'\n\nexport const findCollectionTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z\n .union([z.string(), z.number()])\n .describe(\n 'Optional: specific document ID to retrieve. If not provided, returns all documents',\n )\n .optional(),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships (default: 0)')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe(\n 'Optional: whether the document should be queried from the versions table/collection or not.',\n )\n .optional(),\n fallbackLocale: z\n .string()\n .describe('Optional: fallback locale code to use when requested locale is not available')\n .optional(),\n limit: z\n .number()\n .int()\n .min(1)\n .max(100)\n .describe('Maximum number of documents to return (default: 10, max: 100)')\n .optional()\n .default(10),\n locale: z\n .string()\n .describe(\n 'Optional: locale code to retrieve data in (e.g., \"en\", \"es\"). Use \"all\" to retrieve all locales for localized fields',\n )\n .optional(),\n page: z\n .number()\n .int()\n .min(1)\n .describe('Page number for pagination (default: 1)')\n .optional()\n .default(1),\n select: z\n .string()\n .describe(\n \"Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\\\"title\\\": true}'\",\n )\n .optional(),\n sort: z\n .string()\n .describe('Field to sort by (e.g., \"createdAt\", \"-updatedAt\" for descending)')\n .optional(),\n where: z\n .string()\n .describe(\n 'Optional JSON string for where clause filtering (e.g., \\'{\"title\": {\"contains\": \"test\"}}\\')',\n )\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where } = input\n\n logger.info(\n `Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n let whereClause: Record<string, unknown> = {}\n if (where) {\n try {\n whereClause = JSON.parse(where) as Record<string, unknown>\n } catch {\n logger.warn(`Invalid where clause JSON: ${where}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n }\n }\n\n let selectClause: SelectType | undefined\n if (select) {\n try {\n selectClause = JSON.parse(select) as SelectType\n } catch {\n logger.warn(`Invalid select clause JSON: ${select}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }\n }\n }\n\n if (id) {\n try {\n const doc = await payload.findByID({\n id,\n collection: collectionSlug,\n depth,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(selectClause && { select: selectClause }),\n ...(locale && { locale }),\n ...(fallbackLocale && { fallbackLocale }),\n ...(draft !== undefined && { draft }),\n })\n\n return {\n content: [\n {\n type: 'text',\n text: `Document from collection \"${collectionSlug}\":\\n${JSON.stringify(doc)}`,\n },\n ],\n doc: doc as Record<string, unknown>,\n }\n } catch {\n logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`)\n return {\n content: [\n {\n type: 'text',\n text: `Error: Document with ID \"${id}\" not found in collection \"${collectionSlug}\"`,\n },\n ],\n }\n }\n }\n\n const findOptions: Parameters<typeof payload.find>[0] = {\n collection: collectionSlug,\n depth,\n limit,\n page,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(selectClause && { select: selectClause }),\n ...(locale && { locale }),\n ...(fallbackLocale && { fallbackLocale }),\n ...(draft !== undefined && { draft }),\n }\n\n if (sort) {\n findOptions.sort = sort\n }\n if (Object.keys(whereClause).length > 0) {\n findOptions.where = whereClause as Parameters<typeof payload.find>[0]['where']\n }\n\n const result = await payload.find(findOptions)\n\n let responseText = `Collection: \"${collectionSlug}\"\\nTotal: ${result.totalDocs} documents\\nPage: ${result.page} of ${result.totalPages}\\n`\n for (const doc of result.docs) {\n responseText += `\\n\\`\\`\\`json\\n${JSON.stringify(doc)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: result as unknown as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `❌ **Error reading documents from collection \"${collectionSlug}\":** ${errorMessage}`,\n },\n ],\n }\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","findCollectionTool","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","draft","boolean","fallbackLocale","limit","locale","page","select","sort","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","whereClause","JSON","parse","warn","content","type","text","selectClause","doc","findByID","collection","undefined","stringify","findOptions","Object","keys","length","result","find","responseText","totalDocs","totalPages","docs","error","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBJ,qBAAqB;IACrDK,aAAaF;IACbG,OAAOP,EAAEQ,MAAM,CAAC;QACdC,IAAIT,EACDU,KAAK,CAAC;YAACV,EAAEW,MAAM;YAAIX,EAAEY,MAAM;SAAG,EAC9BC,QAAQ,CACP,sFAEDC,QAAQ;QACXC,OAAOf,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,+DACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOpB,EACJqB,OAAO,GACPR,QAAQ,CACP,+FAEDC,QAAQ;QACXQ,gBAAgBtB,EACbW,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,OAAOvB,EACJY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJL,QAAQ,CAAC,iEACTC,QAAQ,GACRK,OAAO,CAAC;QACXK,QAAQxB,EACLW,MAAM,GACNE,QAAQ,CACP,wHAEDC,QAAQ;QACXW,MAAMzB,EACHY,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJJ,QAAQ,CAAC,2CACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,QAAQ1B,EACLW,MAAM,GACNE,QAAQ,CACP,gHAEDC,QAAQ;QACXa,MAAM3B,EACHW,MAAM,GACNE,QAAQ,CAAC,qEACTC,QAAQ;QACXc,OAAO5B,EACJW,MAAM,GACNE,QAAQ,CACP,+FAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAExB,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAShC,UAAU;QAAE+B;IAAQ;IAEnC,MAAM,EAAExB,EAAE,EAAEM,KAAK,EAAEK,KAAK,EAAEE,cAAc,EAAEC,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,KAAK,EAAE,GAAGrB;IAEvF2B,OAAOC,IAAI,CACT,CAAC,kCAAkC,EAAEJ,iBAAiBtB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,GAAG,SAAS,EAAEc,MAAM,QAAQ,EAAEE,OAAOD,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG3J,IAAI;QACF,IAAIY,cAAuC,CAAC;QAC5C,IAAIR,OAAO;YACT,IAAI;gBACFQ,cAAcC,KAAKC,KAAK,CAACV;YAC3B,EAAE,OAAM;gBACNM,OAAOK,IAAI,CAAC,CAAC,2BAA2B,EAAEX,OAAO;gBACjD,OAAO;oBAAEY,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,IAAIC;QACJ,IAAIjB,QAAQ;YACV,IAAI;gBACFiB,eAAeN,KAAKC,KAAK,CAACZ;YAC5B,EAAE,OAAM;gBACNQ,OAAOK,IAAI,CAAC,CAAC,4BAA4B,EAAEb,QAAQ;gBACnD,OAAO;oBAAEc,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAIjC,IAAI;YACN,IAAI;gBACF,MAAMmC,MAAM,MAAMX,QAAQY,QAAQ,CAAC;oBACjCpC;oBACAqC,YAAYf;oBACZhB;oBACAiB;oBACA,GAAG7B,iBAAiB2B,cAAc;oBAClC,GAAIa,gBAAgB;wBAAEjB,QAAQiB;oBAAa,CAAC;oBAC5C,GAAInB,UAAU;wBAAEA;oBAAO,CAAC;oBACxB,GAAIF,kBAAkB;wBAAEA;oBAAe,CAAC;oBACxC,GAAIF,UAAU2B,aAAa;wBAAE3B;oBAAM,CAAC;gBACtC;gBAEA,OAAO;oBACLoB,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,0BAA0B,EAAEX,eAAe,IAAI,EAAEM,KAAKW,SAAS,CAACJ,MAAM;wBAC/E;qBACD;oBACDA,KAAKA;gBACP;YACF,EAAE,OAAM;gBACNV,OAAOK,IAAI,CAAC,CAAC,4BAA4B,EAAE9B,GAAG,gBAAgB,EAAEsB,gBAAgB;gBAChF,OAAO;oBACLS,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,yBAAyB,EAAEjC,GAAG,2BAA2B,EAAEsB,eAAe,CAAC,CAAC;wBACrF;qBACD;gBACH;YACF;QACF;QAEA,MAAMkB,cAAkD;YACtDH,YAAYf;YACZhB;YACAQ;YACAE;YACAO;YACA,GAAG7B,iBAAiB2B,cAAc;YAClC,GAAIa,gBAAgB;gBAAEjB,QAAQiB;YAAa,CAAC;YAC5C,GAAInB,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAIF,kBAAkB;gBAAEA;YAAe,CAAC;YACxC,GAAIF,UAAU2B,aAAa;gBAAE3B;YAAM,CAAC;QACtC;QAEA,IAAIO,MAAM;YACRsB,YAAYtB,IAAI,GAAGA;QACrB;QACA,IAAIuB,OAAOC,IAAI,CAACf,aAAagB,MAAM,GAAG,GAAG;YACvCH,YAAYrB,KAAK,GAAGQ;QACtB;QAEA,MAAMiB,SAAS,MAAMpB,QAAQqB,IAAI,CAACL;QAElC,IAAIM,eAAe,CAAC,aAAa,EAAExB,eAAe,UAAU,EAAEsB,OAAOG,SAAS,CAAC,kBAAkB,EAAEH,OAAO5B,IAAI,CAAC,IAAI,EAAE4B,OAAOI,UAAU,CAAC,EAAE,CAAC;QAC1I,KAAK,MAAMb,OAAOS,OAAOK,IAAI,CAAE;YAC7BH,gBAAgB,CAAC,cAAc,EAAElB,KAAKW,SAAS,CAACJ,KAAK,QAAQ,CAAC;QAChE;QAEA,OAAO;YACLJ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMa;gBAAa;aAAE;YAC/CX,KAAKS;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D5B,OAAOyB,KAAK,CAAC,CAAC,wCAAwC,EAAE5B,eAAe,EAAE,EAAE6B,cAAc;QACzF,OAAO;YACLpB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEX,eAAe,KAAK,EAAE6B,cAAc;gBAC5F;aACD;QACH;IACF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const updateCollectionTool: import("../../../types.js").CollectionTool;
2
+ //# sourceMappingURL=updateTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,oBAAoB,4CA4L/B,CAAA"}
@@ -0,0 +1,187 @@
1
+ import { z } from 'zod';
2
+ import { defineCollectionTool } from '../../../defineTool.js';
3
+ import { getLogger } from '../../../utils/getLogger.js';
4
+ import { getCollectionVirtualFieldNames, stripVirtualFields } from '../../../utils/getVirtualFieldNames.js';
5
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
6
+ import { prepareCollectionSchema } from '../../../utils/schemaConversion/prepareCollectionSchema.js';
7
+ import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
8
+ const DEFAULT_DESCRIPTION = 'Update documents in a collection by ID or where clause.';
9
+ export const updateCollectionTool = defineCollectionTool({
10
+ description: DEFAULT_DESCRIPTION,
11
+ input: ({ collectionSchema })=>{
12
+ const partialSchema = prepareCollectionSchema(collectionSchema);
13
+ // Collection updates do not require all required fields to be passed => delete .required.
14
+ //
15
+ // Local API equivalent: packages/payload/src/collections/operations/local/update.ts#BaseOptions#data:
16
+ // data: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>
17
+ delete partialSchema.required;
18
+ return z.object({
19
+ id: z.union([
20
+ z.string(),
21
+ z.number()
22
+ ]).describe('The ID of the document to update').optional(),
23
+ data: z.fromJSONSchema(partialSchema).describe('The fields to update'),
24
+ depth: z.number().describe('How many levels deep to populate relationships').optional().default(0),
25
+ draft: z.boolean().describe('Whether to update the document as a draft').optional().default(false),
26
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
27
+ filePath: z.string().describe('File path for file uploads').optional(),
28
+ locale: z.string().describe('Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
29
+ overrideLock: z.boolean().describe('Whether to override document locks').optional().default(true),
30
+ overwriteExistingFiles: z.boolean().describe('Whether to overwrite existing files').optional().default(false),
31
+ select: z.string().describe('Optional: define exactly which fields you\'d like to return in the response (JSON), e.g., \'{"title": "My Post"}\'').optional(),
32
+ where: z.string().describe('JSON string for where clause to update multiple documents').optional()
33
+ });
34
+ }
35
+ }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
36
+ const payload = req.payload;
37
+ const logger = getLogger({
38
+ payload
39
+ });
40
+ const { id, data, depth, draft, fallbackLocale, filePath, locale, overrideLock, overwriteExistingFiles, select, where } = input;
41
+ logger.info(`Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`);
42
+ try {
43
+ if (!id && !where) {
44
+ return {
45
+ content: [
46
+ {
47
+ type: 'text',
48
+ text: 'Error: Either id or where clause must be provided'
49
+ }
50
+ ]
51
+ };
52
+ }
53
+ let parsedData = transformPointDataToPayload(data);
54
+ const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
55
+ parsedData = stripVirtualFields(parsedData, virtualFieldNames);
56
+ let whereClause = {};
57
+ if (where) {
58
+ try {
59
+ whereClause = JSON.parse(where);
60
+ } catch {
61
+ logger.error(`Invalid where clause JSON: ${where}`);
62
+ return {
63
+ content: [
64
+ {
65
+ type: 'text',
66
+ text: 'Error: Invalid JSON in where clause'
67
+ }
68
+ ]
69
+ };
70
+ }
71
+ }
72
+ let selectClause;
73
+ if (select) {
74
+ try {
75
+ selectClause = JSON.parse(select);
76
+ } catch {
77
+ logger.warn(`Invalid select clause JSON: ${select}`);
78
+ return {
79
+ content: [
80
+ {
81
+ type: 'text',
82
+ text: 'Error: Invalid JSON in select clause'
83
+ }
84
+ ]
85
+ };
86
+ }
87
+ }
88
+ if (id) {
89
+ const updateOptions = {
90
+ id,
91
+ collection: collectionSlug,
92
+ data: parsedData,
93
+ depth,
94
+ draft,
95
+ overrideLock,
96
+ req,
97
+ ...localAPIDefaults(authorizedMCP),
98
+ ...filePath ? {
99
+ filePath
100
+ } : {},
101
+ ...overwriteExistingFiles ? {
102
+ overwriteExistingFiles
103
+ } : {},
104
+ ...locale ? {
105
+ locale
106
+ } : {},
107
+ ...fallbackLocale ? {
108
+ fallbackLocale
109
+ } : {},
110
+ ...selectClause ? {
111
+ select: selectClause
112
+ } : {}
113
+ };
114
+ const result = await payload.update(updateOptions);
115
+ return {
116
+ content: [
117
+ {
118
+ type: 'text',
119
+ text: `Document updated successfully in collection "${collectionSlug}"!\nUpdated document:\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
120
+ }
121
+ ],
122
+ doc: result
123
+ };
124
+ }
125
+ const updateOptions = {
126
+ collection: collectionSlug,
127
+ data: parsedData,
128
+ depth,
129
+ draft,
130
+ overrideLock,
131
+ req,
132
+ ...localAPIDefaults(authorizedMCP),
133
+ where: whereClause,
134
+ ...filePath ? {
135
+ filePath
136
+ } : {},
137
+ ...overwriteExistingFiles ? {
138
+ overwriteExistingFiles
139
+ } : {},
140
+ ...locale ? {
141
+ locale
142
+ } : {},
143
+ ...fallbackLocale ? {
144
+ fallbackLocale
145
+ } : {},
146
+ ...selectClause ? {
147
+ select: selectClause
148
+ } : {}
149
+ };
150
+ const result = await payload.update(updateOptions);
151
+ const bulkResult = result;
152
+ const docs = bulkResult.docs || [];
153
+ const errors = bulkResult.errors || [];
154
+ let responseText = `Multiple documents updated in collection "${collectionSlug}"!\nUpdated: ${docs.length} documents\nErrors: ${errors.length}\n---`;
155
+ if (docs.length > 0) {
156
+ responseText += `\n\nUpdated documents:\n\`\`\`json\n${JSON.stringify(docs)}\n\`\`\``;
157
+ }
158
+ if (errors.length > 0) {
159
+ responseText += `\n\nErrors:\n\`\`\`json\n${JSON.stringify(errors)}\n\`\`\``;
160
+ }
161
+ return {
162
+ content: [
163
+ {
164
+ type: 'text',
165
+ text: responseText
166
+ }
167
+ ],
168
+ doc: {
169
+ docs,
170
+ errors
171
+ }
172
+ };
173
+ } catch (error) {
174
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
175
+ logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`);
176
+ return {
177
+ content: [
178
+ {
179
+ type: 'text',
180
+ text: `Error updating document in collection "${collectionSlug}": ${errorMessage}`
181
+ }
182
+ ]
183
+ };
184
+ }
185
+ });
186
+
187
+ //# sourceMappingURL=updateTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\nimport { prepareCollectionSchema } from '../../../utils/schemaConversion/prepareCollectionSchema.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\n\nconst DEFAULT_DESCRIPTION = 'Update documents in a collection by ID or where clause.'\n\nexport const updateCollectionTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: ({ collectionSchema }) => {\n const partialSchema = prepareCollectionSchema(collectionSchema)\n\n // Collection updates do not require all required fields to be passed => delete .required.\n //\n // Local API equivalent: packages/payload/src/collections/operations/local/update.ts#BaseOptions#data:\n // data: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>\n delete partialSchema.required\n\n return z.object({\n id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),\n data: z\n .fromJSONSchema(partialSchema as unknown as z.core.JSONSchema.JSONSchema)\n .describe('The fields to update'),\n depth: z\n .number()\n .describe('How many levels deep to populate relationships')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to update the document as a draft')\n .optional()\n .default(false),\n fallbackLocale: z\n .string()\n .describe('Optional: fallback locale code to use when requested locale is not available')\n .optional(),\n filePath: z.string().describe('File path for file uploads').optional(),\n locale: z\n .string()\n .describe(\n 'Optional: locale code to update the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n overrideLock: z\n .boolean()\n .describe('Whether to override document locks')\n .optional()\n .default(true),\n overwriteExistingFiles: z\n .boolean()\n .describe('Whether to overwrite existing files')\n .optional()\n .default(false),\n select: z\n .string()\n .describe(\n 'Optional: define exactly which fields you\\'d like to return in the response (JSON), e.g., \\'{\"title\": \"My Post\"}\\'',\n )\n .optional(),\n where: z\n .string()\n .describe('JSON string for where clause to update multiple documents')\n .optional(),\n })\n },\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const {\n id,\n data,\n depth,\n draft,\n fallbackLocale,\n filePath,\n locale,\n overrideLock,\n overwriteExistingFiles,\n select,\n where,\n } = input\n\n logger.info(\n `Updating document in collection: ${collectionSlug}${id ? ` with ID: ${id}` : ' with where clause'}, draft: ${draft}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n if (!id && !where) {\n return {\n content: [{ type: 'text', text: 'Error: Either id or where clause must be provided' }],\n }\n }\n\n let parsedData = transformPointDataToPayload(data as Record<string, unknown>)\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n parsedData = stripVirtualFields(parsedData, virtualFieldNames)\n\n let whereClause: Record<string, unknown> = {}\n if (where) {\n try {\n whereClause = JSON.parse(where) as Record<string, unknown>\n } catch {\n logger.error(`Invalid where clause JSON: ${where}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in where clause' }] }\n }\n }\n\n let selectClause: SelectType | undefined\n if (select) {\n try {\n selectClause = JSON.parse(select) as SelectType\n } catch {\n logger.warn(`Invalid select clause JSON: ${select}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }\n }\n }\n\n if (id) {\n const updateOptions = {\n id,\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(selectClause ? { select: selectClause } : {}),\n }\n\n const result = await payload.update(updateOptions as any)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document updated successfully in collection \"${collectionSlug}\"!\\nUpdated document:\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n }\n\n const updateOptions = {\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n ...localAPIDefaults(authorizedMCP),\n where: whereClause,\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(selectClause ? { select: selectClause } : {}),\n }\n\n const result = await payload.update(updateOptions as any)\n\n const bulkResult = result as { docs?: unknown[]; errors?: unknown[] }\n const docs = bulkResult.docs || []\n const errors = bulkResult.errors || []\n\n let responseText = `Multiple documents updated in collection \"${collectionSlug}\"!\\nUpdated: ${docs.length} documents\\nErrors: ${errors.length}\\n---`\n if (docs.length > 0) {\n responseText += `\\n\\nUpdated documents:\\n\\`\\`\\`json\\n${JSON.stringify(docs)}\\n\\`\\`\\``\n }\n if (errors.length > 0) {\n responseText += `\\n\\nErrors:\\n\\`\\`\\`json\\n${JSON.stringify(errors)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error updating document in ${collectionSlug}: ${errorMessage}`)\n return {\n content: [\n {\n type: 'text',\n text: `Error updating document in collection \"${collectionSlug}\": ${errorMessage}`,\n },\n ],\n }\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","prepareCollectionSchema","transformPointDataToPayload","DEFAULT_DESCRIPTION","updateCollectionTool","description","input","collectionSchema","partialSchema","required","object","id","union","string","number","describe","optional","data","fromJSONSchema","depth","default","draft","boolean","fallbackLocale","filePath","locale","overrideLock","overwriteExistingFiles","select","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","content","type","text","parsedData","virtualFieldNames","config","whereClause","JSON","parse","error","selectClause","warn","updateOptions","collection","result","update","stringify","doc","bulkResult","docs","errors","responseText","length","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,gBAAgB,QAAQ,qCAAoC;AACrE,SAASC,uBAAuB,QAAQ,6DAA4D;AACpG,SAASC,2BAA2B,QAAQ,gDAA+C;AAE3F,MAAMC,sBAAsB;AAE5B,OAAO,MAAMC,uBAAuBR,qBAAqB;IACvDS,aAAaF;IACbG,OAAO,CAAC,EAAEC,gBAAgB,EAAE;QAC1B,MAAMC,gBAAgBP,wBAAwBM;QAE9C,0FAA0F;QAC1F,EAAE;QACF,sGAAsG;QACtG,2DAA2D;QAC3D,OAAOC,cAAcC,QAAQ;QAE7B,OAAOd,EAAEe,MAAM,CAAC;YACdC,IAAIhB,EAAEiB,KAAK,CAAC;gBAACjB,EAAEkB,MAAM;gBAAIlB,EAAEmB,MAAM;aAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;YAC3FC,MAAMtB,EACHuB,cAAc,CAACV,eACfO,QAAQ,CAAC;YACZI,OAAOxB,EACJmB,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRI,OAAO,CAAC;YACXC,OAAO1B,EACJ2B,OAAO,GACPP,QAAQ,CAAC,6CACTC,QAAQ,GACRI,OAAO,CAAC;YACXG,gBAAgB5B,EACbkB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;YACXQ,UAAU7B,EAAEkB,MAAM,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;YACpES,QAAQ9B,EACLkB,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;YACXU,cAAc/B,EACX2B,OAAO,GACPP,QAAQ,CAAC,sCACTC,QAAQ,GACRI,OAAO,CAAC;YACXO,wBAAwBhC,EACrB2B,OAAO,GACPP,QAAQ,CAAC,uCACTC,QAAQ,GACRI,OAAO,CAAC;YACXQ,QAAQjC,EACLkB,MAAM,GACNE,QAAQ,CACP,sHAEDC,QAAQ;YACXa,OAAOlC,EACJkB,MAAM,GACNE,QAAQ,CAAC,6DACTC,QAAQ;QACb;IACF;AACF,GAAGc,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAE1B,KAAK,EAAE2B,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAStC,UAAU;QAAEqC;IAAQ;IAEnC,MAAM,EACJvB,EAAE,EACFM,IAAI,EACJE,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,MAAM,EACNC,KAAK,EACN,GAAGvB;IAEJ6B,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEJ,iBAAiBrB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEU,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACd,MAAM,CAACkB,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,IAAIC,aAAatC,4BAA4Be;QAC7C,MAAMwB,oBAAoB3C,+BAA+BoC,QAAQQ,MAAM,EAAEV;QACzEQ,aAAazC,mBAAmByC,YAAYC;QAE5C,IAAIE,cAAuC,CAAC;QAC5C,IAAId,OAAO;YACT,IAAI;gBACFc,cAAcC,KAAKC,KAAK,CAAChB;YAC3B,EAAE,OAAM;gBACNM,OAAOW,KAAK,CAAC,CAAC,2BAA2B,EAAEjB,OAAO;gBAClD,OAAO;oBAAEQ,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAsC;qBAAE;gBAAC;YACpF;QACF;QAEA,IAAIQ;QACJ,IAAInB,QAAQ;YACV,IAAI;gBACFmB,eAAeH,KAAKC,KAAK,CAACjB;YAC5B,EAAE,OAAM;gBACNO,OAAOa,IAAI,CAAC,CAAC,4BAA4B,EAAEpB,QAAQ;gBACnD,OAAO;oBAAES,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAI5B,IAAI;YACN,MAAMsC,gBAAgB;gBACpBtC;gBACAuC,YAAYlB;gBACZf,MAAMuB;gBACNrB;gBACAE;gBACAK;gBACAO;gBACA,GAAGjC,iBAAiB+B,cAAc;gBAClC,GAAIP,WAAW;oBAAEA;gBAAS,IAAI,CAAC,CAAC;gBAChC,GAAIG,yBAAyB;oBAAEA;gBAAuB,IAAI,CAAC,CAAC;gBAC5D,GAAIF,SAAS;oBAAEA;gBAAO,IAAI,CAAC,CAAC;gBAC5B,GAAIF,iBAAiB;oBAAEA;gBAAe,IAAI,CAAC,CAAC;gBAC5C,GAAIwB,eAAe;oBAAEnB,QAAQmB;gBAAa,IAAI,CAAC,CAAC;YAClD;YAEA,MAAMI,SAAS,MAAMjB,QAAQkB,MAAM,CAACH;YAEpC,OAAO;gBACLZ,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEP,eAAe,mCAAmC,EAAEY,KAAKS,SAAS,CAACF,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDG,KAAKH;YACP;QACF;QAEA,MAAMF,gBAAgB;YACpBC,YAAYlB;YACZf,MAAMuB;YACNrB;YACAE;YACAK;YACAO;YACA,GAAGjC,iBAAiB+B,cAAc;YAClCF,OAAOc;YACP,GAAInB,WAAW;gBAAEA;YAAS,IAAI,CAAC,CAAC;YAChC,GAAIG,yBAAyB;gBAAEA;YAAuB,IAAI,CAAC,CAAC;YAC5D,GAAIF,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIwB,eAAe;gBAAEnB,QAAQmB;YAAa,IAAI,CAAC,CAAC;QAClD;QAEA,MAAMI,SAAS,MAAMjB,QAAQkB,MAAM,CAACH;QAEpC,MAAMM,aAAaJ;QACnB,MAAMK,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,0CAA0C,EAAE1B,eAAe,aAAa,EAAEwB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACpJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEd,KAAKS,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEd,KAAKS,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLpB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMmB;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOX,OAAO;QACd,MAAMc,eAAed,iBAAiBe,QAAQf,MAAMgB,OAAO,GAAG;QAC9D3B,OAAOW,KAAK,CAAC,CAAC,2BAA2B,EAAEd,eAAe,EAAE,EAAE4B,cAAc;QAC5E,OAAO;YACLvB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,uCAAuC,EAAEP,eAAe,GAAG,EAAE4B,cAAc;gBACpF;aACD;QACH;IACF;AACF,GAAE"}
@@ -0,0 +1,2 @@
1
+ export declare const findGlobalTool: import("../../../types.js").GlobalTool;
2
+ //# sourceMappingURL=findTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,cAAc,wCAqFzB,CAAA"}
@@ -0,0 +1,76 @@
1
+ import { z } from 'zod';
2
+ import { defineGlobalTool } from '../../../defineTool.js';
3
+ import { getLogger } from '../../../utils/getLogger.js';
4
+ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
+ const DEFAULT_DESCRIPTION = 'Find a Payload global singleton configuration.';
6
+ export const findGlobalTool = defineGlobalTool({
7
+ description: DEFAULT_DESCRIPTION,
8
+ input: z.object({
9
+ depth: z.number().int().min(0).max(10).describe('Depth of population for relationships').optional().default(0),
10
+ fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
11
+ locale: z.string().describe('Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields').optional(),
12
+ select: z.string().describe("Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'").optional()
13
+ })
14
+ }).handler(async ({ authorizedMCP, globalSlug, input, req })=>{
15
+ const payload = req.payload;
16
+ const logger = getLogger({
17
+ payload
18
+ });
19
+ const { depth, fallbackLocale, locale, select } = input;
20
+ logger.info(`Reading global: ${globalSlug}, depth: ${depth}${locale ? `, locale: ${locale}` : ''}`);
21
+ try {
22
+ const findOptions = {
23
+ slug: globalSlug,
24
+ depth,
25
+ ...localAPIDefaults(authorizedMCP)
26
+ };
27
+ let selectClause;
28
+ if (select) {
29
+ try {
30
+ selectClause = JSON.parse(select);
31
+ } catch {
32
+ logger.warn(`Invalid select clause JSON for global: ${select}`);
33
+ return {
34
+ content: [
35
+ {
36
+ type: 'text',
37
+ text: 'Error: Invalid JSON in select clause'
38
+ }
39
+ ]
40
+ };
41
+ }
42
+ }
43
+ if (locale) {
44
+ findOptions.locale = locale;
45
+ }
46
+ if (fallbackLocale) {
47
+ findOptions.fallbackLocale = fallbackLocale;
48
+ }
49
+ if (selectClause) {
50
+ findOptions.select = selectClause;
51
+ }
52
+ const result = await payload.findGlobal(findOptions);
53
+ return {
54
+ content: [
55
+ {
56
+ type: 'text',
57
+ text: `Global "${globalSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``
58
+ }
59
+ ],
60
+ doc: result
61
+ };
62
+ } catch (error) {
63
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error';
64
+ logger.error(`Error reading global ${globalSlug}: ${errorMessage}`);
65
+ return {
66
+ content: [
67
+ {
68
+ type: 'text',
69
+ text: `❌ **Error reading global "${globalSlug}":** ${errorMessage}`
70
+ }
71
+ ]
72
+ };
73
+ }
74
+ });
75
+
76
+ //# sourceMappingURL=findTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"sourcesContent":["import type { SelectType } from 'payload'\n\nimport { z } from 'zod'\n\nimport { defineGlobalTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport { localAPIDefaults } from '../../../utils/localAPIDefaults.js'\n\nconst DEFAULT_DESCRIPTION = 'Find a Payload global singleton configuration.'\n\nexport const findGlobalTool = defineGlobalTool({\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('Depth of population for relationships')\n .optional()\n .default(0),\n fallbackLocale: z\n .string()\n .describe('Optional: fallback locale code to use when requested locale is not available')\n .optional(),\n locale: z\n .string()\n .describe(\n 'Optional: locale code to retrieve data in (e.g., \"en\", \"es\"). Use \"all\" to retrieve all locales for localized fields',\n )\n .optional(),\n select: z\n .string()\n .describe(\n \"Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\\\"title\\\": true}'\",\n )\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, globalSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { depth, fallbackLocale, locale, select } = input\n\n logger.info(\n `Reading global: ${globalSlug}, depth: ${depth}${locale ? `, locale: ${locale}` : ''}`,\n )\n\n try {\n const findOptions: Parameters<typeof payload.findGlobal>[0] = {\n slug: globalSlug,\n depth,\n ...localAPIDefaults(authorizedMCP),\n }\n\n let selectClause: SelectType | undefined\n if (select) {\n try {\n selectClause = JSON.parse(select) as SelectType\n } catch {\n logger.warn(`Invalid select clause JSON for global: ${select}`)\n return { content: [{ type: 'text', text: 'Error: Invalid JSON in select clause' }] }\n }\n }\n\n if (locale) {\n findOptions.locale = locale\n }\n if (fallbackLocale) {\n findOptions.fallbackLocale = fallbackLocale\n }\n if (selectClause) {\n findOptions.select = selectClause\n }\n\n const result = await payload.findGlobal(findOptions)\n\n return {\n content: [\n {\n type: 'text',\n text: `Global \"${globalSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(result)}\\n\\`\\`\\``,\n },\n ],\n doc: result as Record<string, unknown>,\n }\n } catch (error) {\n const errorMessage = error instanceof Error ? error.message : 'Unknown error'\n logger.error(`Error reading global ${globalSlug}: ${errorMessage}`)\n return {\n content: [\n { type: 'text', text: `❌ **Error reading global \"${globalSlug}\":** ${errorMessage}` },\n ],\n }\n }\n})\n"],"names":["z","defineGlobalTool","getLogger","localAPIDefaults","DEFAULT_DESCRIPTION","findGlobalTool","description","input","object","depth","number","int","min","max","describe","optional","default","fallbackLocale","string","locale","select","handler","authorizedMCP","globalSlug","req","payload","logger","info","findOptions","slug","selectClause","JSON","parse","warn","content","type","text","result","findGlobal","stringify","doc","error","errorMessage","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,gBAAgB,QAAQ,yBAAwB;AACzD,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SAASC,gBAAgB,QAAQ,qCAAoC;AAErE,MAAMC,sBAAsB;AAE5B,OAAO,MAAMC,iBAAiBJ,iBAAiB;IAC7CK,aAAaF;IACbG,OAAOP,EAAEQ,MAAM,CAAC;QACdC,OAAOT,EACJU,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,yCACTC,QAAQ,GACRC,OAAO,CAAC;QACXC,gBAAgBjB,EACbkB,MAAM,GACNJ,QAAQ,CAAC,gFACTC,QAAQ;QACXI,QAAQnB,EACLkB,MAAM,GACNJ,QAAQ,CACP,wHAEDC,QAAQ;QACXK,QAAQpB,EACLkB,MAAM,GACNJ,QAAQ,CACP,gHAEDC,QAAQ;IACb;AACF,GAAGM,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,UAAU,EAAEhB,KAAK,EAAEiB,GAAG,EAAE;IACzD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASxB,UAAU;QAAEuB;IAAQ;IAEnC,MAAM,EAAEhB,KAAK,EAAEQ,cAAc,EAAEE,MAAM,EAAEC,MAAM,EAAE,GAAGb;IAElDmB,OAAOC,IAAI,CACT,CAAC,gBAAgB,EAAEJ,WAAW,SAAS,EAAEd,QAAQU,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAGxF,IAAI;QACF,MAAMS,cAAwD;YAC5DC,MAAMN;YACNd;YACA,GAAGN,iBAAiBmB,cAAc;QACpC;QAEA,IAAIQ;QACJ,IAAIV,QAAQ;YACV,IAAI;gBACFU,eAAeC,KAAKC,KAAK,CAACZ;YAC5B,EAAE,OAAM;gBACNM,OAAOO,IAAI,CAAC,CAAC,uCAAuC,EAAEb,QAAQ;gBAC9D,OAAO;oBAAEc,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAIjB,QAAQ;YACVS,YAAYT,MAAM,GAAGA;QACvB;QACA,IAAIF,gBAAgB;YAClBW,YAAYX,cAAc,GAAGA;QAC/B;QACA,IAAIa,cAAc;YAChBF,YAAYR,MAAM,GAAGU;QACvB;QAEA,MAAMO,SAAS,MAAMZ,QAAQa,UAAU,CAACV;QAExC,OAAO;YACLM,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,QAAQ,EAAEb,WAAW,gBAAgB,EAAEQ,KAAKQ,SAAS,CAACF,QAAQ,QAAQ,CAAC;gBAChF;aACD;YACDG,KAAKH;QACP;IACF,EAAE,OAAOI,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DlB,OAAOe,KAAK,CAAC,CAAC,qBAAqB,EAAElB,WAAW,EAAE,EAAEmB,cAAc;QAClE,OAAO;YACLR,SAAS;gBACP;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,0BAA0B,EAAEb,WAAW,KAAK,EAAEmB,cAAc;gBAAC;aACrF;QACH;IACF;AACF,GAAE"}