@payloadcms/plugin-mcp 4.0.0-internal.c3ac604 → 4.0.0-internal.cc18726

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 (151) hide show
  1. package/dist/endpoint/access.js +2 -2
  2. package/dist/endpoint/access.js.map +1 -1
  3. package/dist/mcp/buildMcpServer.d.ts +1 -1
  4. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  5. package/dist/mcp/buildMcpServer.js +35 -23
  6. package/dist/mcp/buildMcpServer.js.map +1 -1
  7. package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -1
  8. package/dist/mcp/builtin/collections/authTools.js +79 -56
  9. package/dist/mcp/builtin/collections/authTools.js.map +1 -1
  10. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  11. package/dist/mcp/builtin/collections/countTool.js +9 -14
  12. package/dist/mcp/builtin/collections/countTool.js.map +1 -1
  13. package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -1
  14. package/dist/mcp/builtin/collections/countVersionsTool.js +9 -13
  15. package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -1
  16. package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
  17. package/dist/mcp/builtin/collections/createTool.js +20 -28
  18. package/dist/mcp/builtin/collections/createTool.js.map +1 -1
  19. package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
  20. package/dist/mcp/builtin/collections/deleteTool.js +40 -43
  21. package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
  22. package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -1
  23. package/dist/mcp/builtin/collections/duplicateTool.js +15 -34
  24. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  25. package/dist/mcp/builtin/collections/fileInput.d.ts +21 -21
  26. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -1
  27. package/dist/mcp/builtin/collections/fileInput.js +19 -20
  28. package/dist/mcp/builtin/collections/fileInput.js.map +1 -1
  29. package/dist/mcp/builtin/collections/fileInput.spec.js +2 -2
  30. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -1
  31. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/findDistinctTool.js +11 -26
  33. package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -1
  34. package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
  35. package/dist/mcp/builtin/collections/findTool.js +21 -43
  36. package/dist/mcp/builtin/collections/findTool.js.map +1 -1
  37. package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -1
  38. package/dist/mcp/builtin/collections/findVersionByIDTool.js +17 -26
  39. package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -1
  40. package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -1
  41. package/dist/mcp/builtin/collections/findVersionsTool.js +16 -30
  42. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  43. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +2 -2
  44. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/formatCollectionError.js +6 -6
  46. package/dist/mcp/builtin/collections/formatCollectionError.js.map +1 -1
  47. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  48. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +12 -12
  49. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  50. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  51. package/dist/mcp/builtin/collections/restoreVersionTool.js +14 -26
  52. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  53. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  54. package/dist/mcp/builtin/collections/updateTool.js +35 -77
  55. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  56. package/dist/mcp/builtin/collections/uploadInstructionsTool.js +11 -11
  57. package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -1
  58. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  59. package/dist/mcp/builtin/getConfigInfoTool.js +3 -2
  60. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  61. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  62. package/dist/mcp/builtin/globals/countVersionsTool.js +9 -13
  63. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  64. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  65. package/dist/mcp/builtin/globals/findTool.js +10 -16
  66. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  67. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  68. package/dist/mcp/builtin/globals/findVersionByIDTool.js +13 -24
  69. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  70. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  71. package/dist/mcp/builtin/globals/findVersionsTool.js +13 -29
  72. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  73. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  74. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +11 -11
  75. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  76. package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -1
  77. package/dist/mcp/builtin/globals/restoreVersionTool.js +15 -22
  78. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  79. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  80. package/dist/mcp/builtin/globals/updateTool.js +18 -23
  81. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  82. package/dist/mcp/builtin/validateEntityData.d.ts +4 -4
  83. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -1
  84. package/dist/mcp/builtin/validateEntityData.js +7 -7
  85. package/dist/mcp/builtin/validateEntityData.js.map +1 -1
  86. package/dist/types.d.ts +4 -4
  87. package/dist/types.d.ts.map +1 -1
  88. package/dist/types.js.map +1 -1
  89. package/package.json +4 -6
  90. package/src/endpoint/access.ts +2 -3
  91. package/src/mcp/buildMcpServer.ts +39 -29
  92. package/src/mcp/builtin/collections/authTools.ts +77 -69
  93. package/src/mcp/builtin/collections/countTool.ts +9 -21
  94. package/src/mcp/builtin/collections/countVersionsTool.ts +9 -18
  95. package/src/mcp/builtin/collections/createTool.ts +25 -69
  96. package/src/mcp/builtin/collections/deleteTool.ts +36 -64
  97. package/src/mcp/builtin/collections/duplicateTool.ts +21 -83
  98. package/src/mcp/builtin/collections/fileInput.spec.ts +2 -2
  99. package/src/mcp/builtin/collections/fileInput.ts +30 -25
  100. package/src/mcp/builtin/collections/findDistinctTool.ts +11 -63
  101. package/src/mcp/builtin/collections/findTool.ts +21 -103
  102. package/src/mcp/builtin/collections/findVersionByIDTool.ts +15 -58
  103. package/src/mcp/builtin/collections/findVersionsTool.ts +14 -85
  104. package/src/mcp/builtin/collections/formatCollectionError.ts +8 -8
  105. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +11 -11
  106. package/src/mcp/builtin/collections/restoreVersionTool.ts +14 -56
  107. package/src/mcp/builtin/collections/updateTool.ts +45 -99
  108. package/src/mcp/builtin/collections/uploadInstructionsTool.ts +12 -12
  109. package/src/mcp/builtin/getConfigInfoTool.ts +2 -1
  110. package/src/mcp/builtin/globals/countVersionsTool.ts +9 -17
  111. package/src/mcp/builtin/globals/findTool.ts +12 -51
  112. package/src/mcp/builtin/globals/findVersionByIDTool.ts +13 -52
  113. package/src/mcp/builtin/globals/findVersionsTool.ts +14 -92
  114. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +10 -10
  115. package/src/mcp/builtin/globals/restoreVersionTool.ts +14 -45
  116. package/src/mcp/builtin/globals/updateTool.ts +34 -52
  117. package/src/mcp/builtin/validateEntityData.ts +10 -13
  118. package/src/types.ts +4 -4
  119. package/dist/utils/getVirtualFieldNames.d.ts +0 -14
  120. package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
  121. package/dist/utils/getVirtualFieldNames.js +0 -35
  122. package/dist/utils/getVirtualFieldNames.js.map +0 -1
  123. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +0 -28
  124. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +0 -1
  125. package/dist/utils/schemaConversion/filterFieldsByAccess.js +0 -71
  126. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +0 -1
  127. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +0 -13
  128. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +0 -1
  129. package/dist/utils/schemaConversion/getEntityInputSchema.js +0 -66
  130. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +0 -1
  131. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +0 -10
  132. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +0 -1
  133. package/dist/utils/schemaConversion/sanitizeEntitySchema.js +0 -384
  134. package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +0 -1
  135. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +0 -133
  136. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +0 -1
  137. package/dist/utils/transformPointDataToPayload.d.ts +0 -7
  138. package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
  139. package/dist/utils/transformPointDataToPayload.js +0 -28
  140. package/dist/utils/transformPointDataToPayload.js.map +0 -1
  141. package/dist/utils/whereSchema.d.ts +0 -9
  142. package/dist/utils/whereSchema.d.ts.map +0 -1
  143. package/dist/utils/whereSchema.js +0 -13
  144. package/dist/utils/whereSchema.js.map +0 -1
  145. package/src/utils/getVirtualFieldNames.ts +0 -53
  146. package/src/utils/schemaConversion/filterFieldsByAccess.ts +0 -123
  147. package/src/utils/schemaConversion/getEntityInputSchema.ts +0 -96
  148. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +0 -96
  149. package/src/utils/schemaConversion/sanitizeEntitySchema.ts +0 -432
  150. package/src/utils/transformPointDataToPayload.ts +0 -40
  151. package/src/utils/whereSchema.ts +0 -24
