@payloadcms/plugin-mcp 4.0.0-canary.2 → 4.0.0-internal.011fd46

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 (209) hide show
  1. package/dist/components/APIKeyField/index.client.d.ts.map +1 -1
  2. package/dist/components/APIKeyField/index.client.js.map +1 -1
  3. package/dist/components/APIKeysEmptyState/index.client.d.ts.map +1 -1
  4. package/dist/components/APIKeysEmptyState/index.client.js.map +1 -1
  5. package/dist/components/AccessField/index.client.d.ts.map +1 -1
  6. package/dist/components/AccessField/index.client.js.map +1 -1
  7. package/dist/components/SettingsMenu/index.client.d.ts.map +1 -1
  8. package/dist/components/SettingsMenu/index.client.js +8 -13
  9. package/dist/components/SettingsMenu/index.client.js.map +1 -1
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +6 -1
  12. package/dist/index.js.map +1 -1
  13. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  14. package/dist/mcp/buildMcpServer.js +2 -0
  15. package/dist/mcp/buildMcpServer.js.map +1 -1
  16. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  17. package/dist/mcp/builtin/collections/authTools.js +44 -6
  18. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  19. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  20. package/dist/mcp/builtin/collections/createTool.js +10 -19
  21. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  22. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  23. package/dist/mcp/builtin/collections/deleteTool.js +7 -0
  24. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  25. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  26. package/dist/mcp/builtin/collections/findTool.js +41 -22
  27. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  28. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  29. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +7 -0
  30. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  31. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/updateTool.js +12 -21
  33. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  34. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  35. package/dist/mcp/builtin/getConfigInfoTool.js +7 -0
  36. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  37. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  38. package/dist/mcp/builtin/globals/findTool.js +15 -20
  39. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  40. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  41. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +7 -0
  42. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  43. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  44. package/dist/mcp/builtin/globals/updateTool.js +10 -19
  45. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  46. package/dist/mcp/builtinTools.d.ts +2 -10
  47. package/dist/mcp/builtinTools.d.ts.map +1 -1
  48. package/dist/mcp/builtinTools.js +2 -10
  49. package/dist/mcp/builtinTools.js.map +1 -1
  50. package/dist/mcp/sanitizeMCPConfig.js +24 -10
  51. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  52. package/dist/translations/index.d.ts.map +1 -1
  53. package/dist/translations/index.js.map +1 -1
  54. package/dist/translations/languages/ar.d.ts.map +1 -1
  55. package/dist/translations/languages/ar.js.map +1 -1
  56. package/dist/translations/languages/az.d.ts.map +1 -1
  57. package/dist/translations/languages/az.js.map +1 -1
  58. package/dist/translations/languages/bg.d.ts.map +1 -1
  59. package/dist/translations/languages/bg.js.map +1 -1
  60. package/dist/translations/languages/bnBd.d.ts.map +1 -1
  61. package/dist/translations/languages/bnBd.js.map +1 -1
  62. package/dist/translations/languages/bnIn.d.ts.map +1 -1
  63. package/dist/translations/languages/bnIn.js.map +1 -1
  64. package/dist/translations/languages/ca.d.ts.map +1 -1
  65. package/dist/translations/languages/ca.js.map +1 -1
  66. package/dist/translations/languages/cs.d.ts.map +1 -1
  67. package/dist/translations/languages/cs.js.map +1 -1
  68. package/dist/translations/languages/da.d.ts.map +1 -1
  69. package/dist/translations/languages/da.js.map +1 -1
  70. package/dist/translations/languages/de.d.ts.map +1 -1
  71. package/dist/translations/languages/de.js.map +1 -1
  72. package/dist/translations/languages/en.d.ts.map +1 -1
  73. package/dist/translations/languages/en.js.map +1 -1
  74. package/dist/translations/languages/es.d.ts.map +1 -1
  75. package/dist/translations/languages/es.js.map +1 -1
  76. package/dist/translations/languages/et.d.ts.map +1 -1
  77. package/dist/translations/languages/et.js.map +1 -1
  78. package/dist/translations/languages/fa.d.ts.map +1 -1
  79. package/dist/translations/languages/fa.js.map +1 -1
  80. package/dist/translations/languages/fr.d.ts.map +1 -1
  81. package/dist/translations/languages/fr.js.map +1 -1
  82. package/dist/translations/languages/he.d.ts.map +1 -1
  83. package/dist/translations/languages/he.js.map +1 -1
  84. package/dist/translations/languages/hr.d.ts.map +1 -1
  85. package/dist/translations/languages/hr.js.map +1 -1
  86. package/dist/translations/languages/hu.d.ts.map +1 -1
  87. package/dist/translations/languages/hu.js.map +1 -1
  88. package/dist/translations/languages/hy.d.ts.map +1 -1
  89. package/dist/translations/languages/hy.js.map +1 -1
  90. package/dist/translations/languages/id.d.ts.map +1 -1
  91. package/dist/translations/languages/id.js.map +1 -1
  92. package/dist/translations/languages/is.d.ts.map +1 -1
  93. package/dist/translations/languages/is.js.map +1 -1
  94. package/dist/translations/languages/it.d.ts.map +1 -1
  95. package/dist/translations/languages/it.js.map +1 -1
  96. package/dist/translations/languages/ja.d.ts.map +1 -1
  97. package/dist/translations/languages/ja.js.map +1 -1
  98. package/dist/translations/languages/ko.d.ts.map +1 -1
  99. package/dist/translations/languages/ko.js.map +1 -1
  100. package/dist/translations/languages/lt.d.ts.map +1 -1
  101. package/dist/translations/languages/lt.js.map +1 -1
  102. package/dist/translations/languages/lv.d.ts.map +1 -1
  103. package/dist/translations/languages/lv.js.map +1 -1
  104. package/dist/translations/languages/my.d.ts.map +1 -1
  105. package/dist/translations/languages/my.js.map +1 -1
  106. package/dist/translations/languages/nb.d.ts.map +1 -1
  107. package/dist/translations/languages/nb.js.map +1 -1
  108. package/dist/translations/languages/nl.d.ts.map +1 -1
  109. package/dist/translations/languages/nl.js.map +1 -1
  110. package/dist/translations/languages/pl.d.ts.map +1 -1
  111. package/dist/translations/languages/pl.js.map +1 -1
  112. package/dist/translations/languages/pt.d.ts.map +1 -1
  113. package/dist/translations/languages/pt.js.map +1 -1
  114. package/dist/translations/languages/ro.d.ts.map +1 -1
  115. package/dist/translations/languages/ro.js.map +1 -1
  116. package/dist/translations/languages/rs.d.ts.map +1 -1
  117. package/dist/translations/languages/rs.js.map +1 -1
  118. package/dist/translations/languages/rsLatin.d.ts.map +1 -1
  119. package/dist/translations/languages/rsLatin.js.map +1 -1
  120. package/dist/translations/languages/ru.d.ts.map +1 -1
  121. package/dist/translations/languages/ru.js.map +1 -1
  122. package/dist/translations/languages/sk.d.ts.map +1 -1
  123. package/dist/translations/languages/sk.js.map +1 -1
  124. package/dist/translations/languages/sl.d.ts.map +1 -1
  125. package/dist/translations/languages/sl.js.map +1 -1
  126. package/dist/translations/languages/sv.d.ts.map +1 -1
  127. package/dist/translations/languages/sv.js.map +1 -1
  128. package/dist/translations/languages/ta.d.ts.map +1 -1
  129. package/dist/translations/languages/ta.js.map +1 -1
  130. package/dist/translations/languages/th.d.ts.map +1 -1
  131. package/dist/translations/languages/th.js.map +1 -1
  132. package/dist/translations/languages/tr.d.ts.map +1 -1
  133. package/dist/translations/languages/tr.js.map +1 -1
  134. package/dist/translations/languages/uk.d.ts.map +1 -1
  135. package/dist/translations/languages/uk.js.map +1 -1
  136. package/dist/translations/languages/vi.d.ts.map +1 -1
  137. package/dist/translations/languages/vi.js.map +1 -1
  138. package/dist/translations/languages/zh.d.ts.map +1 -1
  139. package/dist/translations/languages/zh.js.map +1 -1
  140. package/dist/translations/languages/zhTw.d.ts.map +1 -1
  141. package/dist/translations/languages/zhTw.js.map +1 -1
  142. package/dist/types.d.ts +7 -5
  143. package/dist/types.d.ts.map +1 -1
  144. package/dist/types.js.map +1 -1
  145. package/package.json +7 -7
  146. package/src/components/APIKeyField/index.client.tsx +2 -7
  147. package/src/components/APIKeysEmptyState/index.client.tsx +1 -4
  148. package/src/components/AccessField/index.client.tsx +1 -4
  149. package/src/components/SettingsMenu/index.client.tsx +1 -5
  150. package/src/index.ts +4 -1
  151. package/src/mcp/buildMcpServer.ts +2 -0
  152. package/src/mcp/builtin/collections/authTools.ts +45 -9
  153. package/src/mcp/builtin/collections/createTool.ts +10 -13
  154. package/src/mcp/builtin/collections/deleteTool.ts +7 -0
  155. package/src/mcp/builtin/collections/findTool.ts +53 -16
  156. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +7 -0
  157. package/src/mcp/builtin/collections/updateTool.ts +11 -14
  158. package/src/mcp/builtin/getConfigInfoTool.ts +7 -0
  159. package/src/mcp/builtin/globals/findTool.ts +22 -16
  160. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +7 -0
  161. package/src/mcp/builtin/globals/updateTool.ts +11 -14
  162. package/src/mcp/builtinTools.ts +9 -12
  163. package/src/mcp/sanitizeMCPConfig.ts +15 -11
  164. package/src/translations/index.ts +1 -4
  165. package/src/translations/languages/ar.ts +6 -3
  166. package/src/translations/languages/az.ts +6 -3
  167. package/src/translations/languages/bg.ts +8 -4
  168. package/src/translations/languages/bnBd.ts +8 -4
  169. package/src/translations/languages/bnIn.ts +8 -4
  170. package/src/translations/languages/ca.ts +8 -4
  171. package/src/translations/languages/cs.ts +8 -4
  172. package/src/translations/languages/da.ts +6 -3
  173. package/src/translations/languages/de.ts +8 -4
  174. package/src/translations/languages/en.ts +8 -4
  175. package/src/translations/languages/es.ts +8 -4
  176. package/src/translations/languages/et.ts +6 -3
  177. package/src/translations/languages/fa.ts +8 -4
  178. package/src/translations/languages/fr.ts +8 -4
  179. package/src/translations/languages/he.ts +4 -2
  180. package/src/translations/languages/hr.ts +8 -4
  181. package/src/translations/languages/hu.ts +8 -4
  182. package/src/translations/languages/hy.ts +8 -4
  183. package/src/translations/languages/id.ts +8 -4
  184. package/src/translations/languages/is.ts +8 -4
  185. package/src/translations/languages/it.ts +8 -4
  186. package/src/translations/languages/ja.ts +8 -4
  187. package/src/translations/languages/ko.ts +8 -4
  188. package/src/translations/languages/lt.ts +8 -4
  189. package/src/translations/languages/lv.ts +6 -3
  190. package/src/translations/languages/my.ts +8 -4
  191. package/src/translations/languages/nb.ts +8 -4
  192. package/src/translations/languages/nl.ts +8 -4
  193. package/src/translations/languages/pl.ts +6 -3
  194. package/src/translations/languages/pt.ts +8 -4
  195. package/src/translations/languages/ro.ts +8 -4
  196. package/src/translations/languages/rs.ts +6 -3
  197. package/src/translations/languages/rsLatin.ts +6 -3
  198. package/src/translations/languages/ru.ts +8 -4
  199. package/src/translations/languages/sk.ts +8 -4
  200. package/src/translations/languages/sl.ts +6 -3
  201. package/src/translations/languages/sv.ts +8 -4
  202. package/src/translations/languages/ta.ts +8 -4
  203. package/src/translations/languages/th.ts +6 -3
  204. package/src/translations/languages/tr.ts +6 -3
  205. package/src/translations/languages/uk.ts +8 -4
  206. package/src/translations/languages/vi.ts +8 -4
  207. package/src/translations/languages/zh.ts +2 -1
  208. package/src/translations/languages/zhTw.ts +2 -1
  209. package/src/types.ts +7 -4
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/createTool.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 { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Create a document in any collection by passing the collection slug and data.'\n\nexport const createDocumentTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n data: z.record(z.string(), z.unknown()).describe('The document fields to create'),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships in response')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to create 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 locale: z\n .string()\n .describe(\n 'Optional: locale code to create the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n select: z\n .string()\n .describe(\n \"Optional: define exactly which fields you'd like to return (JSON), e.g., '{\\\"title\\\": true}'\",\n )\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { data, depth, draft, fallbackLocale, locale, select } = input\n\n logger.info(\n `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,\n )\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({ collectionSlug, data: inputData, req })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\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 const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(selectClause ? { select: selectClause } : {}),\n })\n\n logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document created successfully in collection \"${collectionSlug}\"!\\nCreated document:\\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 creating document in ${collectionSlug}: ${errorMessage}`)\n return formatCollectionError({ action: 'creating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","transformPointDataToPayload","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","createDocumentTool","description","input","object","data","record","string","unknown","describe","depth","number","int","min","max","optional","default","draft","boolean","fallbackLocale","locale","select","handler","authorizedMCP","collectionSlug","req","payload","logger","info","virtualFieldNames","config","inputData","validationError","parsedData","selectClause","JSON","parse","warn","content","type","text","result","create","collection","id","stringify","doc","error","errorMessage","Error","message","action"],"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,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBT,qBAAqB;IACrDU,aAAaF;IACbG,OAAOZ,EAAEa,MAAM,CAAC;QACdC,MAAMd,EAAEe,MAAM,CAACf,EAAEgB,MAAM,IAAIhB,EAAEiB,OAAO,IAAIC,QAAQ,CAAC;QACjDC,OAAOnB,EACJoB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,8DACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAO1B,EACJ2B,OAAO,GACPT,QAAQ,CAAC,6CACTM,QAAQ,GACRC,OAAO,CAAC;QACXG,gBAAgB5B,EACbgB,MAAM,GACNE,QAAQ,CAAC,gFACTM,QAAQ;QACXK,QAAQ7B,EACLgB,MAAM,GACNE,QAAQ,CACP,sGAEDM,QAAQ;QACXM,QAAQ9B,EACLgB,MAAM,GACNE,QAAQ,CACP,gGAEDM,QAAQ;IACb;AACF,GAAGO,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAErB,KAAK,EAAEsB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASlC,UAAU;QAAEiC;IAAQ;IAEnC,MAAM,EAAErB,IAAI,EAAEK,KAAK,EAAEO,KAAK,EAAEE,cAAc,EAAEC,MAAM,EAAEC,MAAM,EAAE,GAAGlB;IAE/DwB,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEJ,iBAAiBJ,SAAS,CAAC,cAAc,EAAEA,QAAQ,GAAG,IAAI;IAGhG,IAAI;QACF,MAAMS,oBAAoBnC,+BAA+BgC,QAAQI,MAAM,EAAEN;QACzE,MAAMO,YAAYpC,mBAAmBU,MAAMwB;QAC3C,MAAMG,kBAAkBlC,uBAAuB;YAAE0B;YAAgBnB,MAAM0B;YAAWN;QAAI;QAEtF,IAAIO,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAMC,aAAapC,4BAA4BkC;QAE/C,IAAIG;QACJ,IAAIb,QAAQ;YACV,IAAI;gBACFa,eAAeC,KAAKC,KAAK,CAACf;YAC5B,EAAE,OAAM;gBACNM,OAAOU,IAAI,CAAC,CAAC,4BAA4B,EAAEhB,QAAQ;gBACnD,OAAO;oBAAEiB,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,MAAMC,SAAS,MAAMf,QAAQgB,MAAM,CAAC;YAClCC,YAAYnB;YACZnB,MAAM4B;YACNvB;YACAO;YACAQ;YACA,GAAG7B,iBAAiB2B,cAAc;YAClC,GAAIH,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAID,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIe,eAAe;gBAAEb,QAAQa;YAAa,IAAI,CAAC,CAAC;QAClD;QAEAP,OAAOC,IAAI,CAAC,CAAC,iCAAiC,EAAEJ,eAAe,UAAU,EAAEiB,OAAOG,EAAE,EAAE;QAEtF,OAAO;YACLN,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEhB,eAAe,mCAAmC,EAAEW,KAAKU,SAAS,CAACJ,QAAQ,QAAQ,CAAC;gBAC5I;aACD;YACDK,KAAKL;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DvB,OAAOoB,KAAK,CAAC,CAAC,2BAA2B,EAAEvB,eAAe,EAAE,EAAEwB,cAAc;QAC5E,OAAOjD,sBAAsB;YAAEoD,QAAQ;YAAY3B;YAAgBuB;YAAOtB;QAAI;IAChF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/createTool.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 { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Create a document in any collection by passing the collection slug and data.'\n\nexport const createDocumentTool = defineCollectionTool({\n annotations: {\n destructiveHint: false,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Create Document',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n data: z.record(z.string(), z.unknown()).describe('The document fields to create'),\n depth: z\n .number()\n .int()\n .min(0)\n .max(10)\n .describe('How many levels deep to populate relationships in response')\n .optional()\n .default(0),\n draft: z\n .boolean()\n .describe('Whether to create 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 locale: z\n .string()\n .describe(\n 'Optional: locale code to create the document in (e.g., \"en\", \"es\"). Defaults to the default locale',\n )\n .optional(),\n select: z\n .record(z.string(), z.unknown())\n .describe(\n 'Optional: define exactly which fields you\\'d like to return, e.g., {\"title\": true}',\n )\n .optional(),\n }),\n}).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {\n const payload = req.payload\n const logger = getLogger({ payload })\n\n const { data, depth, draft, fallbackLocale, locale, select } = input\n\n logger.info(\n `Creating document in collection: ${collectionSlug}${locale ? ` with locale: ${locale}` : ''}`,\n )\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({ collectionSlug, data: inputData, req })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n\n const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Document created successfully in collection \"${collectionSlug}\"!\\nCreated document:\\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 creating document in ${collectionSlug}: ${errorMessage}`)\n return formatCollectionError({ action: 'creating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","transformPointDataToPayload","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","createDocumentTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","data","record","string","unknown","describe","depth","number","int","min","max","optional","default","draft","boolean","fallbackLocale","locale","select","handler","authorizedMCP","collectionSlug","req","payload","logger","info","virtualFieldNames","config","inputData","validationError","parsedData","result","create","collection","id","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","action"],"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,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBT,qBAAqB;IACrDU,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaR;IACbS,OAAOlB,EAAEmB,MAAM,CAAC;QACdC,MAAMpB,EAAEqB,MAAM,CAACrB,EAAEsB,MAAM,IAAItB,EAAEuB,OAAO,IAAIC,QAAQ,CAAC;QACjDC,OAAOzB,EACJ0B,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,8DACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAOhC,EACJiC,OAAO,GACPT,QAAQ,CAAC,6CACTM,QAAQ,GACRC,OAAO,CAAC;QACXG,gBAAgBlC,EACbsB,MAAM,GACNE,QAAQ,CAAC,gFACTM,QAAQ;QACXK,QAAQnC,EACLsB,MAAM,GACNE,QAAQ,CACP,sGAEDM,QAAQ;QACXM,QAAQpC,EACLqB,MAAM,CAACrB,EAAEsB,MAAM,IAAItB,EAAEuB,OAAO,IAC5BC,QAAQ,CACP,sFAEDM,QAAQ;IACb;AACF,GAAGO,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAErB,KAAK,EAAEsB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASxC,UAAU;QAAEuC;IAAQ;IAEnC,MAAM,EAAErB,IAAI,EAAEK,KAAK,EAAEO,KAAK,EAAEE,cAAc,EAAEC,MAAM,EAAEC,MAAM,EAAE,GAAGlB;IAE/DwB,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEJ,iBAAiBJ,SAAS,CAAC,cAAc,EAAEA,QAAQ,GAAG,IAAI;IAGhG,IAAI;QACF,MAAMS,oBAAoBzC,+BAA+BsC,QAAQI,MAAM,EAAEN;QACzE,MAAMO,YAAY1C,mBAAmBgB,MAAMwB;QAC3C,MAAMG,kBAAkBxC,uBAAuB;YAAEgC;YAAgBnB,MAAM0B;YAAWN;QAAI;QAEtF,IAAIO,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAMC,aAAa1C,4BAA4BwC;QAE/C,MAAMG,SAAS,MAAMR,QAAQS,MAAM,CAAC;YAClCC,YAAYZ;YACZnB,MAAM4B;YACNvB;YACAO;YACAQ;YACA,GAAGnC,iBAAiBiC,cAAc;YAClC,GAAIH,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAID,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIE,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEAM,OAAOC,IAAI,CAAC,CAAC,iCAAiC,EAAEJ,eAAe,UAAU,EAAEU,OAAOG,EAAE,EAAE;QAEtF,OAAO;YACLC,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEhB,eAAe,mCAAmC,EAAEiB,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBAC5I;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DpB,OAAOiB,KAAK,CAAC,CAAC,2BAA2B,EAAEpB,eAAe,EAAE,EAAEqB,cAAc;QAC5E,OAAOpD,sBAAsB;YAAEuD,QAAQ;YAAYxB;YAAgBoB;YAAOnB;QAAI;IAChF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,mBAAmB,4CAyG9B,CAAA"}
1
+ {"version":3,"file":"deleteTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/deleteTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,mBAAmB,4CAgH9B,CAAA"}
@@ -5,6 +5,13 @@ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
5
  import { whereSchema } from '../../../utils/whereSchema.js';
