@payloadcms/plugin-mcp 4.0.0-internal.203916b → 4.0.0-internal.21664f3

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 (130) hide show
  1. package/bin.js +7 -0
  2. package/dist/defaultAccess.d.ts.map +1 -1
  3. package/dist/defineTool.d.ts +8 -8
  4. package/dist/defineTool.d.ts.map +1 -1
  5. package/dist/endpoint/access.d.ts +2 -7
  6. package/dist/endpoint/access.d.ts.map +1 -1
  7. package/dist/endpoint/access.js +4 -11
  8. package/dist/endpoint/access.js.map +1 -1
  9. package/dist/mcp/buildMcpServer.d.ts.map +1 -1
  10. package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -1
  11. package/dist/mcp/builtin/collections/countTool.js +1 -2
  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 +1 -2
  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 +14 -5
  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 +1 -2
  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 +1 -2
  24. package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -1
  25. package/dist/mcp/builtin/collections/fileInput.d.ts +20 -0
  26. package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
  27. package/dist/mcp/builtin/collections/fileInput.js +100 -0
  28. package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
  29. package/dist/mcp/builtin/collections/fileInput.spec.js +72 -0
  30. package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -0
  31. package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -1
  32. package/dist/mcp/builtin/collections/findDistinctTool.js +1 -2
  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 +3 -4
  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 +1 -2
  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 +1 -2
  42. package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -1
  43. package/dist/mcp/builtin/collections/formatCollectionError.d.ts +1 -1
  44. package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -1
  45. package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
  46. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +44 -5
  47. package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
  48. package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -1
  49. package/dist/mcp/builtin/collections/restoreVersionTool.js +1 -2
  50. package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -1
  51. package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
  52. package/dist/mcp/builtin/collections/updateTool.js +23 -11
  53. package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
  54. package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -1
  55. package/dist/mcp/builtin/getConfigInfoTool.js +2 -5
  56. package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -1
  57. package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -1
  58. package/dist/mcp/builtin/globals/countVersionsTool.js +1 -2
  59. package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -1
  60. package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -1
  61. package/dist/mcp/builtin/globals/findTool.js +2 -2
  62. package/dist/mcp/builtin/globals/findTool.js.map +1 -1
  63. package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -1
  64. package/dist/mcp/builtin/globals/findVersionByIDTool.js +1 -2
  65. package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -1
  66. package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -1
  67. package/dist/mcp/builtin/globals/findVersionsTool.js +1 -2
  68. package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -1
  69. package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -1
  70. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +21 -3
  71. package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -1
  72. package/dist/mcp/builtin/globals/restoreVersionTool.js +1 -2
  73. package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -1
  74. package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
  75. package/dist/mcp/builtin/globals/updateTool.js +2 -2
  76. package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
  77. package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -1
  78. package/dist/mcp/builtinTools.d.ts.map +1 -1
  79. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  80. package/dist/types.d.ts +44 -7
  81. package/dist/types.d.ts.map +1 -1
  82. package/dist/types.js +2 -4
  83. package/dist/types.js.map +1 -1
  84. package/dist/utils/camelCase.d.ts.map +1 -1
  85. package/dist/utils/resolveProjectRoot.d.ts.map +1 -1
  86. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts +28 -0
  87. package/dist/utils/schemaConversion/filterFieldsByAccess.d.ts.map +1 -0
  88. package/dist/utils/schemaConversion/filterFieldsByAccess.js +71 -0
  89. package/dist/utils/schemaConversion/filterFieldsByAccess.js.map +1 -0
  90. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +5 -3
  91. package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -1
  92. package/dist/utils/schemaConversion/getEntityInputSchema.js +40 -6
  93. package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -1
  94. package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -1
  95. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +2 -2
  96. package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -1
  97. package/dist/utils/toStandardSchema.d.ts.map +1 -1
  98. package/package.json +4 -4
  99. package/src/endpoint/access.ts +3 -10
  100. package/src/mcp/builtin/collections/countTool.ts +1 -2
  101. package/src/mcp/builtin/collections/countVersionsTool.ts +2 -6
  102. package/src/mcp/builtin/collections/createTool.ts +14 -5
  103. package/src/mcp/builtin/collections/deleteTool.ts +1 -2
  104. package/src/mcp/builtin/collections/duplicateTool.ts +1 -2
  105. package/src/mcp/builtin/collections/fileInput.spec.ts +79 -0
  106. package/src/mcp/builtin/collections/fileInput.ts +139 -0
  107. package/src/mcp/builtin/collections/findDistinctTool.ts +3 -3
  108. package/src/mcp/builtin/collections/findTool.ts +3 -4
  109. package/src/mcp/builtin/collections/findVersionByIDTool.ts +1 -2
  110. package/src/mcp/builtin/collections/findVersionsTool.ts +1 -2
  111. package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +39 -9
  112. package/src/mcp/builtin/collections/restoreVersionTool.ts +1 -2
  113. package/src/mcp/builtin/collections/updateTool.ts +25 -9
  114. package/src/mcp/builtin/getConfigInfoTool.ts +2 -4
  115. package/src/mcp/builtin/globals/countVersionsTool.ts +2 -6
  116. package/src/mcp/builtin/globals/findTool.ts +2 -2
  117. package/src/mcp/builtin/globals/findVersionByIDTool.ts +1 -2
  118. package/src/mcp/builtin/globals/findVersionsTool.ts +1 -2
  119. package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +25 -3
  120. package/src/mcp/builtin/globals/restoreVersionTool.ts +3 -3
  121. package/src/mcp/builtin/globals/updateTool.ts +2 -2
  122. package/src/types.ts +43 -7
  123. package/src/utils/schemaConversion/filterFieldsByAccess.ts +123 -0
  124. package/src/utils/schemaConversion/getEntityInputSchema.ts +47 -13
  125. package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +2 -2
  126. package/dist/utils/localAPIDefaults.d.ts +0 -20
  127. package/dist/utils/localAPIDefaults.d.ts.map +0 -1
  128. package/dist/utils/localAPIDefaults.js +0 -19
  129. package/dist/utils/localAPIDefaults.js.map +0 -1
  130. package/src/utils/localAPIDefaults.ts +0 -22
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -40,7 +39,7 @@ export const findDocumentsTool = defineCollectionTool({
40
39
  draft: z
41
40
  .boolean()
42
41
  .describe(
43
- 'Optional: whether the document should be queried from the versions table/collection or not.',
42
+ 'For versioned collections, true returns the latest draft version when available. False reads the main document.',
44
43
  )
45
44
  .optional(),
46
45
  fallbackLocale: z
@@ -134,8 +133,8 @@ export const findDocumentsTool = defineCollectionTool({
134
133
  id,
135
134
  collection: collectionSlug,
136
135
  depth,
136
+ overrideAccess: authorizedMCP.overrideAccess,
137
137
  req,
138
- ...localAPIDefaults(authorizedMCP),
139
138
  ...(select && { select: select as SelectType }),
140
139
  ...(populate && { populate: populate as PopulateType }),
141
140
  ...(joins !== undefined && { joins: joins as JoinQuery }),
@@ -171,9 +170,9 @@ export const findDocumentsTool = defineCollectionTool({
171
170
  collection: collectionSlug,
172
171
  depth,
173
172
  limit,
173
+ overrideAccess: authorizedMCP.overrideAccess,
174
174
  page,
175
175
  req,
176
- ...localAPIDefaults(authorizedMCP),
177
176
  ...(select && { select: select as SelectType }),
178
177
  ...(populate && { populate: populate as PopulateType }),
179
178
  ...(joins !== undefined && { joins: joins as JoinQuery }),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Find a specific document version in any version-enabled collection by passing the collection slug and version ID.'
@@ -75,8 +74,8 @@ export const findVersionByIDTool = defineCollectionTool({
75
74
  id,
76
75
  collection: collectionSlug,
77
76
  depth,
77
+ overrideAccess: authorizedMCP.overrideAccess,
78
78
  req,
79
- ...localAPIDefaults(authorizedMCP),
80
79
  ...(fallbackLocale ? { fallbackLocale } : {}),
81
80
  ...(locale ? { locale } : {}),
82
81
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -116,9 +115,9 @@ export const findVersionsTool = defineCollectionTool({
116
115
  collection: collectionSlug,
117
116
  depth,
118
117
  limit,
118
+ overrideAccess: authorizedMCP.overrideAccess,
119
119
  page,
120
120
  req,
121
- ...localAPIDefaults(authorizedMCP),
122
121
  ...(fallbackLocale ? { fallbackLocale } : {}),
123
122
  ...(locale ? { locale } : {}),
124
123
  ...(pagination !== undefined ? { pagination } : {}),
@@ -1,3 +1,5 @@
1
+ import { getAccessResults } from 'payload'
2
+
1
3
  import { defaultAccess } from '../../../defaultAccess.js'
2
4
  import { defineCollectionTool } from '../../../defineTool.js'
3
5
  import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
@@ -6,12 +8,7 @@ export const getCollectionSchemaTool = defineCollectionTool({
6
8
  access: (args) => {
7
9
  const permissions = args.permissions?.collections?.[args.collectionSlug]
8
10
 
9
- return (
10
- defaultAccess(args) &&
11
- Boolean(
12
- permissions?.create || permissions?.delete || permissions?.read || permissions?.update,
13
- )
14
- )
11
+ return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)
15
12
  },
16
13
  annotations: {
17
14
  destructiveHint: false,
@@ -21,8 +18,28 @@ export const getCollectionSchemaTool = defineCollectionTool({
21
18
  title: 'Get Collection Schema',
22
19
  },
23
20
  description: 'Get the input schema for creating or updating documents in a collection.',
24
- }).handler(({ collectionSlug, req }) => {
25
- const inputSchema = getCollectionInputSchema({ collectionSlug, req })
21
+ }).handler(async ({ authorizedMCP, collectionSlug, req }) => {
22
+ const permissions = authorizedMCP.overrideAccess
23
+ ? null
24
+ : (await getAccessResults({ req })).collections?.[collectionSlug]
25
+
26
+ if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {
27
+ return {
28
+ content: [
29
+ {
30
+ type: 'text',
31
+ text: `Error: MCP access to "getCollectionSchema" is not enabled for collection "${collectionSlug}"`,
32
+ },
33
+ ],
34
+ isError: true,
35
+ }
36
+ }
37
+
38
+ const inputSchema = getCollectionInputSchema({
39
+ collectionSlug,
40
+ req,
41
+ ...(permissions ? { permissions } : {}),
42
+ })
26
43
 
27
44
  if (!inputSchema) {
28
45
  return {
@@ -31,16 +48,29 @@ export const getCollectionSchemaTool = defineCollectionTool({
31
48
  }
32
49
  }
33
50
 
51
+ const uploadConfig = req.payload.collections[collectionSlug]?.config.upload
52
+ const maxFileSize = req.payload.config.upload.limits?.fileSize
53
+ const upload = uploadConfig
54
+ ? {
55
+ enabled: true,
56
+ filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,
57
+ mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],
58
+ sources: [...(uploadConfig.pasteURL !== false ? ['url'] : []), 'base64'],
59
+ ...(typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? { maxFileSize } : {}),
60
+ }
61
+ : { enabled: false }
62
+
34
63
  return {
35
64
  content: [
36
65
  {
37
66
  type: 'text',
38
- text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\``,
67
+ text: `Schema for collection "${collectionSlug}":\n\`\`\`json\n${JSON.stringify(inputSchema)}\n\`\`\`\nUpload configuration:\n\`\`\`json\n${JSON.stringify(upload)}\n\`\`\``,
39
68
  },
40
69
  ],
41
70
  structuredContent: {
42
71
  collectionSlug,
43
72
  schema: inputSchema,
73
+ upload,
44
74
  },
45
75
  }
46
76
  })
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineCollectionTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Restore a document from a previous version in any version-enabled collection.'
@@ -74,8 +73,8 @@ export const restoreVersionTool = defineCollectionTool({
74
73
  collection: collectionSlug,
75
74
  depth,
76
75
  draft,
76
+ overrideAccess: authorizedMCP.overrideAccess,
77
77
  req,
78
- ...localAPIDefaults(authorizedMCP),
79
78
  ...(fallbackLocale ? { fallbackLocale } : {}),
80
79
  ...(locale ? { locale } : {}),
81
80
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -9,11 +9,11 @@ import {
9
9
  getCollectionVirtualFieldNames,
10
10
  stripVirtualFields,
11
11
  } from '../../../utils/getVirtualFieldNames.js'
12
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
13
12
  import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
14
13
  import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
15
14
  import { whereSchema } from '../../../utils/whereSchema.js'
16
15
  import { validateCollectionData } from '../validateEntityData.js'
16
+ import { fileInputSchema, resolveFileInput } from './fileInput.js'
17
17
  import { formatCollectionError } from './formatCollectionError.js'
18
18
 
19
19
  const DEFAULT_DESCRIPTION =
@@ -32,7 +32,11 @@ export const updateDocumentTool = defineCollectionTool({
32
32
  description: DEFAULT_DESCRIPTION,
33
33
  input: z.object({
34
34
  id: z.union([z.string(), z.number()]).describe('The ID of the document to update').optional(),
35
- data: z.record(z.string(), z.unknown()).describe('The fields to update'),
35
+ data: z
36
+ .record(z.string(), z.unknown())
37
+ .describe(
38
+ 'The fields to update. Only include fields permitted by the schema returned by getCollectionSchema.',
39
+ ),
36
40
  depth: z
37
41
  .number()
38
42
  .describe('How many levels deep to populate relationships')
@@ -40,14 +44,16 @@ export const updateDocumentTool = defineCollectionTool({
40
44
  .default(0),
41
45
  draft: z
42
46
  .boolean()
43
- .describe('Whether to update the document as a draft')
47
+ .describe(
48
+ 'Only if getCollectionSchema includes _status; otherwise _status does not exist. true saves only a draft version; false updates main and versions. data._status: "published" overrides true.',
49
+ )
44
50
  .optional()
45
51
  .default(false),
46
52
  fallbackLocale: z
47
53
  .string()
48
54
  .describe('Optional: fallback locale code to use when requested locale is not available')
49
55
  .optional(),
50
- filePath: z.string().describe('File path for file uploads').optional(),
56
+ file: fileInputSchema.optional(),
51
57
  locale: z
52
58
  .string()
53
59
  .describe(
@@ -64,6 +70,12 @@ export const updateDocumentTool = defineCollectionTool({
64
70
  .describe('Whether to overwrite existing files')
65
71
  .optional()
66
72
  .default(false),
73
+ publishAllLocales: z
74
+ .boolean()
75
+ .describe(
76
+ 'For collections with localized publishing status, whether publishing should affect every locale. Set false with locale to publish only that locale.',
77
+ )
78
+ .optional(),
67
79
  select: z
68
80
  .record(z.string(), z.unknown())
69
81
  .describe(
@@ -86,10 +98,11 @@ export const updateDocumentTool = defineCollectionTool({
86
98
  depth,
87
99
  draft,
88
100
  fallbackLocale,
89
- filePath,
101
+ file: fileInput,
90
102
  locale,
91
103
  overrideLock,
92
104
  overwriteExistingFiles,
105
+ publishAllLocales,
93
106
  select,
94
107
  where,
95
108
  } = input
@@ -119,6 +132,7 @@ export const updateDocumentTool = defineCollectionTool({
119
132
  }
120
133
 
121
134
  const parsedData = transformPointDataToPayload(inputData)
135
+ const file = await resolveFileInput({ collectionSlug, input: fileInput, req })
122
136
 
123
137
  const whereClause: Where = where ?? {}
124
138
 
@@ -129,11 +143,12 @@ export const updateDocumentTool = defineCollectionTool({
129
143
  data: parsedData,
130
144
  depth,
131
145
  draft,
146
+ overrideAccess: authorizedMCP.overrideAccess,
132
147
  overrideLock,
133
148
  req,
134
- ...localAPIDefaults(authorizedMCP),
135
- ...(filePath ? { filePath } : {}),
149
+ ...(file ? { file } : {}),
136
150
  ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
151
+ ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
137
152
  ...(locale ? { locale } : {}),
138
153
  ...(fallbackLocale ? { fallbackLocale } : {}),
139
154
  ...(select ? { select: select as SelectType } : {}),
@@ -155,12 +170,13 @@ export const updateDocumentTool = defineCollectionTool({
155
170
  data: parsedData,
156
171
  depth,
157
172
  draft,
173
+ overrideAccess: authorizedMCP.overrideAccess,
158
174
  overrideLock,
159
175
  req,
160
176
  where: whereClause,
161
- ...localAPIDefaults(authorizedMCP),
162
- ...(filePath ? { filePath } : {}),
177
+ ...(file ? { file } : {}),
163
178
  ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),
179
+ ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),
164
180
  ...(locale ? { locale } : {}),
165
181
  ...(fallbackLocale ? { fallbackLocale } : {}),
166
182
  ...(select ? { select: select as SelectType } : {}),
@@ -12,10 +12,8 @@ export const getConfigInfoTool = defineTool({
12
12
  },
13
13
  description: 'List the Payload collection and global slugs visible to this MCP client.',
14
14
  }).handler(async ({ authorizedMCP, req }) => {
15
- const user = authorizedMCP.user
16
- const permissions = authorizedMCP.overrideAccess
17
- ? null
18
- : await getAccessResults({ req: { ...req, user } })
15
+ const user = req.user
16
+ const permissions = authorizedMCP.overrideAccess ? null : await getAccessResults({ req })
19
17
  const authorizedCollectionSlugs = new Set<string>()
20
18
  const authorizedGlobalSlugs = new Set<string>()
21
19
 
@@ -3,7 +3,6 @@ import { z } from 'zod'
3
3
  import { defaultAccess } from '../../../defaultAccess.js'
4
4
  import { defineGlobalTool } from '../../../defineTool.js'
5
5
  import { getLogger } from '../../../utils/getLogger.js'
6
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
7
6
  import { whereSchema } from '../../../utils/whereSchema.js'
8
7
 
9
8
  const DEFAULT_DESCRIPTION =
@@ -21,10 +20,7 @@ export const countGlobalVersionsTool = defineGlobalTool({
21
20
  },
22
21
  description: DEFAULT_DESCRIPTION,
23
22
  input: z.object({
24
- locale: z
25
- .string()
26
- .describe('Optional: locale code to count versions in')
27
- .optional(),
23
+ locale: z.string().describe('Optional: locale code to count versions in').optional(),
28
24
  where: whereSchema
29
25
  .describe(
30
26
  'Optional: where clause for filtering versions. Version document fields are usually under "version". Example: {"version.siteName":{"contains":"test"}}',
@@ -41,8 +37,8 @@ export const countGlobalVersionsTool = defineGlobalTool({
41
37
  try {
42
38
  const result = await payload.countGlobalVersions({
43
39
  global: globalSlug,
40
+ overrideAccess: authorizedMCP.overrideAccess,
44
41
  req,
45
- ...localAPIDefaults(authorizedMCP),
46
42
  ...(locale ? { locale } : {}),
47
43
  ...(where ? { where } : {}),
48
44
  })
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION = 'Find any Payload global by passing the global slug.'
11
10
 
@@ -66,7 +65,8 @@ export const findGlobalTool = defineGlobalTool({
66
65
  const findOptions: Parameters<typeof payload.findGlobal>[0] = {
67
66
  slug: globalSlug,
68
67
  depth,
69
- ...localAPIDefaults(authorizedMCP),
68
+ overrideAccess: authorizedMCP.overrideAccess,
69
+ req,
70
70
  }
71
71
 
72
72
  if (locale) {
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
9
  const DEFAULT_DESCRIPTION =
11
10
  'Find a specific global version in any version-enabled global by passing the global slug and version ID.'
@@ -70,8 +69,8 @@ export const findGlobalVersionByIDTool = defineGlobalTool({
70
69
  id,
71
70
  slug: globalSlug,
72
71
  depth,
72
+ overrideAccess: authorizedMCP.overrideAccess,
73
73
  req,
74
- ...localAPIDefaults(authorizedMCP),
75
74
  ...(fallbackLocale ? { fallbackLocale } : {}),
76
75
  ...(locale ? { locale } : {}),
77
76
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -5,7 +5,6 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
  import { whereSchema } from '../../../utils/whereSchema.js'
10
9
 
11
10
  const DEFAULT_DESCRIPTION =
@@ -110,9 +109,9 @@ export const findGlobalVersionsTool = defineGlobalTool({
110
109
  slug: globalSlug,
111
110
  depth,
112
111
  limit,
112
+ overrideAccess: authorizedMCP.overrideAccess,
113
113
  page,
114
114
  req,
115
- ...localAPIDefaults(authorizedMCP),
116
115
  ...(fallbackLocale ? { fallbackLocale } : {}),
117
116
  ...(locale ? { locale } : {}),
118
117
  ...(pagination !== undefined ? { pagination } : {}),
@@ -1,3 +1,5 @@
1
+ import { getAccessResults } from 'payload'
2
+
1
3
  import { defaultAccess } from '../../../defaultAccess.js'
2
4
  import { defineGlobalTool } from '../../../defineTool.js'
3
5
  import { getGlobalInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'
@@ -6,7 +8,7 @@ export const getGlobalSchemaTool = defineGlobalTool({
6
8
  access: (args) => {
7
9
  const permissions = args.permissions?.globals?.[args.globalSlug]
8
10
 
9
- return defaultAccess(args) && Boolean(permissions?.read || permissions?.update)
11
+ return defaultAccess(args) && Boolean(permissions?.update)
10
12
  },
11
13
  annotations: {
12
14
  destructiveHint: false,
@@ -16,8 +18,28 @@ export const getGlobalSchemaTool = defineGlobalTool({
16
18
  title: 'Get Global Schema',
17
19
  },
18
20
  description: 'Get the input schema for updating a global.',
19
- }).handler(({ globalSlug, req }) => {
20
- const inputSchema = getGlobalInputSchema({ globalSlug, req })
21
+ }).handler(async ({ authorizedMCP, globalSlug, req }) => {
22
+ const permissions = authorizedMCP.overrideAccess
23
+ ? null
24
+ : (await getAccessResults({ req })).globals?.[globalSlug]
25
+
26
+ if (!authorizedMCP.overrideAccess && !permissions?.update) {
27
+ return {
28
+ content: [
29
+ {
30
+ type: 'text',
31
+ text: `Error: MCP access to "getGlobalSchema" is not enabled for global "${globalSlug}"`,
32
+ },
33
+ ],
34
+ isError: true,
35
+ }
36
+ }
37
+
38
+ const inputSchema = getGlobalInputSchema({
39
+ globalSlug,
40
+ req,
41
+ ...(permissions ? { permissions } : {}),
42
+ })
21
43
 
22
44
  if (!inputSchema) {
23
45
  return {
@@ -5,9 +5,9 @@ import { z } from 'zod'
5
5
  import { defaultAccess } from '../../../defaultAccess.js'
6
6
  import { defineGlobalTool } from '../../../defineTool.js'
7
7
  import { getLogger } from '../../../utils/getLogger.js'
8
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
9
8
 
10
- const DEFAULT_DESCRIPTION = 'Restore a global from a previous version in any version-enabled global.'
9
+ const DEFAULT_DESCRIPTION =
10
+ 'Restore a global from a previous version in any version-enabled global.'
11
11
 
12
12
  export const restoreGlobalVersionTool = defineGlobalTool({
13
13
  access: (args) =>
@@ -61,8 +61,8 @@ export const restoreGlobalVersionTool = defineGlobalTool({
61
61
  id,
62
62
  slug: globalSlug,
63
63
  depth,
64
+ overrideAccess: authorizedMCP.overrideAccess,
64
65
  req,
65
- ...localAPIDefaults(authorizedMCP),
66
66
  ...(fallbackLocale ? { fallbackLocale } : {}),
67
67
  ...(locale ? { locale } : {}),
68
68
  ...(populate ? { populate: populate as PopulateType } : {}),
@@ -9,7 +9,6 @@ import {
9
9
  getGlobalVirtualFieldNames,
10
10
  stripVirtualFields,
11
11
  } from '../../../utils/getVirtualFieldNames.js'
12
- import { localAPIDefaults } from '../../../utils/localAPIDefaults.js'
13
12
  import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'
14
13
  import { validateGlobalData } from '../validateEntityData.js'
15
14
 
@@ -81,7 +80,8 @@ export const updateGlobalTool = defineGlobalTool({
81
80
  data: parsedData,
82
81
  depth,
83
82
  draft,
84
- ...localAPIDefaults(authorizedMCP),
83
+ overrideAccess: authorizedMCP.overrideAccess,
84
+ req,
85
85
  }
86
86
 
87
87
  if (locale) {
package/src/types.ts CHANGED
@@ -15,7 +15,6 @@ import type {
15
15
  MaybePromise,
16
16
  PayloadRequest,
17
17
  SanitizedPermissions,
18
- User,
19
18
  } from 'payload'
20
19
 
21
20
  import type { GetAuthorizedMCPArgs } from './endpoint/access.js'
@@ -99,6 +98,11 @@ export type GlobalToolHandlerArgs<TSchema = undefined> = {
99
98
  } & ToolHandlerArgs<TSchema>
100
99
 
101
100
  export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
101
+ /**
102
+ * Runs while authorizing each MCP request, before the tool is advertised or called. Return
103
+ * `false` to make the tool unavailable for that request. This is skipped when `overrideAccess`
104
+ * is enabled.
105
+ */
102
106
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
103
107
  annotations?: ToolAnnotations
104
108
  description: string
@@ -113,6 +117,12 @@ export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema |
113
117
  export type CollectionTool<
114
118
  TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
115
119
  > = {
120
+ /**
121
+ * Runs while authorizing each MCP request for this collection. Return `false` to reject calls
122
+ * to this tool for the collection. The shared tool is not advertised when no collections allow
123
+ * it, but can remain advertised when it is available for another collection. This is skipped
124
+ * when `overrideAccess` is enabled.
125
+ */
116
126
  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
117
127
  handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
118
128
  input?: TSchema
@@ -120,6 +130,12 @@ export type CollectionTool<
120
130
 
121
131
  export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =
122
132
  {
133
+ /**
134
+ * Runs while authorizing each MCP request for this global. Return `false` to reject calls to
135
+ * this tool for the global. The shared tool is not advertised when no globals allow it, but
136
+ * can remain advertised when it is available for another global. This is skipped when
137
+ * `overrideAccess` is enabled.
138
+ */
123
139
  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
124
140
  handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
125
141
  input?: TSchema
@@ -131,6 +147,10 @@ export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSc
131
147
  * required handler) from being silently accepted at a built-in key slot.
132
148
  */
133
149
  export type MCPBuiltInCollectionToolOverride = {
150
+ /**
151
+ * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
152
+ * this collection. This is skipped when `overrideAccess` is enabled.
153
+ */
134
154
  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
135
155
  annotations?: ToolAnnotations
136
156
  description?: string
@@ -139,6 +159,10 @@ export type MCPBuiltInCollectionToolOverride = {
139
159
  }
140
160
 
141
161
  export type MCPBuiltInGlobalToolOverride = {
162
+ /**
163
+ * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
164
+ * this global. This is skipped when `overrideAccess` is enabled.
165
+ */
142
166
  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
143
167
  annotations?: ToolAnnotations
144
168
  description?: string
@@ -183,6 +207,11 @@ export type PromptHandlerArgs<TSchema = undefined> = {
183
207
  }
184
208
 
185
209
  export type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {
210
+ /**
211
+ * Runs while authorizing each MCP request, before the prompt is advertised or used. Return
212
+ * `false` to make the prompt unavailable for that request. This is skipped when
213
+ * `overrideAccess` is enabled.
214
+ */
186
215
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
187
216
  argsSchema: TSchema
188
217
  description: string
@@ -201,6 +230,11 @@ export type ResourceHandlerArgs = {
201
230
  }
202
231
 
203
232
  export type Resource = {
233
+ /**
234
+ * Runs while authorizing each MCP request, before the resource is advertised or read. Return
235
+ * `false` to make the resource unavailable for that request. This is skipped when
236
+ * `overrideAccess` is enabled.
237
+ */
204
238
  access?: (args: MCPAccessArgs) => MaybePromise<boolean>
205
239
  description: string
206
240
  handler: (args: ResourceHandlerArgs) => MaybePromise<{
@@ -248,7 +282,12 @@ export type MCPPluginConfig = {
248
282
  serverOptions?: MCPServerOptions
249
283
  verboseLogs?: boolean
250
284
  }
251
- /** Replace the default MCP authorization resolver. */
285
+ /**
286
+ * Replace the default MCP authorization resolver.
287
+ *
288
+ * This hook replaces the default authentication flow. It must set `req.user` to the
289
+ * authenticated Payload user, or to `null` for an anonymous caller, before returning.
290
+ */
252
291
  overrideGetAuthorizedMCP?: (
253
292
  args: {
254
293
  pluginConfig: SanitizedMCPPluginConfig
@@ -312,13 +351,10 @@ export type MCPItem =
312
351
  | GlobalMCPItem
313
352
 
314
353
  /**
315
- * The caller's identity + the MCP items authorized for this request. Disabled
316
- * items and items blocked by access callbacks or Payload operation access are
317
- * absent from `items`. Tool handlers receive this via `args.authorizedMCP` so
318
- * they can spread `localAPIDefaults(authorizedMCP)` into every local API call.
354
+ * The MCP items and access mode authorized for this request. The authenticated user is available
355
+ * as `req.user`.
319
356
  */
320
357
  export type AuthorizedMCP = {
321
358
  items: MCPItem[]
322
359
  overrideAccess: boolean
323
- user: null | User
324
360
  }