@@ -1,18 +1,15 @@
1
- import type { PopulateType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { findDistinctInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
7
5
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { whereSchema } from '../../../utils/whereSchema.js'
9
6
 
10
7
  const DEFAULT_DESCRIPTION =
11
8
  'Find distinct values for a field in any collection by passing the collection slug and field path.'
12
9
 
13
10
  export const findDistinctTool = defineCollectionTool({
14
11
  access: (args) =>
15
- defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.read),
16
13
  annotations: {
17
14
  destructiveHint: false,
18
15
  idempotentHint: true,
@@ -21,65 +18,17 @@ export const findDistinctTool = defineCollectionTool({
21
18
  title: 'Find Distinct',
22
19
  },
23
20
  description: DEFAULT_DESCRIPTION,
24
- input: z.object({
25
- depth: z
26
- .number()
27
- .int()
28
- .min(0)
29
- .max(10)
30
- .describe('How many levels deep to populate relationships in distinct values')
31
- .optional()
32
- .default(0),
33
- field: z.string().describe('The field path to get distinct values for'),
34
- limit: z
35
- .number()
36
- .int()
37
- .min(1)
38
- .max(100)
39
- .describe('Maximum number of distinct values to return (max: 100)')
40
- .optional(),
41
- locale: z
42
- .string()
43
- .describe(
44
- 'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
45
- )
46
- .optional(),
47
- page: z.number().int().min(1).describe('Page number for pagination').optional(),
48
- populate: z
49
- .record(z.string(), z.unknown())
50
- .describe(
51
- 'Optional: control which fields to include from populated relationship or upload documents.',
52
- )
53
- .optional(),
54
- showHiddenFields: z
55
- .boolean()
56
- .describe('Optional: include hidden fields in the distinct query')
57
- .optional(),
58
- sort: z
59
- .string()
60
- .describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)')
61
- .optional(),
62
- trash: z
63
- .boolean()
64
- .describe('Optional: include soft-deleted documents when trash is enabled on the collection')
65
- .optional(),
66
- where: whereSchema
67
- .describe(
68
- 'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
69
- )
70
- .optional(),
71
- }),
72
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: findDistinctInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
73
23
  const payload = req.payload
74
24
  const logger = getLogger({ payload })
75
- const { depth, field, limit, locale, page, populate, showHiddenFields, sort, trash, where } =
76
- input
25
+ const { depth, field, limit, locale, page, populate, sort, trash, where } = input
77
26
 
78
- logger.info(`Finding distinct values in collection: ${collectionSlug}, field: ${field}`)
27
+ logger.info(`Finding distinct values in collection: ${slug}, field: ${field}`)
79
28
 
80
29
  try {
81
30
  const result = await payload.findDistinct({
82
- collection: collectionSlug,
31
+ collection: slug,
83
32
  depth,
84
33
  field,
85
34
  overrideAccess: authorizedMCP.overrideAccess,
@@ -87,8 +36,7 @@ export const findDistinctTool = defineCollectionTool({
87
36
  ...(limit ? { limit } : {}),
88
37
  ...(locale ? { locale } : {}),
89
38
  ...(page ? { page } : {}),
90
- ...(populate ? { populate: populate as PopulateType } : {}),
91
- ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
39
+ ...(populate ? { populate } : {}),
92
40
  ...(sort ? { sort } : {}),
93
41
  ...(trash !== undefined ? { trash } : {}),
94
42
  ...(where ? { where } : {}),
@@ -98,19 +46,19 @@ export const findDistinctTool = defineCollectionTool({
98
46
  content: [
99
47
  {
100
48
  type: 'text',
101
- text: `Distinct values for "${field}" in collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
49
+ text: `Distinct values for "${field}" in collection "${slug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
102
50
  },
103
51
  ],
104
52
  doc: result as unknown as Record<string, unknown>,
105
53
  }
106
54
  } catch (error) {
107
55
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
108
- logger.error(`Error finding distinct values in ${collectionSlug}: ${errorMessage}`)
56
+ logger.error(`Error finding distinct values in ${slug}: ${errorMessage}`)
109
57
  return {
110
58
  content: [
111
59
  {
112
60
  type: 'text',
113
- text: `❌ **Error finding distinct values in collection "${collectionSlug}":** ${errorMessage}`,
61
+ text: `❌ **Error finding distinct values in collection "${slug}":** ${errorMessage}`,
114
62
  },
115
63
  ],
116
64
  isError: true,
@@ -1,18 +1,15 @@
1
- import type { JoinQuery, PopulateType, SelectType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { findDocumentsInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
7
5
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { whereSchema } from '../../../utils/whereSchema.js'
9
6
 
10
7
  const DEFAULT_DESCRIPTION =
11
8
  'Find documents in any collection by passing the collection slug and optional ID or where clause.'
12
9
 
13
10
  export const findDocumentsTool = defineCollectionTool({
14
11
  access: (args) =>
15
- defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.read),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.read),
16
13
  annotations: {
17
14
  destructiveHint: false,
18
15
  idempotentHint: true,
@@ -21,87 +18,8 @@ export const findDocumentsTool = defineCollectionTool({
21
18
  title: 'Find Documents',
22
19
  },
23
20
  description: DEFAULT_DESCRIPTION,
24
- input: z.object({
25
- id: z
26
- .union([z.string(), z.number()])
27
- .describe(
28
- 'Optional: specific document ID to retrieve. If not provided, returns all documents',
29
- )
30
- .optional(),
31
- depth: z
32
- .number()
33
- .int()
34
- .min(0)
35
- .max(10)
36
- .describe('How many levels deep to populate relationships (default: 0)')
37
- .optional()
38
- .default(0),
39
- draft: z
40
- .boolean()
41
- .describe(
42
- 'For versioned collections, true returns the latest draft version when available. False reads the main document.',
43
- )
44
- .optional(),
45
- fallbackLocale: z
46
- .string()
47
- .describe('Optional: fallback locale code to use when requested locale is not available')
48
- .optional(),
49
- joins: z
50
- .union([z.record(z.string(), z.unknown()), z.literal(false)])
51
- .describe('Optional: configure join field queries, or pass false to disable all join fields.')
52
- .optional(),
53
- limit: z
54
- .number()
55
- .int()
56
- .min(1)
57
- .max(100)
58
- .describe('Maximum number of documents to return (default: 10, max: 100)')
59
- .optional()
60
- .default(10),
61
- locale: z
62
- .string()
63
- .describe(
64
- 'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
65
- )
66
- .optional(),
67
- page: z
68
- .number()
69
- .int()
70
- .min(1)
71
- .describe('Page number for pagination (default: 1)')
72
- .optional()
73
- .default(1),
74
- pagination: z
75
- .boolean()
76
- .describe('Optional: set to false to skip the count query overhead')
77
- .optional(),
78
- populate: z
79
- .record(z.string(), z.unknown())
80
- .describe(
81
- 'Optional: control which fields to include from populated relationship or upload documents.',
82
- )
83
- .optional(),
84
- select: z
85
- .record(z.string(), z.unknown())
86
- .describe(
87
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"title": true}',
88
- )
89
- .optional(),
90
- sort: z
91
- .string()
92
- .describe('Field to sort by (e.g., "createdAt", "-updatedAt" for descending)')
93
- .optional(),
94
- trash: z
95
- .boolean()
96
- .describe('Optional: include soft-deleted documents when trash is enabled on the collection')
97
- .optional(),
98
- where: whereSchema
99
- .describe(
100
- 'Optional: where clause for filtering. Use field names with Payload operators, and/or arrays for grouping. Example: {"title":{"contains":"test"}}',
101
- )
102
- .optional(),
103
- }),
104
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: findDocumentsInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
105
23
  const payload = req.payload
106
24
  const logger = getLogger({ payload })
107
25
 
@@ -123,7 +41,7 @@ export const findDocumentsTool = defineCollectionTool({
123
41
  } = input
124
42
 
125
43
  logger.info(
126
- `Reading document from collection: ${collectionSlug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
44
+ `Reading document from collection: ${slug}${id ? ` with ID: ${id}` : ''}, limit: ${limit}, page: ${page}${locale ? `, locale: ${locale}` : ''}`,
127
45
  )
128
46
 
129
47
  try {
@@ -131,15 +49,15 @@ export const findDocumentsTool = defineCollectionTool({
131
49
  try {
132
50
  const doc = await payload.findByID({
133
51
  id,
134
- collection: collectionSlug,
52
+ collection: slug,
135
53
  depth,
136
54
  overrideAccess: authorizedMCP.overrideAccess,
137
55
  req,
138
- ...(select && { select: select as SelectType }),
139
- ...(populate && { populate: populate as PopulateType }),
140
- ...(joins !== undefined && { joins: joins as JoinQuery }),
56
+ ...(select && { select }),
57
+ ...(populate && { populate }),
58
+ ...(joins !== undefined && { joins }),
141
59
  ...(locale && { locale }),
142
- ...(fallbackLocale && { fallbackLocale }),
60
+ ...(fallbackLocale !== undefined && { fallbackLocale }),
143
61
  ...(draft !== undefined && { draft }),
144
62
  ...(trash !== undefined && { trash }),
145
63
  })
@@ -148,18 +66,18 @@ export const findDocumentsTool = defineCollectionTool({
148
66
  content: [
149
67
  {
150
68
  type: 'text',
151
- text: `Document from collection "${collectionSlug}":\n${JSON.stringify(doc)}`,
69
+ text: `Document from collection "${slug}":\n${JSON.stringify(doc)}`,
152
70
  },
153
71
  ],
154
72
  doc: doc as Record<string, unknown>,
155
73
  }
156
74
  } catch {
157
- logger.warn(`Document not found with ID: ${id} in collection: ${collectionSlug}`)
75
+ logger.warn(`Document not found with ID: ${id} in collection: ${slug}`)
158
76
  return {
159
77
  content: [
160
78
  {
161
79
  type: 'text',
162
- text: `Error: Document with ID "${id}" not found in collection "${collectionSlug}"`,
80
+ text: `Error: Document with ID "${id}" not found in collection "${slug}"`,
163
81
  },
164
82
  ],
165
83
  }
@@ -167,17 +85,17 @@ export const findDocumentsTool = defineCollectionTool({
167
85
  }
168
86
 
169
87
  const findOptions: Parameters<typeof payload.find>[0] = {
170
- collection: collectionSlug,
88
+ collection: slug,
171
89
  depth,
172
90
  limit,
173
91
  overrideAccess: authorizedMCP.overrideAccess,
174
92
  page,
175
93
  req,
176
- ...(select && { select: select as SelectType }),
177
- ...(populate && { populate: populate as PopulateType }),
178
- ...(joins !== undefined && { joins: joins as JoinQuery }),
94
+ ...(select && { select }),
95
+ ...(populate && { populate }),
96
+ ...(joins !== undefined && { joins }),
179
97
  ...(locale && { locale }),
180
- ...(fallbackLocale && { fallbackLocale }),
98
+ ...(fallbackLocale !== undefined && { fallbackLocale }),
181
99
  ...(draft !== undefined && { draft }),
182
100
  ...(pagination !== undefined && { pagination }),
183
101
  ...(trash !== undefined && { trash }),
@@ -192,7 +110,7 @@ export const findDocumentsTool = defineCollectionTool({
192
110
 
193
111
  const result = await payload.find(findOptions)
194
112
 
195
- let responseText = `Collection: "${collectionSlug}"\nTotal: ${result.totalDocs} documents\nPage: ${result.page} of ${result.totalPages}\n`
113
+ let responseText = `Collection: "${slug}"\nTotal: ${result.totalDocs} documents\nPage: ${result.page} of ${result.totalPages}\n`
196
114
  for (const doc of result.docs) {
197
115
  responseText += `\n\`\`\`json\n${JSON.stringify(doc)}\n\`\`\``
198
116
  }
@@ -203,12 +121,12 @@ export const findDocumentsTool = defineCollectionTool({
203
121
  }
204
122
  } catch (error) {
205
123
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
206
- logger.error(`Error reading documents from collection ${collectionSlug}: ${errorMessage}`)
124
+ logger.error(`Error reading documents from collection ${slug}: ${errorMessage}`)
207
125
  return {
208
126
  content: [
209
127
  {
210
128
  type: 'text',
211
- text: `❌ **Error reading documents from collection "${collectionSlug}":** ${errorMessage}`,
129
+ text: `❌ **Error reading documents from collection "${slug}":** ${errorMessage}`,
212
130
  },
213
131
  ],
214
132
  }
@@ -1,6 +1,4 @@
1
- import type { PopulateType, SelectType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { findVersionByIDInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
@@ -11,8 +9,7 @@ const DEFAULT_DESCRIPTION =
11
9
 
12
10
  export const findVersionByIDTool = defineCollectionTool({
13
11
  access: (args) =>
14
- defaultAccess(args) &&
15
- Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.readVersions),
16
13
  annotations: {
17
14
  destructiveHint: false,
18
15
  idempotentHint: true,
@@ -21,66 +18,26 @@ export const findVersionByIDTool = defineCollectionTool({
21
18
  title: 'Find Version By ID',
22
19
  },
23
20
  description: DEFAULT_DESCRIPTION,
24
- input: z.object({
25
- id: z.string().describe('The ID of the version to retrieve'),
26
- depth: z
27
- .number()
28
- .int()
29
- .min(0)
30
- .max(10)
31
- .describe('How many levels deep to populate relationships in the version document')
32
- .optional()
33
- .default(0),
34
- fallbackLocale: z
35
- .string()
36
- .describe('Optional: fallback locale code to use when requested locale is not available')
37
- .optional(),
38
- locale: z
39
- .string()
40
- .describe(
41
- 'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
42
- )
43
- .optional(),
44
- populate: z
45
- .record(z.string(), z.unknown())
46
- .describe(
47
- 'Optional: control which fields to include from populated relationship or upload documents.',
48
- )
49
- .optional(),
50
- select: z
51
- .record(z.string(), z.unknown())
52
- .describe(
53
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"version.title": true}',
54
- )
55
- .optional(),
56
- showHiddenFields: z
57
- .boolean()
58
- .describe('Optional: include hidden fields in the returned version document')
59
- .optional(),
60
- trash: z
61
- .boolean()
62
- .describe('Optional: include soft-deleted version documents when trash is enabled')
63
- .optional(),
64
- }),
65
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: findVersionByIDInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
66
23
  const payload = req.payload
67
24
  const logger = getLogger({ payload })
68
- const { id, depth, fallbackLocale, locale, populate, select, showHiddenFields, trash } = input
25
+ const { id, depth, draft, fallbackLocale, locale, populate, select, trash } = input
69
26
 
70
- logger.info(`Finding version in collection: ${collectionSlug} with ID: ${id}`)
27
+ logger.info(`Finding version in collection: ${slug} with ID: ${id}`)
71
28
 
72
29
  try {
73
30
  const result = await payload.findVersionByID({
74
- id,
75
- collection: collectionSlug,
31
+ id: String(id),
32
+ collection: slug,
76
33
  depth,
77
34
  overrideAccess: authorizedMCP.overrideAccess,
78
35
  req,
79
- ...(fallbackLocale ? { fallbackLocale } : {}),
36
+ ...(draft !== undefined ? { draft } : {}),
37
+ ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
80
38
  ...(locale ? { locale } : {}),
81
- ...(populate ? { populate: populate as PopulateType } : {}),
82
- ...(select ? { select: select as SelectType } : {}),
83
- ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
39
+ ...(populate ? { populate } : {}),
40
+ ...(select ? { select } : {}),
84
41
  ...(trash !== undefined ? { trash } : {}),
85
42
  })
86
43
 
@@ -88,19 +45,19 @@ export const findVersionByIDTool = defineCollectionTool({
88
45
  content: [
89
46
  {
90
47
  type: 'text',
91
- text: `Version "${id}" from collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
48
+ text: `Version "${id}" from collection "${slug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
92
49
  },
93
50
  ],
94
51
  doc: result as unknown as Record<string, unknown>,
95
52
  }
96
53
  } catch (error) {
97
54
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
98
- logger.error(`Error finding version ${id} in ${collectionSlug}: ${errorMessage}`)
55
+ logger.error(`Error finding version ${id} in ${slug}: ${errorMessage}`)
99
56
  return {
100
57
  content: [
101
58
  {
102
59
  type: 'text',
103
- text: `❌ **Error finding version "${id}" in collection "${collectionSlug}":** ${errorMessage}`,
60
+ text: `❌ **Error finding version "${id}" in collection "${slug}":** ${errorMessage}`,
104
61
  },
105
62
  ],
106
63
  isError: true,
@@ -1,19 +1,15 @@
1
- import type { PopulateType, SelectType } from 'payload'
2
-
3
- import { z } from 'zod'
1
+ import { findVersionsInputSchema } from 'payload'
4
2
 
5
3
  import { defaultAccess } from '../../../defaultAccess.js'
6
4
  import { defineCollectionTool } from '../../../defineTool.js'
7
5
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { whereSchema } from '../../../utils/whereSchema.js'
9
6
 
10
7
  const DEFAULT_DESCRIPTION =
11
8
  'Find document versions in any version-enabled collection by passing the collection slug and optional where clause.'
12
9
 
13
10
  export const findVersionsTool = defineCollectionTool({
14
11
  access: (args) =>
15
- defaultAccess(args) &&
16
- Boolean(args.permissions?.collections?.[args.collectionSlug]?.readVersions),
12
+ defaultAccess(args) && Boolean(args.permissions?.collections?.[args.slug]?.readVersions),
17
13
  annotations: {
18
14
  destructiveHint: false,
19
15
  idempotentHint: true,
@@ -22,79 +18,13 @@ export const findVersionsTool = defineCollectionTool({
22
18
  title: 'Find Versions',
23
19
  },
24
20
  description: DEFAULT_DESCRIPTION,
25
- input: z.object({
26
- depth: z
27
- .number()
28
- .int()
29
- .min(0)
30
- .max(10)
31
- .describe('How many levels deep to populate relationships in version documents')
32
- .optional()
33
- .default(0),
34
- fallbackLocale: z
35
- .string()
36
- .describe('Optional: fallback locale code to use when requested locale is not available')
37
- .optional(),
38
- limit: z
39
- .number()
40
- .int()
41
- .min(1)
42
- .max(100)
43
- .describe('Maximum number of versions to return (default: 10, max: 100)')
44
- .optional()
45
- .default(10),
46
- locale: z
47
- .string()
48
- .describe(
49
- 'Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields',
50
- )
51
- .optional(),
52
- page: z
53
- .number()
54
- .int()
55
- .min(1)
56
- .describe('Page number for pagination (default: 1)')
57
- .optional()
58
- .default(1),
59
- pagination: z
60
- .boolean()
61
- .describe('Optional: set to false to skip the count query overhead')
62
- .optional(),
63
- populate: z
64
- .record(z.string(), z.unknown())
65
- .describe(
66
- 'Optional: control which fields to include from populated relationship or upload documents.',
67
- )
68
- .optional(),
69
- select: z
70
- .record(z.string(), z.unknown())
71
- .describe(
72
- 'Optional: define exactly which fields you\'d like to return in the response, e.g., {"version.title": true}',
73
- )
74
- .optional(),
75
- showHiddenFields: z
76
- .boolean()
77
- .describe('Optional: include hidden fields in returned version documents')
78
- .optional(),
79
- sort: z
80
- .string()
81
- .describe('Field to sort by (e.g., "-updatedAt", "-version.updatedAt" for descending)')
82
- .optional(),
83
- trash: z
84
- .boolean()
85
- .describe('Optional: include versions for soft-deleted documents when trash is enabled')
86
- .optional(),
87
- where: whereSchema
88
- .describe(
89
- 'Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.title":{"contains":"test"}}',
90
- )
91
- .optional(),
92
- }),
93
- }).handler(async ({ authorizedMCP, collectionSlug, input, req }) => {
21
+ input: findVersionsInputSchema,
22
+ }).handler(async ({ slug, authorizedMCP, input, req }) => {
94
23
  const payload = req.payload
95
24
  const logger = getLogger({ payload })
96
25
  const {
97
26
  depth,
27
+ draft,
98
28
  fallbackLocale,
99
29
  limit,
100
30
  locale,
@@ -102,28 +32,27 @@ export const findVersionsTool = defineCollectionTool({
102
32
  pagination,
103
33
  populate,
104
34
  select,
105
- showHiddenFields,
106
35
  sort,
107
36
  trash,
108
37
  where,
109
38
  } = input
110
39
 
111
- logger.info(`Finding versions in collection: ${collectionSlug}, limit: ${limit}, page: ${page}`)
40
+ logger.info(`Finding versions in collection: ${slug}, limit: ${limit}, page: ${page}`)
112
41
 
113
42
  try {
114
43
  const result = await payload.findVersions({
115
- collection: collectionSlug,
44
+ collection: slug,
116
45
  depth,
117
46
  limit,
118
47
  overrideAccess: authorizedMCP.overrideAccess,
119
48
  page,
120
49
  req,
121
- ...(fallbackLocale ? { fallbackLocale } : {}),
50
+ ...(draft !== undefined ? { draft } : {}),
51
+ ...(fallbackLocale !== undefined ? { fallbackLocale } : {}),
122
52
  ...(locale ? { locale } : {}),
123
53
  ...(pagination !== undefined ? { pagination } : {}),
124
- ...(populate ? { populate: populate as PopulateType } : {}),
125
- ...(select ? { select: select as SelectType } : {}),
126
- ...(showHiddenFields !== undefined ? { showHiddenFields } : {}),
54
+ ...(populate ? { populate } : {}),
55
+ ...(select ? { select } : {}),
127
56
  ...(sort ? { sort } : {}),
128
57
  ...(trash !== undefined ? { trash } : {}),
129
58
  ...(where ? { where } : {}),
@@ -133,19 +62,19 @@ export const findVersionsTool = defineCollectionTool({
133
62
  content: [
134
63
  {
135
64
  type: 'text',
136
- text: `Versions for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
65
+ text: `Versions for collection "${slug}":\n\`\`\`json\n${JSON.stringify(result)}\n\`\`\``,
137
66
  },
138
67
  ],
139
68
  doc: result as unknown as Record<string, unknown>,
140
69
  }
141
70
  } catch (error) {
142
71
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
143
- logger.error(`Error finding versions in ${collectionSlug}: ${errorMessage}`)
72
+ logger.error(`Error finding versions in ${slug}: ${errorMessage}`)
144
73
  return {
145
74
  content: [
146
75
  {
147
76
  type: 'text',
148
- text: `❌ **Error finding versions in collection "${collectionSlug}":** ${errorMessage}`,
77
+ text: `❌ **Error finding versions in collection "${slug}":** ${errorMessage}`,
149
78
  },
150
79
  ],
151
80
  isError: true,
@@ -1,8 +1,8 @@
1
1
  import type { CollectionSlug, PayloadRequest } from 'payload'
2
2
 
3
- import type { MCPToolResponse } from '../../../types.js'
3
+ import { getCollectionInputSchema } from 'payload'
4
4
 
5
- import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
5
+ import type { MCPToolResponse } from '../../../types.js'
6
6
 
7
7
  const getValidationErrors = (error: unknown): undefined | unknown[] => {
8
8
  if (!error || typeof error !== 'object') {
@@ -33,15 +33,15 @@ const isSchemaError = (error: unknown, message: string): boolean => {
33
33
  }
34
34
 
35
35
  export const formatCollectionError = ({
36
+ slug,
36
37
  action,
37
- collectionSlug,
38
38
  error,
39
39
  req,
40
40
  }: {
41
41
  action: 'creating' | 'duplicating' | 'updating'
42
- collectionSlug: CollectionSlug
43
42
  error: unknown
44
43
  req: PayloadRequest
44
+ slug: CollectionSlug
45
45
  }): MCPToolResponse => {
46
46
  const errorMessage = error instanceof Error ? error.message : 'Unknown error'
47
47
  const errors = getValidationErrors(error) ?? [{ message: errorMessage }]
@@ -51,14 +51,14 @@ export const formatCollectionError = ({
51
51
  content: [
52
52
  {
53
53
  type: 'text',
54
- text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}`,
54
+ text: `Error ${action} document in collection "${slug}": ${errorMessage}`,
55
55
  },
56
56
  ],
57
57
  isError: true,
58
58
  }
59
59
  }
60
60
 
61
- const schema = getCollectionInputSchema({ collectionSlug, req })
61
+ const schema = getCollectionInputSchema({ collectionSlug: slug, req })
62
62
  const schemaText = schema
63
63
  ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(schema)}\n\`\`\``
64
64
  : ''
@@ -67,14 +67,14 @@ export const formatCollectionError = ({
67
67
  content: [
68
68
  {
69
69
  type: 'text',
70
- text: `Error ${action} document in collection "${collectionSlug}": ${errorMessage}${schemaText}`,
70
+ text: `Error ${action} document in collection "${slug}": ${errorMessage}${schemaText}`,
71
71
  },
72
72
  ],
73
73
  isError: true,
74
74
  ...(schema
75
75
  ? {
76
76
  structuredContent: {
77
- collectionSlug,
77
+ slug,
78
78
  errors,
79
79
  schema,
80
80
  },