6
6
  const DEFAULT_DESCRIPTION = 'Delete documents in any collection by passing the collection slug and ID or where clause.';
7
7
  export const deleteDocumentsTool = defineCollectionTool({
8
+ annotations: {
9
+ destructiveHint: true,
10
+ idempotentHint: false,
11
+ openWorldHint: false,
12
+ readOnlyHint: false,
13
+ title: 'Delete Documents'
14
+ },
8
15
  description: DEFAULT_DESCRIPTION,
9
16
  input: z.object({
10
17
  id: z.union([
@@ -1 +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'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Delete documents in any collection by passing the collection slug and ID or where clause.'\n\nexport const deleteDocumentsTool = 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: whereSchema\n .describe(\n 'Optional: where clause to delete multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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, 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 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 = where\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","whereSchema","DEFAULT_DESCRIPTION","deleteDocumentsTool","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","deleteOptions","collection","result","delete","JSON","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;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,sBAAsBL,qBAAqB;IACtDM,aAAaF;IACbG,OAAOR,EAAES,MAAM,CAAC;QACdC,IAAIV,EACDW,KAAK,CAAC;YAACX,EAAEY,MAAM;YAAIZ,EAAEa,MAAM;SAAG,EAC9BC,QAAQ,CAAC,4CACTC,QAAQ;QACXC,OAAOhB,EACJa,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,qDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,gBAAgBrB,EACbY,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXO,QAAQtB,EACLY,MAAM,GACNE,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,OAAOnB,YACJU,QAAQ,CACP,mKAEDC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAElB,KAAK,EAAEmB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS3B,UAAU;QAAE0B;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,MAAMC,gBAAyC;YAC7CC,YAAYT;YACZV;YACAW;YACA,GAAGxB,iBAAiBsB,cAAc;YAClC,GAAIH,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,kBAAkB;gBAAEA;YAAe,CAAC;QAC1C;QAEA,IAAIX,IAAI;YACNwB,cAAcxB,EAAE,GAAGA;QACrB,OAAO;YACLwB,cAAcX,KAAK,GAAGA;QACxB;QAEA,MAAMa,SAAS,MAAMR,QAAQS,MAAM,CAACH;QAEpC,IAAIxB,IAAI;YACN,OAAO;gBACLqB,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAEP,eAAe,mCAAmC,EAAEY,KAAKC,SAAS,CAACH,QAAQ,QAAQ,CAAC;oBAC9I;iBACD;gBACDI,KAAKJ;YACP;QACF;QAEA,MAAMK,aAAaL;QACnB,MAAMM,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,+CAA+C,EAAElB,eAAe,aAAa,EAAEgB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACzJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEN,KAAKC,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEN,KAAKC,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLZ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMW;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DpB,OAAOiB,KAAK,CAAC,CAAC,6BAA6B,EAAEpB,eAAe,EAAE,EAAEqB,cAAc;QAC9E,OAAO;YACLhB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAEP,eAAe,GAAG,EAAEqB,cAAc;gBACtF;aACD;QACH;IACF;AACF,GAAE"}
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'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Delete documents in any collection by passing the collection slug and ID or where clause.'\n\nexport const deleteDocumentsTool = defineCollectionTool({\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Delete Documents',\n },\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: whereSchema\n .describe(\n 'Optional: where clause to delete multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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, 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 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 = where\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","whereSchema","DEFAULT_DESCRIPTION","deleteDocumentsTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","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","deleteOptions","collection","result","delete","JSON","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;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,sBAAsBL,qBAAqB;IACtDM,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaR;IACbS,OAAOd,EAAEe,MAAM,CAAC;QACdC,IAAIhB,EACDiB,KAAK,CAAC;YAACjB,EAAEkB,MAAM;YAAIlB,EAAEmB,MAAM;SAAG,EAC9BC,QAAQ,CAAC,4CACTC,QAAQ;QACXC,OAAOtB,EACJmB,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,qDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,gBAAgB3B,EACbkB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXO,QAAQ5B,EACLkB,MAAM,GACNE,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,OAAOzB,YACJgB,QAAQ,CACP,mKAEDC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAElB,KAAK,EAAEmB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASjC,UAAU;QAAEgC;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,MAAMC,gBAAyC;YAC7CC,YAAYT;YACZV;YACAW;YACA,GAAG9B,iBAAiB4B,cAAc;YAClC,GAAIH,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAID,kBAAkB;gBAAEA;YAAe,CAAC;QAC1C;QAEA,IAAIX,IAAI;YACNwB,cAAcxB,EAAE,GAAGA;QACrB,OAAO;YACLwB,cAAcX,KAAK,GAAGA;QACxB;QAEA,MAAMa,SAAS,MAAMR,QAAQS,MAAM,CAACH;QAEpC,IAAIxB,IAAI;YACN,OAAO;gBACLqB,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,+CAA+C,EAAEP,eAAe,mCAAmC,EAAEY,KAAKC,SAAS,CAACH,QAAQ,QAAQ,CAAC;oBAC9I;iBACD;gBACDI,KAAKJ;YACP;QACF;QAEA,MAAMK,aAAaL;QACnB,MAAMM,OAAOD,WAAWC,IAAI,IAAI,EAAE;QAClC,MAAMC,SAASF,WAAWE,MAAM,IAAI,EAAE;QAEtC,IAAIC,eAAe,CAAC,+CAA+C,EAAElB,eAAe,aAAa,EAAEgB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACzJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEN,KAAKC,SAAS,CAACG,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEN,KAAKC,SAAS,CAACI,QAAQ,QAAQ,CAAC;QAC9E;QAEA,OAAO;YACLZ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMW;gBAAa;aAAE;YAC/CJ,KAAK;gBAAEE;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOG,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DpB,OAAOiB,KAAK,CAAC,CAAC,6BAA6B,EAAEpB,eAAe,EAAE,EAAEqB,cAAc;QAC9E,OAAO;YACLhB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,yCAAyC,EAAEP,eAAe,GAAG,EAAEqB,cAAc;gBACtF;aACD;QACH;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,iBAAiB,4CAoK5B,CAAA"}
1
+ {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,iBAAiB,4CAyM5B,CAAA"}
@@ -5,6 +5,13 @@ import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
5
  import { whereSchema } from '../../../utils/whereSchema.js';
6
6
  const DEFAULT_DESCRIPTION = 'Find documents in any collection by passing the collection slug and optional ID or where clause.';
7
7
  export const findDocumentsTool = defineCollectionTool({
8
+ annotations: {
9
+ destructiveHint: false,
10
+ idempotentHint: true,
11
+ openWorldHint: false,
12
+ readOnlyHint: true,
13
+ title: 'Find Documents'
14
+ },
8
15
  description: DEFAULT_DESCRIPTION,
9
16
  input: z.object({
10
17
  id: z.union([
@@ -14,11 +21,18 @@ export const findDocumentsTool = defineCollectionTool({
14
21
  depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships (default: 0)').optional().default(0),
15
22
  draft: z.boolean().describe('Optional: whether the document should be queried from the versions table/collection or not.').optional(),
16
23
  fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
24
+ joins: z.union([
25
+ z.record(z.string(), z.unknown()),
26
+ z.literal(false)
27
+ ]).describe('Optional: configure join field queries, or pass false to disable all join fields.').optional(),
17
28
  limit: z.number().int().min(1).max(100).describe('Maximum number of documents to return (default: 10, max: 100)').optional().default(10),
18
29
  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(),
19
30
  page: z.number().int().min(1).describe('Page number for pagination (default: 1)').optional().default(1),
20
- select: z.string().describe("Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'").optional(),
31
+ pagination: z.boolean().describe('Optional: set to false to skip the count query overhead').optional(),
32
+ populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
33
+ select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}').optional(),
21
34
  sort: z.string().describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)').optional(),
35
+ trash: z.boolean().describe('Optional: include soft-deleted documents when trash is enabled on the collection').optional(),
22
36
  where: whereSchema.describe('Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}').optional()
23
37
  })
24
38
  }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
@@ -26,25 +40,9 @@ export const findDocumentsTool = defineCollectionTool({
26
40
  const logger = getLogger({
27
41
  payload
28
42
  });
29
- const { id, depth, draft, fallbackLocale, limit, locale, page, select, sort, where } = input;
43
+ const { id, depth, draft, fallbackLocale, joins, limit, locale, page, pagination, populate, select, sort, trash, where } = input;
30
44
  logger.info(`Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`);
31
45
  try {
32
- let selectClause;
33
- if (select) {
34
- try {
35
- selectClause = JSON.parse(select);
36
- } catch {
37
- logger.warn(`Invalid select clause JSON: ${select}`);
38
- return {
39
- content: [
40
- {
41
- type: 'text',
42
- text: 'Error: Invalid JSON in select clause'
43
- }
44
- ]
45
- };
46
- }
47
- }
48
46
  if (id) {
49
47
  try {
50
48
  const doc = await payload.findByID({
@@ -53,8 +51,14 @@ export const findDocumentsTool = defineCollectionTool({
53
51
  depth,
54
52
  req,
55
53
  ...localAPIDefaults(authorizedMCP),
56
- ...selectClause && {
57
- select: selectClause
54
+ ...select && {
55
+ select: select
56
+ },
57
+ ...populate && {
58
+ populate: populate
59
+ },
60
+ ...joins !== undefined && {
61
+ joins: joins
58
62
  },
59
63
  ...locale && {
60
64
  locale
@@ -64,6 +68,9 @@ export const findDocumentsTool = defineCollectionTool({
64
68
  },
65
69
  ...draft !== undefined && {
66
70
  draft
71
+ },
72
+ ...trash !== undefined && {
73
+ trash
67
74
  }
68
75
  });
69
76
  return {
@@ -94,8 +101,14 @@ export const findDocumentsTool = defineCollectionTool({
94
101
  page,
95
102
  req,
96
103
  ...localAPIDefaults(authorizedMCP),
97
- ...selectClause && {
98
- select: selectClause
104
+ ...select && {
105
+ select: select
106
+ },
107
+ ...populate && {
108
+ populate: populate
109
+ },
110
+ ...joins !== undefined && {
111
+ joins: joins
99
112
  },
100
113
  ...locale && {
101
114
  locale
@@ -105,6 +118,12 @@ export const findDocumentsTool = defineCollectionTool({
105
118
  },
106
119
  ...draft !== undefined && {
107
120
  draft
121
+ },
122
+ ...pagination !== undefined && {
123
+ pagination
124
+ },
125
+ ...trash !== undefined && {
126
+ trash
108
127
  }
109
128
  };
110
129
  if (sort) {
@@ -1 +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'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Find documents in any collection by passing the collection slug and optional ID or where clause.'\n\nexport const findDocumentsTool = 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: whereSchema\n .describe(\n 'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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 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 (where) {\n findOptions.where = 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","whereSchema","DEFAULT_DESCRIPTION","findDocumentsTool","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","selectClause","JSON","parse","warn","content","type","text","doc","findByID","collection","undefined","stringify","findOptions","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;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,oBAAoBL,qBAAqB;IACpDM,aAAaF;IACbG,OAAOR,EAAES,MAAM,CAAC;QACdC,IAAIV,EACDW,KAAK,CAAC;YAACX,EAAEY,MAAM;YAAIZ,EAAEa,MAAM;SAAG,EAC9BC,QAAQ,CACP,sFAEDC,QAAQ;QACXC,OAAOhB,EACJa,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,+DACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOrB,EACJsB,OAAO,GACPR,QAAQ,CACP,+FAEDC,QAAQ;QACXQ,gBAAgBvB,EACbY,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,OAAOxB,EACJa,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJL,QAAQ,CAAC,iEACTC,QAAQ,GACRK,OAAO,CAAC;QACXK,QAAQzB,EACLY,MAAM,GACNE,QAAQ,CACP,wHAEDC,QAAQ;QACXW,MAAM1B,EACHa,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJJ,QAAQ,CAAC,2CACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,QAAQ3B,EACLY,MAAM,GACNE,QAAQ,CACP,gHAEDC,QAAQ;QACXa,MAAM5B,EACHY,MAAM,GACNE,QAAQ,CAAC,qEACTC,QAAQ;QACXc,OAAOzB,YACJU,QAAQ,CACP,oJAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAExB,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASjC,UAAU;QAAEgC;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;QACJ,IAAIV,QAAQ;YACV,IAAI;gBACFU,eAAeC,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,MAAMkC,MAAM,MAAMV,QAAQW,QAAQ,CAAC;oBACjCnC;oBACAoC,YAAYd;oBACZhB;oBACAiB;oBACA,GAAG9B,iBAAiB4B,cAAc;oBAClC,GAAIM,gBAAgB;wBAAEV,QAAQU;oBAAa,CAAC;oBAC5C,GAAIZ,UAAU;wBAAEA;oBAAO,CAAC;oBACxB,GAAIF,kBAAkB;wBAAEA;oBAAe,CAAC;oBACxC,GAAIF,UAAU0B,aAAa;wBAAE1B;oBAAM,CAAC;gBACtC;gBAEA,OAAO;oBACLoB,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,0BAA0B,EAAEX,eAAe,IAAI,EAAEM,KAAKU,SAAS,CAACJ,MAAM;wBAC/E;qBACD;oBACDA,KAAKA;gBACP;YACF,EAAE,OAAM;gBACNT,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,MAAMiB,cAAkD;YACtDH,YAAYd;YACZhB;YACAQ;YACAE;YACAO;YACA,GAAG9B,iBAAiB4B,cAAc;YAClC,GAAIM,gBAAgB;gBAAEV,QAAQU;YAAa,CAAC;YAC5C,GAAIZ,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAIF,kBAAkB;gBAAEA;YAAe,CAAC;YACxC,GAAIF,UAAU0B,aAAa;gBAAE1B;YAAM,CAAC;QACtC;QAEA,IAAIO,MAAM;YACRqB,YAAYrB,IAAI,GAAGA;QACrB;QACA,IAAIC,OAAO;YACToB,YAAYpB,KAAK,GAAGA;QACtB;QAEA,MAAMqB,SAAS,MAAMhB,QAAQiB,IAAI,CAACF;QAElC,IAAIG,eAAe,CAAC,aAAa,EAAEpB,eAAe,UAAU,EAAEkB,OAAOG,SAAS,CAAC,kBAAkB,EAAEH,OAAOxB,IAAI,CAAC,IAAI,EAAEwB,OAAOI,UAAU,CAAC,EAAE,CAAC;QAC1I,KAAK,MAAMV,OAAOM,OAAOK,IAAI,CAAE;YAC7BH,gBAAgB,CAAC,cAAc,EAAEd,KAAKU,SAAS,CAACJ,KAAK,QAAQ,CAAC;QAChE;QAEA,OAAO;YACLH,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMS;gBAAa;aAAE;YAC/CR,KAAKM;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DxB,OAAOqB,KAAK,CAAC,CAAC,wCAAwC,EAAExB,eAAe,EAAE,EAAEyB,cAAc;QACzF,OAAO;YACLhB,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEX,eAAe,KAAK,EAAEyB,cAAc;gBAC5F;aACD;QACH;IACF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/findTool.ts"],"sourcesContent":["import type { JoinQuery, PopulateType, 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'\nimport { whereSchema } from '../../../utils/whereSchema.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Find documents in any collection by passing the collection slug and optional ID or where clause.'\n\nexport const findDocumentsTool = defineCollectionTool({\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Find Documents',\n },\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 joins: z\n .union([z.record(z.string(), z.unknown()), z.literal(false)])\n .describe('Optional: configure join field queries, or pass false to disable all join fields.')\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 pagination: z\n .boolean()\n .describe('Optional: set to false to skip the count query overhead')\n .optional(),\n populate: z\n .record(z.string(), z.unknown())\n .describe(\n 'Optional: control which fields to include from populated relationship or upload documents.',\n )\n .optional(),\n select: z\n .record(z.string(), z.unknown())\n .describe(\n 'Optional: define exactly which fields you\\'d like to return in the response, 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 trash: z\n .boolean()\n .describe('Optional: include soft-deleted documents when trash is enabled on the collection')\n .optional(),\n where: whereSchema\n .describe(\n 'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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 {\n id,\n depth,\n draft,\n fallbackLocale,\n joins,\n limit,\n locale,\n page,\n pagination,\n populate,\n select,\n sort,\n trash,\n where,\n } = 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 if (id) {\n try {\n const doc = await payload.findByID({\n id,\n collection: collectionSlug,\n depth,\n req,\n ...localAPIDefaults(authorizedMCP),\n ...(select && { select: select as SelectType }),\n ...(populate && { populate: populate as PopulateType }),\n ...(joins !== undefined && { joins: joins as JoinQuery }),\n ...(locale && { locale }),\n ...(fallbackLocale && { fallbackLocale }),\n ...(draft !== undefined && { draft }),\n ...(trash !== undefined && { trash }),\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 ...(select && { select: select as SelectType }),\n ...(populate && { populate: populate as PopulateType }),\n ...(joins !== undefined && { joins: joins as JoinQuery }),\n ...(locale && { locale }),\n ...(fallbackLocale && { fallbackLocale }),\n ...(draft !== undefined && { draft }),\n ...(pagination !== undefined && { pagination }),\n ...(trash !== undefined && { trash }),\n }\n\n if (sort) {\n findOptions.sort = sort\n }\n if (where) {\n findOptions.where = 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","whereSchema","DEFAULT_DESCRIPTION","findDocumentsTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","depth","int","min","max","default","draft","boolean","fallbackLocale","joins","record","unknown","literal","limit","locale","page","pagination","populate","select","sort","trash","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","doc","findByID","collection","undefined","content","type","text","JSON","stringify","warn","findOptions","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;AACrE,SAASC,WAAW,QAAQ,gCAA+B;AAE3D,MAAMC,sBACJ;AAEF,OAAO,MAAMC,oBAAoBL,qBAAqB;IACpDM,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaR;IACbS,OAAOd,EAAEe,MAAM,CAAC;QACdC,IAAIhB,EACDiB,KAAK,CAAC;YAACjB,EAAEkB,MAAM;YAAIlB,EAAEmB,MAAM;SAAG,EAC9BC,QAAQ,CACP,sFAEDC,QAAQ;QACXC,OAAOtB,EACJmB,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,+DACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAO3B,EACJ4B,OAAO,GACPR,QAAQ,CACP,+FAEDC,QAAQ;QACXQ,gBAAgB7B,EACbkB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,OAAO9B,EACJiB,KAAK,CAAC;YAACjB,EAAE+B,MAAM,CAAC/B,EAAEkB,MAAM,IAAIlB,EAAEgC,OAAO;YAAKhC,EAAEiC,OAAO,CAAC;SAAO,EAC3Db,QAAQ,CAAC,qFACTC,QAAQ;QACXa,OAAOlC,EACJmB,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,KACJL,QAAQ,CAAC,iEACTC,QAAQ,GACRK,OAAO,CAAC;QACXS,QAAQnC,EACLkB,MAAM,GACNE,QAAQ,CACP,wHAEDC,QAAQ;QACXe,MAAMpC,EACHmB,MAAM,GACNI,GAAG,GACHC,GAAG,CAAC,GACJJ,QAAQ,CAAC,2CACTC,QAAQ,GACRK,OAAO,CAAC;QACXW,YAAYrC,EACT4B,OAAO,GACPR,QAAQ,CAAC,2DACTC,QAAQ;QACXiB,UAAUtC,EACP+B,MAAM,CAAC/B,EAAEkB,MAAM,IAAIlB,EAAEgC,OAAO,IAC5BZ,QAAQ,CACP,8FAEDC,QAAQ;QACXkB,QAAQvC,EACL+B,MAAM,CAAC/B,EAAEkB,MAAM,IAAIlB,EAAEgC,OAAO,IAC5BZ,QAAQ,CACP,sGAEDC,QAAQ;QACXmB,MAAMxC,EACHkB,MAAM,GACNE,QAAQ,CAAC,qEACTC,QAAQ;QACXoB,OAAOzC,EACJ4B,OAAO,GACPR,QAAQ,CAAC,oFACTC,QAAQ;QACXqB,OAAOtC,YACJgB,QAAQ,CACP,oJAEDC,QAAQ;IACb;AACF,GAAGsB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAE/B,KAAK,EAAEgC,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS9C,UAAU;QAAE6C;IAAQ;IAEnC,MAAM,EACJ/B,EAAE,EACFM,KAAK,EACLK,KAAK,EACLE,cAAc,EACdC,KAAK,EACLI,KAAK,EACLC,MAAM,EACNC,IAAI,EACJC,UAAU,EACVC,QAAQ,EACRC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,KAAK,EACN,GAAG5B;IAEJkC,OAAOC,IAAI,CACT,CAAC,kCAAkC,EAAEJ,iBAAiB7B,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,GAAG,SAAS,EAAEkB,MAAM,QAAQ,EAAEE,OAAOD,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG3J,IAAI;QACF,IAAInB,IAAI;YACN,IAAI;gBACF,MAAMkC,MAAM,MAAMH,QAAQI,QAAQ,CAAC;oBACjCnC;oBACAoC,YAAYP;oBACZvB;oBACAwB;oBACA,GAAG3C,iBAAiByC,cAAc;oBAClC,GAAIL,UAAU;wBAAEA,QAAQA;oBAAqB,CAAC;oBAC9C,GAAID,YAAY;wBAAEA,UAAUA;oBAAyB,CAAC;oBACtD,GAAIR,UAAUuB,aAAa;wBAAEvB,OAAOA;oBAAmB,CAAC;oBACxD,GAAIK,UAAU;wBAAEA;oBAAO,CAAC;oBACxB,GAAIN,kBAAkB;wBAAEA;oBAAe,CAAC;oBACxC,GAAIF,UAAU0B,aAAa;wBAAE1B;oBAAM,CAAC;oBACpC,GAAIc,UAAUY,aAAa;wBAAEZ;oBAAM,CAAC;gBACtC;gBAEA,OAAO;oBACLa,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,0BAA0B,EAAEX,eAAe,IAAI,EAAEY,KAAKC,SAAS,CAACR,MAAM;wBAC/E;qBACD;oBACDA,KAAKA;gBACP;YACF,EAAE,OAAM;gBACNF,OAAOW,IAAI,CAAC,CAAC,4BAA4B,EAAE3C,GAAG,gBAAgB,EAAE6B,gBAAgB;gBAChF,OAAO;oBACLS,SAAS;wBACP;4BACEC,MAAM;4BACNC,MAAM,CAAC,yBAAyB,EAAExC,GAAG,2BAA2B,EAAE6B,eAAe,CAAC,CAAC;wBACrF;qBACD;gBACH;YACF;QACF;QAEA,MAAMe,cAAkD;YACtDR,YAAYP;YACZvB;YACAY;YACAE;YACAU;YACA,GAAG3C,iBAAiByC,cAAc;YAClC,GAAIL,UAAU;gBAAEA,QAAQA;YAAqB,CAAC;YAC9C,GAAID,YAAY;gBAAEA,UAAUA;YAAyB,CAAC;YACtD,GAAIR,UAAUuB,aAAa;gBAAEvB,OAAOA;YAAmB,CAAC;YACxD,GAAIK,UAAU;gBAAEA;YAAO,CAAC;YACxB,GAAIN,kBAAkB;gBAAEA;YAAe,CAAC;YACxC,GAAIF,UAAU0B,aAAa;gBAAE1B;YAAM,CAAC;YACpC,GAAIU,eAAegB,aAAa;gBAAEhB;YAAW,CAAC;YAC9C,GAAII,UAAUY,aAAa;gBAAEZ;YAAM,CAAC;QACtC;QAEA,IAAID,MAAM;YACRoB,YAAYpB,IAAI,GAAGA;QACrB;QACA,IAAIE,OAAO;YACTkB,YAAYlB,KAAK,GAAGA;QACtB;QAEA,MAAMmB,SAAS,MAAMd,QAAQe,IAAI,CAACF;QAElC,IAAIG,eAAe,CAAC,aAAa,EAAElB,eAAe,UAAU,EAAEgB,OAAOG,SAAS,CAAC,kBAAkB,EAAEH,OAAOzB,IAAI,CAAC,IAAI,EAAEyB,OAAOI,UAAU,CAAC,EAAE,CAAC;QAC1I,KAAK,MAAMf,OAAOW,OAAOK,IAAI,CAAE;YAC7BH,gBAAgB,CAAC,cAAc,EAAEN,KAAKC,SAAS,CAACR,KAAK,QAAQ,CAAC;QAChE;QAEA,OAAO;YACLI,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMO;gBAAa;aAAE;YAC/Cb,KAAKW;QACP;IACF,EAAE,OAAOM,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DtB,OAAOmB,KAAK,CAAC,CAAC,wCAAwC,EAAEtB,eAAe,EAAE,EAAEuB,cAAc;QACzF,OAAO;YACLd,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAEX,eAAe,KAAK,EAAEuB,cAAc;gBAC5F;aACD;QACH;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"getCollectionSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,4CAwBlC,CAAA"}
1
+ {"version":3,"file":"getCollectionSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,4CA+BlC,CAAA"}
@@ -1,6 +1,13 @@
1
1
  import { defineCollectionTool } from '../../../defineTool.js';
2
2
  import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js';
3
3
  export const getCollectionSchemaTool = defineCollectionTool({
4
+ annotations: {
5
+ destructiveHint: false,
6
+ idempotentHint: true,
7
+ openWorldHint: false,
8
+ readOnlyHint: true,
9
+ title: 'Get Collection Schema'
10
+ },
4
11
  description: 'Get the input schema for creating or updating documents in a collection.'
5
12
  }).handler(({ collectionSlug, req })=>{
6
13
  const inputSchema = getCollectionInputSchema({
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { defineCollectionTool } from '../../../defineTool.js'\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n description: 'Get the input schema for creating or updating documents in a collection.',\n}).handler(({ collectionSlug, req }) => {\n const inputSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${collectionSlug}\" not found` }],\n isError: true,\n }\n }\n\n return {\n content: [\n {\n type: 'text',\n text: `Schema for collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(inputSchema)}\\n\\`\\`\\``,\n },\n ],\n structuredContent: {\n collectionSlug,\n schema: inputSchema,\n },\n }\n})\n"],"names":["defineCollectionTool","getCollectionInputSchema","getCollectionSchemaTool","description","handler","collectionSlug","req","inputSchema","content","type","text","isError","JSON","stringify","structuredContent","schema"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,wBAAwB,QAAQ,0DAAyD;AAElG,OAAO,MAAMC,0BAA0BF,qBAAqB;IAC1DG,aAAa;AACf,GAAGC,OAAO,CAAC,CAAC,EAAEC,cAAc,EAAEC,GAAG,EAAE;IACjC,MAAMC,cAAcN,yBAAyB;QAAEI;QAAgBC;IAAI;IAEnE,IAAI,CAACC,aAAa;QAChB,OAAO;YACLC,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,mBAAmB,EAAEL,eAAe,WAAW,CAAC;gBAAC;aAAE;YACpFM,SAAS;QACX;IACF;IAEA,OAAO;QACLH,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,uBAAuB,EAAEL,eAAe,gBAAgB,EAAEO,KAAKC,SAAS,CAACN,aAAa,QAAQ,CAAC;YACxG;SACD;QACDO,mBAAmB;YACjBT;YACAU,QAAQR;QACV;IACF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { defineCollectionTool } from '../../../defineTool.js'\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Get Collection Schema',\n },\n description: 'Get the input schema for creating or updating documents in a collection.',\n}).handler(({ collectionSlug, req }) => {\n const inputSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${collectionSlug}\" not found` }],\n isError: true,\n }\n }\n\n return {\n content: [\n {\n type: 'text',\n text: `Schema for collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(inputSchema)}\\n\\`\\`\\``,\n },\n ],\n structuredContent: {\n collectionSlug,\n schema: inputSchema,\n },\n }\n})\n"],"names":["defineCollectionTool","getCollectionInputSchema","getCollectionSchemaTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","handler","collectionSlug","req","inputSchema","content","type","text","isError","JSON","stringify","structuredContent","schema"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,wBAAwB,QAAQ,0DAAyD;AAElG,OAAO,MAAMC,0BAA0BF,qBAAqB;IAC1DG,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAa;AACf,GAAGC,OAAO,CAAC,CAAC,EAAEC,cAAc,EAAEC,GAAG,EAAE;IACjC,MAAMC,cAAcZ,yBAAyB;QAAEU;QAAgBC;IAAI;IAEnE,IAAI,CAACC,aAAa;QAChB,OAAO;YACLC,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,mBAAmB,EAAEL,eAAe,WAAW,CAAC;gBAAC;aAAE;YACpFM,SAAS;QACX;IACF;IAEA,OAAO;QACLH,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,uBAAuB,EAAEL,eAAe,gBAAgB,EAAEO,KAAKC,SAAS,CAACN,aAAa,QAAQ,CAAC;YACxG;SACD;QACDO,mBAAmB;YACjBT;YACAU,QAAQR;QACV;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,kBAAkB,4CA8L7B,CAAA"}
1
+ {"version":3,"file":"updateTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,kBAAkB,4CA2L7B,CAAA"}
@@ -10,6 +10,13 @@ import { validateCollectionData } from '../validateEntityData.js';
10
10
  import { formatCollectionError } from './formatCollectionError.js';
11
11
  const DEFAULT_DESCRIPTION = 'Update documents in any collection by passing the collection slug and data.';
12
12
  export const updateDocumentTool = defineCollectionTool({
13
+ annotations: {
14
+ destructiveHint: true,
15
+ idempotentHint: false,
16
+ openWorldHint: false,
17
+ readOnlyHint: false,
18
+ title: 'Update Document'
19
+ },
13
20
  description: DEFAULT_DESCRIPTION,
14
21
  input: z.object({
15
22
  id: z.union([
@@ -24,7 +31,7 @@ export const updateDocumentTool = defineCollectionTool({
24
31
  locale: z.string().describe('Optional: locale code to update the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
25
32
  overrideLock: z.boolean().describe('Whether to override document locks').optional().default(true),
26
33
  overwriteExistingFiles: z.boolean().describe('Whether to overwrite existing files').optional().default(false),
27
- select: z.string().describe("Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'").optional(),
34
+ select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}').optional(),
28
35
  where: whereSchema.describe('Where clause to update multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}').optional()
29
36
  })
30
37
  }).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
@@ -58,22 +65,6 @@ export const updateDocumentTool = defineCollectionTool({
58
65
  }
59
66
  const parsedData = transformPointDataToPayload(inputData);
60
67
  const whereClause = where ?? {};
61
- let selectClause;
62
- if (select) {
63
- try {
64
- selectClause = JSON.parse(select);
65
- } catch {
66
- logger.warn(`Invalid select clause JSON: ${select}`);
67
- return {
68
- content: [
69
- {
70
- type: 'text',
71
- text: 'Error: Invalid JSON in select clause'
72
- }
73
- ]
74
- };
75
- }
76
- }
77
68
  if (id) {
78
69
  const result = await payload.update({
79
70
  id,
@@ -96,8 +87,8 @@ export const updateDocumentTool = defineCollectionTool({
96
87
  ...fallbackLocale ? {
97
88
  fallbackLocale
98
89
  } : {},
99
- ...selectClause ? {
100
- select: selectClause
90
+ ...select ? {
91
+ select: select
101
92
  } : {}
102
93
  });
103
94
  return {
@@ -131,8 +122,8 @@ export const updateDocumentTool = defineCollectionTool({
131
122
  ...fallbackLocale ? {
132
123
  fallbackLocale
133
124
  } : {},
134
- ...selectClause ? {
135
- select: selectClause
125
+ ...select ? {
126
+ select: select
136
127
  } : {}
137
128
  });
138
129
  const docs = result.docs || [];
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { SelectType, Where } 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 { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Update documents in any collection by passing the collection slug and data.'\n\nexport const updateDocumentTool = defineCollectionTool({\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),\n data: z.record(z.string(), z.unknown()).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\\\": true}'\",\n )\n .optional(),\n where: whereSchema\n .describe(\n 'Where clause to update multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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 {\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 const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({\n collectionSlug,\n data: inputData,\n partial: true,\n req,\n })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n\n const whereClause: Where = where ?? {}\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 result = await payload.update({\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 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 result = await payload.update({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n where: whereClause,\n ...localAPIDefaults(authorizedMCP),\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(selectClause ? { select: selectClause } : {}),\n })\n\n const docs = result.docs || []\n const errors = result.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 const errorSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (errorSchema) {\n responseText += `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(errorSchema)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n isError: true,\n ...(errorSchema\n ? {\n structuredContent: {\n collectionSlug,\n docs,\n errors,\n schema: errorSchema,\n },\n }\n : {}),\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 formatCollectionError({ action: 'updating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","getCollectionInputSchema","transformPointDataToPayload","whereSchema","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","updateDocumentTool","description","input","object","id","union","string","number","describe","optional","data","record","unknown","depth","default","draft","boolean","fallbackLocale","filePath","locale","overrideLock","overwriteExistingFiles","select","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","content","type","text","virtualFieldNames","config","inputData","validationError","partial","parsedData","whereClause","selectClause","JSON","parse","warn","result","update","collection","stringify","doc","docs","errors","responseText","length","errorSchema","isError","structuredContent","schema","error","errorMessage","Error","message","action"],"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,wBAAwB,QAAQ,0DAAyD;AAClG,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBX,qBAAqB;IACrDY,aAAaF;IACbG,OAAOd,EAAEe,MAAM,CAAC;QACdC,IAAIhB,EAAEiB,KAAK,CAAC;YAACjB,EAAEkB,MAAM;YAAIlB,EAAEmB,MAAM;SAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;QAC3FC,MAAMtB,EAAEuB,MAAM,CAACvB,EAAEkB,MAAM,IAAIlB,EAAEwB,OAAO,IAAIJ,QAAQ,CAAC;QACjDK,OAAOzB,EACJmB,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAO3B,EACJ4B,OAAO,GACPR,QAAQ,CAAC,6CACTC,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgB7B,EACbkB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,UAAU9B,EAAEkB,MAAM,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;QACpEU,QAAQ/B,EACLkB,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;QACXW,cAAchC,EACX4B,OAAO,GACPR,QAAQ,CAAC,sCACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,wBAAwBjC,EACrB4B,OAAO,GACPR,QAAQ,CAAC,uCACTC,QAAQ,GACRK,OAAO,CAAC;QACXQ,QAAQlC,EACLkB,MAAM,GACNE,QAAQ,CACP,gHAEDC,QAAQ;QACXc,OAAO3B,YACJY,QAAQ,CACP,yJAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAExB,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASvC,UAAU;QAAEsC;IAAQ;IAEnC,MAAM,EACJxB,EAAE,EACFM,IAAI,EACJG,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,MAAM,EACNC,KAAK,EACN,GAAGrB;IAEJ2B,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEJ,iBAAiBtB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEW,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACf,MAAM,CAACmB,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,oBAAoB3C,+BAA+BqC,QAAQO,MAAM,EAAET;QACzE,MAAMU,YAAY5C,mBAAmBkB,MAAMwB;QAC3C,MAAMG,kBAAkBxC,uBAAuB;YAC7C6B;YACAhB,MAAM0B;YACNE,SAAS;YACTX;QACF;QAEA,IAAIU,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAME,aAAa5C,4BAA4ByC;QAE/C,MAAMI,cAAqBjB,SAAS,CAAC;QAErC,IAAIkB;QACJ,IAAInB,QAAQ;YACV,IAAI;gBACFmB,eAAeC,KAAKC,KAAK,CAACrB;YAC5B,EAAE,OAAM;gBACNO,OAAOe,IAAI,CAAC,CAAC,4BAA4B,EAAEtB,QAAQ;gBACnD,OAAO;oBAAES,SAAS;wBAAC;4BAAEC,MAAM;4BAAQC,MAAM;wBAAuC;qBAAE;gBAAC;YACrF;QACF;QAEA,IAAI7B,IAAI;YACN,MAAMyC,SAAS,MAAMjB,QAAQkB,MAAM,CAAC;gBAClC1C;gBACA2C,YAAYrB;gBACZhB,MAAM6B;gBACN1B;gBACAE;gBACAK;gBACAO;gBACA,GAAGlC,iBAAiBgC,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,OAAO;gBACLV,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEP,eAAe,mCAAmC,EAAEgB,KAAKM,SAAS,CAACH,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDI,KAAKJ;YACP;QACF;QAEA,MAAMA,SAAS,MAAMjB,QAAQkB,MAAM,CAAC;YAClCC,YAAYrB;YACZhB,MAAM6B;YACN1B;YACAE;YACAK;YACAO;YACAJ,OAAOiB;YACP,GAAG/C,iBAAiBgC,cAAc;YAClC,GAAIP,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,MAAMS,OAAOL,OAAOK,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASN,OAAOM,MAAM,IAAI,EAAE;QAElC,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,EAAEV,KAAKM,SAAS,CAACE,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEV,KAAKM,SAAS,CAACG,QAAQ,QAAQ,CAAC;YAE5E,MAAMG,cAAc5D,yBAAyB;gBAAEgC;gBAAgBC;YAAI;YAEnE,IAAI2B,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEV,KAAKM,SAAS,CAACM,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLvB,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMmB;oBAAa;iBAAE;gBAC/CH,KAAK;oBAAEC;oBAAMC;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB9B;wBACAwB;wBACAC;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLvB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMmB;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DhC,OAAO6B,KAAK,CAAC,CAAC,2BAA2B,EAAEhC,eAAe,EAAE,EAAEiC,cAAc;QAC5E,OAAO7D,sBAAsB;YAAEgE,QAAQ;YAAYpC;YAAgBgC;YAAO/B;QAAI;IAChF;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/collections/updateTool.ts"],"sourcesContent":["import type { SelectType, Where } 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 { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { whereSchema } from '../../../utils/whereSchema.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Update documents in any collection by passing the collection slug and data.'\n\nexport const updateDocumentTool = defineCollectionTool({\n annotations: {\n destructiveHint: true,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Update Document',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\n id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),\n data: z.record(z.string(), z.unknown()).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 .record(z.string(), z.unknown())\n .describe(\n 'Optional: define exactly which fields you\\'d like to return in the response, e.g., {\"title\": true}',\n )\n .optional(),\n where: whereSchema\n .describe(\n 'Where clause to update multiple documents. Use field names with Payload operators, and/or arrays for grouping. Example: {\"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 {\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 const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const inputData = stripVirtualFields(data, virtualFieldNames)\n const validationError = validateCollectionData({\n collectionSlug,\n data: inputData,\n partial: true,\n req,\n })\n\n if (validationError) {\n return validationError\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n\n const whereClause: Where = where ?? {}\n\n if (id) {\n const result = await payload.update({\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 ...(select ? { select: select as SelectType } : {}),\n })\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 result = await payload.update({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideLock,\n req,\n where: whereClause,\n ...localAPIDefaults(authorizedMCP),\n ...(filePath ? { filePath } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n const docs = result.docs || []\n const errors = result.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 const errorSchema = getCollectionInputSchema({ collectionSlug, req })\n\n if (errorSchema) {\n responseText += `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(errorSchema)}\\n\\`\\`\\``\n }\n\n return {\n content: [{ type: 'text', text: responseText }],\n doc: { docs, errors } as unknown as Record<string, unknown>,\n isError: true,\n ...(errorSchema\n ? {\n structuredContent: {\n collectionSlug,\n docs,\n errors,\n schema: errorSchema,\n },\n }\n : {}),\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 formatCollectionError({ action: 'updating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","localAPIDefaults","getCollectionInputSchema","transformPointDataToPayload","whereSchema","validateCollectionData","formatCollectionError","DEFAULT_DESCRIPTION","updateDocumentTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","data","record","unknown","depth","default","draft","boolean","fallbackLocale","filePath","locale","overrideLock","overwriteExistingFiles","select","where","handler","authorizedMCP","collectionSlug","req","payload","logger","info","content","type","text","virtualFieldNames","config","inputData","validationError","partial","parsedData","whereClause","result","update","collection","JSON","stringify","doc","docs","errors","responseText","length","errorSchema","isError","structuredContent","schema","error","errorMessage","Error","message","action"],"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,wBAAwB,QAAQ,0DAAyD;AAClG,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBX,qBAAqB;IACrDY,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaR;IACbS,OAAOpB,EAAEqB,MAAM,CAAC;QACdC,IAAItB,EAAEuB,KAAK,CAAC;YAACvB,EAAEwB,MAAM;YAAIxB,EAAEyB,MAAM;SAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;QAC3FC,MAAM5B,EAAE6B,MAAM,CAAC7B,EAAEwB,MAAM,IAAIxB,EAAE8B,OAAO,IAAIJ,QAAQ,CAAC;QACjDK,OAAO/B,EACJyB,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAOjC,EACJkC,OAAO,GACPR,QAAQ,CAAC,6CACTC,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgBnC,EACbwB,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,UAAUpC,EAAEwB,MAAM,GAAGE,QAAQ,CAAC,8BAA8BC,QAAQ;QACpEU,QAAQrC,EACLwB,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;QACXW,cAActC,EACXkC,OAAO,GACPR,QAAQ,CAAC,sCACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,wBAAwBvC,EACrBkC,OAAO,GACPR,QAAQ,CAAC,uCACTC,QAAQ,GACRK,OAAO,CAAC;QACXQ,QAAQxC,EACL6B,MAAM,CAAC7B,EAAEwB,MAAM,IAAIxB,EAAE8B,OAAO,IAC5BJ,QAAQ,CACP,sGAEDC,QAAQ;QACXc,OAAOjC,YACJkB,QAAQ,CACP,yJAEDC,QAAQ;IACb;AACF,GAAGe,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,cAAc,EAAExB,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAS7C,UAAU;QAAE4C;IAAQ;IAEnC,MAAM,EACJxB,EAAE,EACFM,IAAI,EACJG,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,MAAM,EACNC,KAAK,EACN,GAAGrB;IAEJ2B,OAAOC,IAAI,CACT,CAAC,iCAAiC,EAAEJ,iBAAiBtB,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEW,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACf,MAAM,CAACmB,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,oBAAoBjD,+BAA+B2C,QAAQO,MAAM,EAAET;QACzE,MAAMU,YAAYlD,mBAAmBwB,MAAMwB;QAC3C,MAAMG,kBAAkB9C,uBAAuB;YAC7CmC;YACAhB,MAAM0B;YACNE,SAAS;YACTX;QACF;QAEA,IAAIU,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAME,aAAalD,4BAA4B+C;QAE/C,MAAMI,cAAqBjB,SAAS,CAAC;QAErC,IAAInB,IAAI;YACN,MAAMqC,SAAS,MAAMb,QAAQc,MAAM,CAAC;gBAClCtC;gBACAuC,YAAYjB;gBACZhB,MAAM6B;gBACN1B;gBACAE;gBACAK;gBACAO;gBACA,GAAGxC,iBAAiBsC,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,GAAIK,SAAS;oBAAEA,QAAQA;gBAAqB,IAAI,CAAC,CAAC;YACpD;YAEA,OAAO;gBACLS,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEP,eAAe,mCAAmC,EAAEkB,KAAKC,SAAS,CAACJ,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDK,KAAKL;YACP;QACF;QAEA,MAAMA,SAAS,MAAMb,QAAQc,MAAM,CAAC;YAClCC,YAAYjB;YACZhB,MAAM6B;YACN1B;YACAE;YACAK;YACAO;YACAJ,OAAOiB;YACP,GAAGrD,iBAAiBsC,cAAc;YAClC,GAAIP,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,GAAIK,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEA,MAAMyB,OAAON,OAAOM,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASP,OAAOO,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,0CAA0C,EAAEvB,eAAe,aAAa,EAAEqB,KAAKG,MAAM,CAAC,oBAAoB,EAAEF,OAAOE,MAAM,CAAC,KAAK,CAAC;QACpJ,IAAIH,KAAKG,MAAM,GAAG,GAAG;YACnBD,gBAAgB,CAAC,oCAAoC,EAAEL,KAAKC,SAAS,CAACE,MAAM,QAAQ,CAAC;QACvF;QACA,IAAIC,OAAOE,MAAM,GAAG,GAAG;YACrBD,gBAAgB,CAAC,yBAAyB,EAAEL,KAAKC,SAAS,CAACG,QAAQ,QAAQ,CAAC;YAE5E,MAAMG,cAAc/D,yBAAyB;gBAAEsC;gBAAgBC;YAAI;YAEnE,IAAIwB,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEL,KAAKC,SAAS,CAACM,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLpB,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMgB;oBAAa;iBAAE;gBAC/CH,KAAK;oBAAEC;oBAAMC;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB3B;wBACAqB;wBACAC;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLpB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMgB;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D7B,OAAO0B,KAAK,CAAC,CAAC,2BAA2B,EAAE7B,eAAe,EAAE,EAAE8B,cAAc;QAC5E,OAAOhE,sBAAsB;YAAEmE,QAAQ;YAAYjC;YAAgB6B;YAAO5B;QAAI;IAChF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"getConfigInfoTool.d.ts","sourceRoot":"","sources":["../../../src/mcp/builtin/getConfigInfoTool.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,+BAuC5B,CAAA"}
1
+ {"version":3,"file":"getConfigInfoTool.d.ts","sourceRoot":"","sources":["../../../src/mcp/builtin/getConfigInfoTool.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,+BA8C5B,CAAA"}
@@ -1,6 +1,13 @@
1
1
  import { getAccessResults, isEntityHidden } from 'payload';
2
2
  import { defineTool } from '../../defineTool.js';
3
3
  export const getConfigInfoTool = defineTool({
4
+ annotations: {
5
+ destructiveHint: false,
6
+ idempotentHint: true,
7
+ openWorldHint: false,
8
+ readOnlyHint: true,
9
+ title: 'Config Info'
10
+ },
4
11
  description: 'List the Payload collection and global slugs visible to this MCP client.'
5
12
  }).handler(async ({ authorizedMCP, req })=>{
6
13
  const user = authorizedMCP.user ?? req.user ?? null;
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/mcp/builtin/getConfigInfoTool.ts"],"sourcesContent":["import { getAccessResults, isEntityHidden } from 'payload'\n\nimport { defineTool } from '../../defineTool.js'\n\nexport const getConfigInfoTool = defineTool({\n description: 'List the Payload collection and global slugs visible to this MCP client.',\n}).handler(async ({ authorizedMCP, req }) => {\n const user = authorizedMCP.user ?? req.user ?? null\n const permissions = user ? await getAccessResults({ req: { ...req, user } }) : null\n\n const collections: string[] = []\n const globals: string[] = []\n\n for (const collection of req.payload.config.collections) {\n if (user && isEntityHidden({ hidden: collection.admin.hidden, user })) {\n continue\n }\n if (user && !permissions?.collections?.[collection.slug]?.read) {\n continue\n }\n\n collections.push(collection.slug)\n }\n\n for (const global of req.payload.config.globals) {\n if (user && isEntityHidden({ hidden: global.admin.hidden, user })) {\n continue\n }\n if (user && !permissions?.globals?.[global.slug]?.read) {\n continue\n }\n\n globals.push(global.slug)\n }\n\n return {\n content: [\n {\n type: 'text',\n text: `Collections: ${collections.join(', ') || 'none'}\\nGlobals: ${globals.join(', ') || 'none'}`,\n },\n ],\n }\n})\n"],"names":["getAccessResults","isEntityHidden","defineTool","getConfigInfoTool","description","handler","authorizedMCP","req","user","permissions","collections","globals","collection","payload","config","hidden","admin","slug","read","push","global","content","type","text","join"],"mappings":"AAAA,SAASA,gBAAgB,EAAEC,cAAc,QAAQ,UAAS;AAE1D,SAASC,UAAU,QAAQ,sBAAqB;AAEhD,OAAO,MAAMC,oBAAoBD,WAAW;IAC1CE,aAAa;AACf,GAAGC,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,GAAG,EAAE;IACtC,MAAMC,OAAOF,cAAcE,IAAI,IAAID,IAAIC,IAAI,IAAI;IAC/C,MAAMC,cAAcD,OAAO,MAAMR,iBAAiB;QAAEO,KAAK;YAAE,GAAGA,GAAG;YAAEC;QAAK;IAAE,KAAK;IAE/E,MAAME,cAAwB,EAAE;IAChC,MAAMC,UAAoB,EAAE;IAE5B,KAAK,MAAMC,cAAcL,IAAIM,OAAO,CAACC,MAAM,CAACJ,WAAW,CAAE;QACvD,IAAIF,QAAQP,eAAe;YAAEc,QAAQH,WAAWI,KAAK,CAACD,MAAM;YAAEP;QAAK,IAAI;YACrE;QACF;QACA,IAAIA,QAAQ,CAACC,aAAaC,aAAa,CAACE,WAAWK,IAAI,CAAC,EAAEC,MAAM;YAC9D;QACF;QAEAR,YAAYS,IAAI,CAACP,WAAWK,IAAI;IAClC;IAEA,KAAK,MAAMG,UAAUb,IAAIM,OAAO,CAACC,MAAM,CAACH,OAAO,CAAE;QAC/C,IAAIH,QAAQP,eAAe;YAAEc,QAAQK,OAAOJ,KAAK,CAACD,MAAM;YAAEP;QAAK,IAAI;YACjE;QACF;QACA,IAAIA,QAAQ,CAACC,aAAaE,SAAS,CAACS,OAAOH,IAAI,CAAC,EAAEC,MAAM;YACtD;QACF;QAEAP,QAAQQ,IAAI,CAACC,OAAOH,IAAI;IAC1B;IAEA,OAAO;QACLI,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,aAAa,EAAEb,YAAYc,IAAI,CAAC,SAAS,OAAO,WAAW,EAAEb,QAAQa,IAAI,CAAC,SAAS,QAAQ;YACpG;SACD;IACH;AACF,GAAE"}
1
+ {"version":3,"sources":["../../../src/mcp/builtin/getConfigInfoTool.ts"],"sourcesContent":["import { getAccessResults, isEntityHidden } from 'payload'\n\nimport { defineTool } from '../../defineTool.js'\n\nexport const getConfigInfoTool = defineTool({\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Config Info',\n },\n description: 'List the Payload collection and global slugs visible to this MCP client.',\n}).handler(async ({ authorizedMCP, req }) => {\n const user = authorizedMCP.user ?? req.user ?? null\n const permissions = user ? await getAccessResults({ req: { ...req, user } }) : null\n\n const collections: string[] = []\n const globals: string[] = []\n\n for (const collection of req.payload.config.collections) {\n if (user && isEntityHidden({ hidden: collection.admin.hidden, user })) {\n continue\n }\n if (user && !permissions?.collections?.[collection.slug]?.read) {\n continue\n }\n\n collections.push(collection.slug)\n }\n\n for (const global of req.payload.config.globals) {\n if (user && isEntityHidden({ hidden: global.admin.hidden, user })) {\n continue\n }\n if (user && !permissions?.globals?.[global.slug]?.read) {\n continue\n }\n\n globals.push(global.slug)\n }\n\n return {\n content: [\n {\n type: 'text',\n text: `Collections: ${collections.join(', ') || 'none'}\\nGlobals: ${globals.join(', ') || 'none'}`,\n },\n ],\n }\n})\n"],"names":["getAccessResults","isEntityHidden","defineTool","getConfigInfoTool","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","handler","authorizedMCP","req","user","permissions","collections","globals","collection","payload","config","hidden","admin","slug","read","push","global","content","type","text","join"],"mappings":"AAAA,SAASA,gBAAgB,EAAEC,cAAc,QAAQ,UAAS;AAE1D,SAASC,UAAU,QAAQ,sBAAqB;AAEhD,OAAO,MAAMC,oBAAoBD,WAAW;IAC1CE,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAa;AACf,GAAGC,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,GAAG,EAAE;IACtC,MAAMC,OAAOF,cAAcE,IAAI,IAAID,IAAIC,IAAI,IAAI;IAC/C,MAAMC,cAAcD,OAAO,MAAMd,iBAAiB;QAAEa,KAAK;YAAE,GAAGA,GAAG;YAAEC;QAAK;IAAE,KAAK;IAE/E,MAAME,cAAwB,EAAE;IAChC,MAAMC,UAAoB,EAAE;IAE5B,KAAK,MAAMC,cAAcL,IAAIM,OAAO,CAACC,MAAM,CAACJ,WAAW,CAAE;QACvD,IAAIF,QAAQb,eAAe;YAAEoB,QAAQH,WAAWI,KAAK,CAACD,MAAM;YAAEP;QAAK,IAAI;YACrE;QACF;QACA,IAAIA,QAAQ,CAACC,aAAaC,aAAa,CAACE,WAAWK,IAAI,CAAC,EAAEC,MAAM;YAC9D;QACF;QAEAR,YAAYS,IAAI,CAACP,WAAWK,IAAI;IAClC;IAEA,KAAK,MAAMG,UAAUb,IAAIM,OAAO,CAACC,MAAM,CAACH,OAAO,CAAE;QAC/C,IAAIH,QAAQb,eAAe;YAAEoB,QAAQK,OAAOJ,KAAK,CAACD,MAAM;YAAEP;QAAK,IAAI;YACjE;QACF;QACA,IAAIA,QAAQ,CAACC,aAAaE,SAAS,CAACS,OAAOH,IAAI,CAAC,EAAEC,MAAM;YACtD;QACF;QAEAP,QAAQQ,IAAI,CAACC,OAAOH,IAAI;IAC1B;IAEA,OAAO;QACLI,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,aAAa,EAAEb,YAAYc,IAAI,CAAC,SAAS,OAAO,WAAW,EAAEb,QAAQa,IAAI,CAAC,SAAS,QAAQ;YACpG;SACD;IACH;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,cAAc,wCAqFzB,CAAA"}
1
+ {"version":3,"file":"findTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,cAAc,wCA2FzB,CAAA"}
@@ -4,19 +4,27 @@ import { getLogger } from '../../../utils/getLogger.js';
4
4
  import { localAPIDefaults } from '../../../utils/localAPIDefaults.js';
5
5
  const DEFAULT_DESCRIPTION = 'Find any Payload global by passing the global slug.';
6
6
  export const findGlobalTool = defineGlobalTool({
7
+ annotations: {
8
+ destructiveHint: false,
9
+ idempotentHint: true,
10
+ openWorldHint: false,
11
+ readOnlyHint: true,
12
+ title: 'Find Global'
13
+ },
7
14
  description: DEFAULT_DESCRIPTION,
8
15
  input: z.object({
9
16
  depth: z.number().int().min(0).max(10).describe('Depth of population for relationships').optional().default(0),
10
17
  fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
11
18
  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()
19
+ populate: z.record(z.string(), z.unknown()).describe('Optional: control which fields to include from populated relationship or upload documents.').optional(),
20
+ select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}').optional()
13
21
  })
14
22
  }).handler(async ({ authorizedMCP, globalSlug, input, req })=>{
15
23
  const payload = req.payload;
16
24
  const logger = getLogger({
17
25
  payload
18
26
  });
19
- const { depth, fallbackLocale, locale, select } = input;
27
+ const { depth, fallbackLocale, locale, populate, select } = input;
20
28
  logger.info(`Reading global: ${globalSlug}, depth: ${depth}${locale ? `, locale: ${locale}` : ''}`);
21
29
  try {
22
30
  const findOptions = {
@@ -24,30 +32,17 @@ export const findGlobalTool = defineGlobalTool({
24
32
  depth,
25
33
  ...localAPIDefaults(authorizedMCP)
26
34
  };
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
35
  if (locale) {
44
36
  findOptions.locale = locale;
45
37
  }
46
38
  if (fallbackLocale) {
47
39
  findOptions.fallbackLocale = fallbackLocale;
48
40
  }
49
- if (selectClause) {
50
- findOptions.select = selectClause;
41
+ if (select) {
42
+ findOptions.select = select;
43
+ }
44
+ if (populate) {
45
+ findOptions.populate = populate;
51
46
  }
52
47
  const result = await payload.findGlobal(findOptions);
53
48
  return {
@@ -1 +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 any Payload global by passing the global slug.'\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"}
1
+ {"version":3,"sources":["../../../../src/mcp/builtin/globals/findTool.ts"],"sourcesContent":["import type { PopulateType, 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 any Payload global by passing the global slug.'\n\nexport const findGlobalTool = defineGlobalTool({\n annotations: {\n destructiveHint: false,\n idempotentHint: true,\n openWorldHint: false,\n readOnlyHint: true,\n title: 'Find Global',\n },\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 populate: z\n .record(z.string(), z.unknown())\n .describe(\n 'Optional: control which fields to include from populated relationship or upload documents.',\n )\n .optional(),\n select: z\n .record(z.string(), z.unknown())\n .describe(\n 'Optional: define exactly which fields you\\'d like to return in the response, 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, populate, 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 if (locale) {\n findOptions.locale = locale\n }\n if (fallbackLocale) {\n findOptions.fallbackLocale = fallbackLocale\n }\n if (select) {\n findOptions.select = select as SelectType\n }\n if (populate) {\n findOptions.populate = populate as PopulateType\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","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","depth","number","int","min","max","describe","optional","default","fallbackLocale","string","locale","populate","record","unknown","select","handler","authorizedMCP","globalSlug","req","payload","logger","info","findOptions","slug","result","findGlobal","content","type","text","JSON","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,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaR;IACbS,OAAOb,EAAEc,MAAM,CAAC;QACdC,OAAOf,EACJgB,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,yCACTC,QAAQ,GACRC,OAAO,CAAC;QACXC,gBAAgBvB,EACbwB,MAAM,GACNJ,QAAQ,CAAC,gFACTC,QAAQ;QACXI,QAAQzB,EACLwB,MAAM,GACNJ,QAAQ,CACP,wHAEDC,QAAQ;QACXK,UAAU1B,EACP2B,MAAM,CAAC3B,EAAEwB,MAAM,IAAIxB,EAAE4B,OAAO,IAC5BR,QAAQ,CACP,8FAEDC,QAAQ;QACXQ,QAAQ7B,EACL2B,MAAM,CAAC3B,EAAEwB,MAAM,IAAIxB,EAAE4B,OAAO,IAC5BR,QAAQ,CACP,sGAEDC,QAAQ;IACb;AACF,GAAGS,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEC,UAAU,EAAEnB,KAAK,EAAEoB,GAAG,EAAE;IACzD,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASjC,UAAU;QAAEgC;IAAQ;IAEnC,MAAM,EAAEnB,KAAK,EAAEQ,cAAc,EAAEE,MAAM,EAAEC,QAAQ,EAAEG,MAAM,EAAE,GAAGhB;IAE5DsB,OAAOC,IAAI,CACT,CAAC,gBAAgB,EAAEJ,WAAW,SAAS,EAAEjB,QAAQU,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAGxF,IAAI;QACF,MAAMY,cAAwD;YAC5DC,MAAMN;YACNjB;YACA,GAAGZ,iBAAiB4B,cAAc;QACpC;QAEA,IAAIN,QAAQ;YACVY,YAAYZ,MAAM,GAAGA;QACvB;QACA,IAAIF,gBAAgB;YAClBc,YAAYd,cAAc,GAAGA;QAC/B;QACA,IAAIM,QAAQ;YACVQ,YAAYR,MAAM,GAAGA;QACvB;QACA,IAAIH,UAAU;YACZW,YAAYX,QAAQ,GAAGA;QACzB;QAEA,MAAMa,SAAS,MAAML,QAAQM,UAAU,CAACH;QAExC,OAAO;YACLI,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,QAAQ,EAAEX,WAAW,gBAAgB,EAAEY,KAAKC,SAAS,CAACN,QAAQ,QAAQ,CAAC;gBAChF;aACD;YACDO,KAAKP;QACP;IACF,EAAE,OAAOQ,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9Df,OAAOY,KAAK,CAAC,CAAC,qBAAqB,EAAEf,WAAW,EAAE,EAAEgB,cAAc;QAClE,OAAO;YACLP,SAAS;gBACP;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,0BAA0B,EAAEX,WAAW,KAAK,EAAEgB,cAAc;gBAAC;aACrF;QACH;IACF;AACF,GAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"getGlobalSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/getGlobalSchemaTool.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB,wCAwB9B,CAAA"}
1
+ {"version":3,"file":"getGlobalSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/globals/getGlobalSchemaTool.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB,wCA+B9B,CAAA"}