@payloadcms/plugin-mcp 4.0.0-canary.13 → 4.0.0-canary.14
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.
- package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
- package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/createTool.js +90 -48
- package/dist/mcp/builtin/collections/createTool.js.map +1 -1
- package/dist/mcp/builtin/collections/fileInput.d.ts +10 -2
- package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/fileInput.js +28 -4
- package/dist/mcp/builtin/collections/fileInput.js.map +1 -1
- package/dist/mcp/builtin/collections/fileInput.spec.js +18 -4
- package/dist/mcp/builtin/collections/fileInput.spec.js.map +1 -1
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +3 -2
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -1
- package/dist/mcp/builtin/collections/updateTool.js +3 -3
- package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
- package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/uploadInstructionsTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/uploadInstructionsTool.js +55 -0
- package/dist/mcp/builtin/collections/uploadInstructionsTool.js.map +1 -0
- package/dist/mcp/builtinTools.d.ts +6 -0
- package/dist/mcp/builtinTools.d.ts.map +1 -1
- package/dist/mcp/builtinTools.js +9 -3
- package/dist/mcp/builtinTools.js.map +1 -1
- package/dist/mcp/sanitizeMCPConfig.js +4 -1
- package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
- package/dist/stdio.d.ts.map +1 -1
- package/dist/stdio.js +2 -1
- package/dist/stdio.js.map +1 -1
- package/package.json +3 -3
- package/src/mcp/builtin/collections/createTool.ts +87 -40
- package/src/mcp/builtin/collections/fileInput.spec.ts +18 -4
- package/src/mcp/builtin/collections/fileInput.ts +29 -4
- package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +5 -1
- package/src/mcp/builtin/collections/updateTool.ts +3 -3
- package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
- package/src/mcp/builtinTools.ts +9 -2
- package/src/mcp/sanitizeMCPConfig.ts +4 -1
- package/src/stdio.ts +2 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const
|
|
1
|
+
export declare const createDocumentsTool: import("../../../types.js").CollectionTool;
|
|
2
2
|
//# sourceMappingURL=createTool.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,
|
|
1
|
+
{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/createTool.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,mBAAmB,4CAoJ9B,CAAA"}
|
|
@@ -5,26 +5,28 @@ import { getLogger } from '../../../utils/getLogger.js';
|
|
|
5
5
|
import { getCollectionVirtualFieldNames, stripVirtualFields } from '../../../utils/getVirtualFieldNames.js';
|
|
6
6
|
import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
|
|
7
7
|
import { validateCollectionData } from '../validateEntityData.js';
|
|
8
|
-
import { fileInputSchema,
|
|
8
|
+
import { fileInputSchema, resolveFile } from './fileInput.js';
|
|
9
9
|
import { formatCollectionError } from './formatCollectionError.js';
|
|
10
|
-
const DEFAULT_DESCRIPTION = 'Create a
|
|
11
|
-
export const
|
|
10
|
+
const DEFAULT_DESCRIPTION = 'Create one or more documents. Each can have different data or a file. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.';
|
|
11
|
+
export const createDocumentsTool = defineCollectionTool({
|
|
12
12
|
access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),
|
|
13
13
|
annotations: {
|
|
14
14
|
destructiveHint: false,
|
|
15
15
|
idempotentHint: false,
|
|
16
16
|
openWorldHint: false,
|
|
17
17
|
readOnlyHint: false,
|
|
18
|
-
title: 'Create
|
|
18
|
+
title: 'Create Documents'
|
|
19
19
|
},
|
|
20
20
|
description: DEFAULT_DESCRIPTION,
|
|
21
21
|
input: z.object({
|
|
22
|
-
data: z.record(z.string(), z.unknown()).describe('The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.'),
|
|
23
22
|
depth: z.number().int().min(0).max(10).describe('How many levels deep to populate relationships in response').optional().default(0),
|
|
23
|
+
documents: z.array(z.object({
|
|
24
|
+
data: z.record(z.string(), z.unknown()).describe('The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.'),
|
|
25
|
+
file: fileInputSchema.optional()
|
|
26
|
+
})).min(1).describe('The documents to create, in order'),
|
|
24
27
|
draft: z.boolean().describe('Only if getCollectionSchema includes _status; otherwise _status does not exist. true forces data._status to "draft"; with false, data._status controls draft or published.').optional().default(false),
|
|
25
28
|
fallbackLocale: z.string().describe('Optional: fallback locale code to use when requested locale is not available').optional(),
|
|
26
|
-
|
|
27
|
-
locale: z.string().describe('Optional: locale code to create the document in (e.g., "en", "es"). Defaults to the default locale').optional(),
|
|
29
|
+
locale: z.string().describe('Optional: locale code to create the documents in (e.g., "en", "es"). Defaults to the default locale').optional(),
|
|
28
30
|
select: z.record(z.string(), z.unknown()).describe('Optional: define exactly which fields you\'d like to return, e.g., {"title": true}').optional()
|
|
29
31
|
})
|
|
30
32
|
}).handler(async ({ authorizedMCP, collectionSlug, input, req })=>{
|
|
@@ -32,58 +34,98 @@ export const createDocumentTool = defineCollectionTool({
|
|
|
32
34
|
const logger = getLogger({
|
|
33
35
|
payload
|
|
34
36
|
});
|
|
35
|
-
const {
|
|
36
|
-
logger.info(`Creating
|
|
37
|
+
const { depth, documents, draft, fallbackLocale, locale, select } = input;
|
|
38
|
+
logger.info(`Creating ${documents.length} documents in collection: ${collectionSlug}`);
|
|
37
39
|
try {
|
|
38
40
|
const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug);
|
|
39
|
-
const
|
|
40
|
-
const
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
41
|
+
const docs = [];
|
|
42
|
+
const errors = [];
|
|
43
|
+
let validationSchema;
|
|
44
|
+
for (const [index, document] of documents.entries()){
|
|
45
|
+
try {
|
|
46
|
+
const inputData = stripVirtualFields(document.data, virtualFieldNames);
|
|
47
|
+
const validationError = validateCollectionData({
|
|
48
|
+
collectionSlug,
|
|
49
|
+
data: inputData,
|
|
50
|
+
req
|
|
51
|
+
});
|
|
52
|
+
if (validationError) {
|
|
53
|
+
const firstContent = validationError.content[0];
|
|
54
|
+
const validationContent = validationError.structuredContent;
|
|
55
|
+
const schema = validationContent?.schema;
|
|
56
|
+
if (!validationSchema && schema && typeof schema === 'object') {
|
|
57
|
+
validationSchema = schema;
|
|
58
|
+
}
|
|
59
|
+
errors.push({
|
|
60
|
+
index,
|
|
61
|
+
message: firstContent?.type === 'text' ? firstContent.text.split('\n\nUse this schema')[0] ?? 'Invalid document data' : 'Invalid document data'
|
|
62
|
+
});
|
|
63
|
+
continue;
|
|
64
|
+
}
|
|
65
|
+
const parsedData = transformPointDataToPayload(inputData);
|
|
66
|
+
const file = await resolveFile({
|
|
67
|
+
collectionSlug,
|
|
68
|
+
input: document.file,
|
|
69
|
+
req
|
|
70
|
+
});
|
|
71
|
+
const result = await payload.create({
|
|
72
|
+
collection: collectionSlug,
|
|
73
|
+
data: parsedData,
|
|
74
|
+
depth,
|
|
75
|
+
draft,
|
|
76
|
+
overrideAccess: authorizedMCP.overrideAccess,
|
|
77
|
+
req,
|
|
78
|
+
...file ? {
|
|
79
|
+
file
|
|
80
|
+
} : {},
|
|
81
|
+
...locale ? {
|
|
82
|
+
locale
|
|
83
|
+
} : {},
|
|
84
|
+
...fallbackLocale ? {
|
|
85
|
+
fallbackLocale
|
|
86
|
+
} : {},
|
|
87
|
+
...select ? {
|
|
88
|
+
select: select
|
|
89
|
+
} : {}
|
|
90
|
+
});
|
|
91
|
+
docs.push({
|
|
92
|
+
doc: result,
|
|
93
|
+
index
|
|
94
|
+
});
|
|
95
|
+
} catch (error) {
|
|
96
|
+
const message = error instanceof Error ? error.message : 'Unknown error';
|
|
97
|
+
logger.error(`Error creating document at index ${index} in ${collectionSlug}: ${message}`);
|
|
98
|
+
errors.push({
|
|
99
|
+
index,
|
|
100
|
+
message
|
|
101
|
+
});
|
|
102
|
+
}
|
|
47
103
|
}
|
|
48
|
-
const
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
}
|
|
54
|
-
const
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
overrideAccess: authorizedMCP.overrideAccess,
|
|
60
|
-
req,
|
|
61
|
-
...file ? {
|
|
62
|
-
file
|
|
63
|
-
} : {},
|
|
64
|
-
...locale ? {
|
|
65
|
-
locale
|
|
66
|
-
} : {},
|
|
67
|
-
...fallbackLocale ? {
|
|
68
|
-
fallbackLocale
|
|
69
|
-
} : {},
|
|
70
|
-
...select ? {
|
|
71
|
-
select: select
|
|
72
|
-
} : {}
|
|
73
|
-
});
|
|
74
|
-
logger.info(`Successfully created document in ${collectionSlug} with ID: ${result.id}`);
|
|
104
|
+
const batchResult = {
|
|
105
|
+
docs,
|
|
106
|
+
errors
|
|
107
|
+
};
|
|
108
|
+
const retryMessage = errors.length > 0 ? '\nRetry failed indexes only.' : '';
|
|
109
|
+
const schemaMessage = validationSchema ? `\n\nUse this schema for data:\n\`\`\`json\n${JSON.stringify(validationSchema)}\n\`\`\`` : '';
|
|
110
|
+
const structuredContent = validationSchema ? {
|
|
111
|
+
...batchResult,
|
|
112
|
+
schema: validationSchema
|
|
113
|
+
} : batchResult;
|
|
114
|
+
logger.info(`Created ${docs.length} of ${documents.length} documents in ${collectionSlug}`);
|
|
75
115
|
return {
|
|
76
116
|
content: [
|
|
77
117
|
{
|
|
78
118
|
type: 'text',
|
|
79
|
-
text: `
|
|
119
|
+
text: `Created ${docs.length} of ${documents.length} documents in collection "${collectionSlug}".${retryMessage}\nResults:\n\`\`\`json\n${JSON.stringify(batchResult)}\n\`\`\`${schemaMessage}`
|
|
80
120
|
}
|
|
81
121
|
],
|
|
82
|
-
doc:
|
|
122
|
+
doc: structuredContent,
|
|
123
|
+
isError: docs.length === 0 && errors.length > 0,
|
|
124
|
+
structuredContent
|
|
83
125
|
};
|
|
84
126
|
} catch (error) {
|
|
85
|
-
const
|
|
86
|
-
logger.error(`Error creating
|
|
127
|
+
const message = error instanceof Error ? error.message : 'Unknown error';
|
|
128
|
+
logger.error(`Error creating documents in ${collectionSlug}: ${message}`);
|
|
87
129
|
return formatCollectionError({
|
|
88
130
|
action: 'creating',
|
|
89
131
|
collectionSlug,
|
|
@@ -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 { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { fileInputSchema, resolveFileInput } from './fileInput.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 access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),\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\n .record(z.string(), z.unknown())\n .describe(\n 'The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.',\n ),\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(\n 'Only if getCollectionSchema includes _status; otherwise _status does not exist. true forces data._status to \"draft\"; with false, data._status controls draft or published.',\n )\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 file: fileInputSchema.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, file: fileInput, 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 const file = await resolveFileInput({ collectionSlug, input: fileInput, req })\n\n const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n ...(file ? { file } : {}),\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","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","transformPointDataToPayload","validateCollectionData","fileInputSchema","resolveFileInput","formatCollectionError","DEFAULT_DESCRIPTION","createDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","create","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","data","record","string","unknown","describe","depth","number","int","min","max","optional","default","draft","boolean","fallbackLocale","file","locale","select","handler","authorizedMCP","req","payload","logger","fileInput","info","virtualFieldNames","config","inputData","validationError","parsedData","result","collection","overrideAccess","id","content","type","text","JSON","stringify","doc","error","errorMessage","Error","message","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,eAAe,EAAEC,gBAAgB,QAAQ,iBAAgB;AAClE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBV,qBAAqB;IACrDW,QAAQ,CAACC,OACPb,cAAca,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAO3B,EAAE4B,MAAM,CAAC;QACdC,MAAM7B,EACH8B,MAAM,CAAC9B,EAAE+B,MAAM,IAAI/B,EAAEgC,OAAO,IAC5BC,QAAQ,CACP;QAEJC,OAAOlC,EACJmC,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJL,QAAQ,CAAC,8DACTM,QAAQ,GACRC,OAAO,CAAC;QACXC,OAAOzC,EACJ0C,OAAO,GACPT,QAAQ,CACP,8KAEDM,QAAQ,GACRC,OAAO,CAAC;QACXG,gBAAgB3C,EACb+B,MAAM,GACNE,QAAQ,CAAC,gFACTM,QAAQ;QACXK,MAAMpC,gBAAgB+B,QAAQ;QAC9BM,QAAQ7C,EACL+B,MAAM,GACNE,QAAQ,CACP,sGAEDM,QAAQ;QACXO,QAAQ9C,EACL8B,MAAM,CAAC9B,EAAE+B,MAAM,IAAI/B,EAAEgC,OAAO,IAC5BC,QAAQ,CACP,sFAEDM,QAAQ;IACb;AACF,GAAGQ,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAE9B,cAAc,EAAES,KAAK,EAAEsB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAAShD,UAAU;QAAE+C;IAAQ;IAEnC,MAAM,EAAErB,IAAI,EAAEK,KAAK,EAAEO,KAAK,EAAEE,cAAc,EAAEC,MAAMQ,SAAS,EAAEP,MAAM,EAAEC,MAAM,EAAE,GAAGnB;IAEhFwB,OAAOE,IAAI,CACT,CAAC,iCAAiC,EAAEnC,iBAAiB2B,SAAS,CAAC,cAAc,EAAEA,QAAQ,GAAG,IAAI;IAGhG,IAAI;QACF,MAAMS,oBAAoBlD,+BAA+B8C,QAAQK,MAAM,EAAErC;QACzE,MAAMsC,YAAYnD,mBAAmBwB,MAAMyB;QAC3C,MAAMG,kBAAkBlD,uBAAuB;YAAEW;YAAgBW,MAAM2B;YAAWP;QAAI;QAEtF,IAAIQ,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAMC,aAAapD,4BAA4BkD;QAC/C,MAAMZ,OAAO,MAAMnC,iBAAiB;YAAES;YAAgBS,OAAOyB;YAAWH;QAAI;QAE5E,MAAMU,SAAS,MAAMT,QAAQ/B,MAAM,CAAC;YAClCyC,YAAY1C;YACZW,MAAM6B;YACNxB;YACAO;YACAoB,gBAAgBb,cAAca,cAAc;YAC5CZ;YACA,GAAIL,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIC,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIG,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEAK,OAAOE,IAAI,CAAC,CAAC,iCAAiC,EAAEnC,eAAe,UAAU,EAAEyC,OAAOG,EAAE,EAAE;QAEtF,OAAO;YACLC,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,6CAA6C,EAAE/C,eAAe,mCAAmC,EAAEgD,KAAKC,SAAS,CAACR,QAAQ,QAAQ,CAAC;gBAC5I;aACD;YACDS,KAAKT;QACP;IACF,EAAE,OAAOU,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9DrB,OAAOkB,KAAK,CAAC,CAAC,2BAA2B,EAAEnD,eAAe,EAAE,EAAEoD,cAAc;QAC5E,OAAO5D,sBAAsB;YAAE+D,QAAQ;YAAYvD;YAAgBmD;YAAOpB;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 { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.js'\nimport { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js'\nimport { validateCollectionData } from '../validateEntityData.js'\nimport { fileInputSchema, resolveFile } from './fileInput.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Create one or more documents. Each can have different data or a file. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'\n\nexport const createDocumentsTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.create),\n annotations: {\n destructiveHint: false,\n idempotentHint: false,\n openWorldHint: false,\n readOnlyHint: false,\n title: 'Create Documents',\n },\n description: DEFAULT_DESCRIPTION,\n input: z.object({\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 documents: z\n .array(\n z.object({\n data: z\n .record(z.string(), z.unknown())\n .describe(\n 'The document fields to create. Only include fields permitted by the schema returned by getCollectionSchema.',\n ),\n file: fileInputSchema.optional(),\n }),\n )\n .min(1)\n .describe('The documents to create, in order'),\n draft: z\n .boolean()\n .describe(\n 'Only if getCollectionSchema includes _status; otherwise _status does not exist. true forces data._status to \"draft\"; with false, data._status controls draft or published.',\n )\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 documents 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 const { depth, documents, draft, fallbackLocale, locale, select } = input\n\n logger.info(`Creating ${documents.length} documents in collection: ${collectionSlug}`)\n\n try {\n const virtualFieldNames = getCollectionVirtualFieldNames(payload.config, collectionSlug)\n const docs: Array<{ doc: Record<string, unknown>; index: number }> = []\n const errors: Array<{ index: number; message: string }> = []\n let validationSchema: Record<string, unknown> | undefined\n\n for (const [index, document] of documents.entries()) {\n try {\n const inputData = stripVirtualFields(document.data, virtualFieldNames)\n const validationError = validateCollectionData({ collectionSlug, data: inputData, req })\n\n if (validationError) {\n const firstContent = validationError.content[0]\n const validationContent = validationError.structuredContent as\n | Record<string, unknown>\n | undefined\n const schema = validationContent?.schema\n\n if (!validationSchema && schema && typeof schema === 'object') {\n validationSchema = schema as Record<string, unknown>\n }\n\n errors.push({\n index,\n message:\n firstContent?.type === 'text'\n ? (firstContent.text.split('\\n\\nUse this schema')[0] ?? 'Invalid document data')\n : 'Invalid document data',\n })\n continue\n }\n\n const parsedData = transformPointDataToPayload(inputData)\n const file = await resolveFile({ collectionSlug, input: document.file, req })\n const result = await payload.create({\n collection: collectionSlug,\n data: parsedData,\n depth,\n draft,\n overrideAccess: authorizedMCP.overrideAccess,\n req,\n ...(file ? { file } : {}),\n ...(locale ? { locale } : {}),\n ...(fallbackLocale ? { fallbackLocale } : {}),\n ...(select ? { select: select as SelectType } : {}),\n })\n\n docs.push({ doc: result as Record<string, unknown>, index })\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n\n logger.error(`Error creating document at index ${index} in ${collectionSlug}: ${message}`)\n errors.push({ index, message })\n }\n }\n\n const batchResult = { docs, errors }\n const retryMessage = errors.length > 0 ? '\\nRetry failed indexes only.' : ''\n const schemaMessage = validationSchema\n ? `\\n\\nUse this schema for data:\\n\\`\\`\\`json\\n${JSON.stringify(validationSchema)}\\n\\`\\`\\``\n : ''\n const structuredContent = validationSchema\n ? { ...batchResult, schema: validationSchema }\n : batchResult\n\n logger.info(`Created ${docs.length} of ${documents.length} documents in ${collectionSlug}`)\n\n return {\n content: [\n {\n type: 'text',\n text: `Created ${docs.length} of ${documents.length} documents in collection \"${collectionSlug}\".${retryMessage}\\nResults:\\n\\`\\`\\`json\\n${JSON.stringify(batchResult)}\\n\\`\\`\\`${schemaMessage}`,\n },\n ],\n doc: structuredContent as unknown as Record<string, unknown>,\n isError: docs.length === 0 && errors.length > 0,\n structuredContent,\n }\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n\n logger.error(`Error creating documents in ${collectionSlug}: ${message}`)\n return formatCollectionError({ action: 'creating', collectionSlug, error, req })\n }\n})\n"],"names":["z","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","transformPointDataToPayload","validateCollectionData","fileInputSchema","resolveFile","formatCollectionError","DEFAULT_DESCRIPTION","createDocumentsTool","access","args","Boolean","permissions","collections","collectionSlug","create","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","depth","number","int","min","max","describe","optional","default","documents","array","data","record","string","unknown","file","draft","boolean","fallbackLocale","locale","select","handler","authorizedMCP","req","payload","logger","info","length","virtualFieldNames","config","docs","errors","validationSchema","index","document","entries","inputData","validationError","firstContent","content","validationContent","structuredContent","schema","push","message","type","text","split","parsedData","result","collection","overrideAccess","doc","error","Error","batchResult","retryMessage","schemaMessage","JSON","stringify","isError","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,eAAe,EAAEC,WAAW,QAAQ,iBAAgB;AAC7D,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,sBAAsBV,qBAAqB;IACtDW,QAAQ,CAACC,OACPb,cAAca,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAO3B,EAAE4B,MAAM,CAAC;QACdC,OAAO7B,EACJ8B,MAAM,GACNC,GAAG,GACHC,GAAG,CAAC,GACJC,GAAG,CAAC,IACJC,QAAQ,CAAC,8DACTC,QAAQ,GACRC,OAAO,CAAC;QACXC,WAAWrC,EACRsC,KAAK,CACJtC,EAAE4B,MAAM,CAAC;YACPW,MAAMvC,EACHwC,MAAM,CAACxC,EAAEyC,MAAM,IAAIzC,EAAE0C,OAAO,IAC5BR,QAAQ,CACP;YAEJS,MAAMnC,gBAAgB2B,QAAQ;QAChC,IAEDH,GAAG,CAAC,GACJE,QAAQ,CAAC;QACZU,OAAO5C,EACJ6C,OAAO,GACPX,QAAQ,CACP,8KAEDC,QAAQ,GACRC,OAAO,CAAC;QACXU,gBAAgB9C,EACbyC,MAAM,GACNP,QAAQ,CAAC,gFACTC,QAAQ;QACXY,QAAQ/C,EACLyC,MAAM,GACNP,QAAQ,CACP,uGAEDC,QAAQ;QACXa,QAAQhD,EACLwC,MAAM,CAACxC,EAAEyC,MAAM,IAAIzC,EAAE0C,OAAO,IAC5BR,QAAQ,CACP,sFAEDC,QAAQ;IACb;AACF,GAAGc,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEhC,cAAc,EAAES,KAAK,EAAEwB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASlD,UAAU;QAAEiD;IAAQ;IACnC,MAAM,EAAEvB,KAAK,EAAEQ,SAAS,EAAEO,KAAK,EAAEE,cAAc,EAAEC,MAAM,EAAEC,MAAM,EAAE,GAAGrB;IAEpE0B,OAAOC,IAAI,CAAC,CAAC,SAAS,EAAEjB,UAAUkB,MAAM,CAAC,0BAA0B,EAAErC,gBAAgB;IAErF,IAAI;QACF,MAAMsC,oBAAoBpD,+BAA+BgD,QAAQK,MAAM,EAAEvC;QACzE,MAAMwC,OAA+D,EAAE;QACvE,MAAMC,SAAoD,EAAE;QAC5D,IAAIC;QAEJ,KAAK,MAAM,CAACC,OAAOC,SAAS,IAAIzB,UAAU0B,OAAO,GAAI;YACnD,IAAI;gBACF,MAAMC,YAAY3D,mBAAmByD,SAASvB,IAAI,EAAEiB;gBACpD,MAAMS,kBAAkB1D,uBAAuB;oBAAEW;oBAAgBqB,MAAMyB;oBAAWb;gBAAI;gBAEtF,IAAIc,iBAAiB;oBACnB,MAAMC,eAAeD,gBAAgBE,OAAO,CAAC,EAAE;oBAC/C,MAAMC,oBAAoBH,gBAAgBI,iBAAiB;oBAG3D,MAAMC,SAASF,mBAAmBE;oBAElC,IAAI,CAACV,oBAAoBU,UAAU,OAAOA,WAAW,UAAU;wBAC7DV,mBAAmBU;oBACrB;oBAEAX,OAAOY,IAAI,CAAC;wBACVV;wBACAW,SACEN,cAAcO,SAAS,SAClBP,aAAaQ,IAAI,CAACC,KAAK,CAAC,sBAAsB,CAAC,EAAE,IAAI,0BACtD;oBACR;oBACA;gBACF;gBAEA,MAAMC,aAAatE,4BAA4B0D;gBAC/C,MAAMrB,OAAO,MAAMlC,YAAY;oBAAES;oBAAgBS,OAAOmC,SAASnB,IAAI;oBAAEQ;gBAAI;gBAC3E,MAAM0B,SAAS,MAAMzB,QAAQjC,MAAM,CAAC;oBAClC2D,YAAY5D;oBACZqB,MAAMqC;oBACN/C;oBACAe;oBACAmC,gBAAgB7B,cAAc6B,cAAc;oBAC5C5B;oBACA,GAAIR,OAAO;wBAAEA;oBAAK,IAAI,CAAC,CAAC;oBACxB,GAAII,SAAS;wBAAEA;oBAAO,IAAI,CAAC,CAAC;oBAC5B,GAAID,iBAAiB;wBAAEA;oBAAe,IAAI,CAAC,CAAC;oBAC5C,GAAIE,SAAS;wBAAEA,QAAQA;oBAAqB,IAAI,CAAC,CAAC;gBACpD;gBAEAU,KAAKa,IAAI,CAAC;oBAAES,KAAKH;oBAAmChB;gBAAM;YAC5D,EAAE,OAAOoB,OAAO;gBACd,MAAMT,UAAUS,iBAAiBC,QAAQD,MAAMT,OAAO,GAAG;gBAEzDnB,OAAO4B,KAAK,CAAC,CAAC,iCAAiC,EAAEpB,MAAM,IAAI,EAAE3C,eAAe,EAAE,EAAEsD,SAAS;gBACzFb,OAAOY,IAAI,CAAC;oBAAEV;oBAAOW;gBAAQ;YAC/B;QACF;QAEA,MAAMW,cAAc;YAAEzB;YAAMC;QAAO;QACnC,MAAMyB,eAAezB,OAAOJ,MAAM,GAAG,IAAI,iCAAiC;QAC1E,MAAM8B,gBAAgBzB,mBAClB,CAAC,2CAA2C,EAAE0B,KAAKC,SAAS,CAAC3B,kBAAkB,QAAQ,CAAC,GACxF;QACJ,MAAMS,oBAAoBT,mBACtB;YAAE,GAAGuB,WAAW;YAAEb,QAAQV;QAAiB,IAC3CuB;QAEJ9B,OAAOC,IAAI,CAAC,CAAC,QAAQ,EAAEI,KAAKH,MAAM,CAAC,IAAI,EAAElB,UAAUkB,MAAM,CAAC,cAAc,EAAErC,gBAAgB;QAE1F,OAAO;YACLiD,SAAS;gBACP;oBACEM,MAAM;oBACNC,MAAM,CAAC,QAAQ,EAAEhB,KAAKH,MAAM,CAAC,IAAI,EAAElB,UAAUkB,MAAM,CAAC,0BAA0B,EAAErC,eAAe,EAAE,EAAEkE,aAAa,wBAAwB,EAAEE,KAAKC,SAAS,CAACJ,aAAa,QAAQ,EAAEE,eAAe;gBACjM;aACD;YACDL,KAAKX;YACLmB,SAAS9B,KAAKH,MAAM,KAAK,KAAKI,OAAOJ,MAAM,GAAG;YAC9Cc;QACF;IACF,EAAE,OAAOY,OAAO;QACd,MAAMT,UAAUS,iBAAiBC,QAAQD,MAAMT,OAAO,GAAG;QAEzDnB,OAAO4B,KAAK,CAAC,CAAC,4BAA4B,EAAE/D,eAAe,EAAE,EAAEsD,SAAS;QACxE,OAAO9D,sBAAsB;YAAE+E,QAAQ;YAAYvE;YAAgB+D;YAAO9B;QAAI;IAChF;AACF,GAAE"}
|
|
@@ -7,11 +7,19 @@ export declare const fileInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
7
7
|
source: z.ZodLiteral<"base64">;
|
|
8
8
|
}, z.core.$strip>, z.ZodObject<{
|
|
9
9
|
name: z.ZodOptional<z.ZodString>;
|
|
10
|
-
source: z.ZodLiteral<"
|
|
10
|
+
source: z.ZodLiteral<"externalURL">;
|
|
11
11
|
url: z.ZodURL;
|
|
12
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
13
|
+
file: z.ZodObject<{
|
|
14
|
+
filename: z.ZodString;
|
|
15
|
+
mimeType: z.ZodString;
|
|
16
|
+
size: z.ZodNumber;
|
|
17
|
+
uploadReference: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
18
|
+
}, z.core.$strip>;
|
|
19
|
+
source: z.ZodLiteral<"uploadReference">;
|
|
12
20
|
}, z.core.$strip>], "source">;
|
|
13
21
|
type FileInput = z.infer<typeof fileInputSchema>;
|
|
14
|
-
export declare function
|
|
22
|
+
export declare function resolveFile({ collectionSlug, input, req, }: {
|
|
15
23
|
collectionSlug: CollectionSlug;
|
|
16
24
|
input?: FileInput;
|
|
17
25
|
req: PayloadRequest;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fileInput.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/fileInput.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAY,cAAc,EAAE,MAAM,SAAS,CAAA;AAK7E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"fileInput.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/fileInput.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAY,cAAc,EAAE,MAAM,SAAS,CAAA;AAK7E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAavB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;6BAoBzB,CAAA;AAEH,KAAK,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEhD,wBAAsB,WAAW,CAAC,EAChC,cAAc,EACd,KAAK,EACL,GAAG,GACJ,EAAE;IACD,cAAc,EAAE,cAAc,CAAA;IAC9B,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,GAAG,EAAE,cAAc,CAAA;CACpB,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CA8E5B"}
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import { APIError } from 'payload';
|
|
2
|
-
import { getExternalFile, isURLAllowed } from 'payload/internal';
|
|
2
|
+
import { getExternalFile, getFileFromUploadInstructions, isURLAllowed } from 'payload/internal';
|
|
3
3
|
import { sanitizeFilename } from 'payload/shared';
|
|
4
4
|
import { z } from 'zod';
|
|
5
5
|
const mimeTypeSchema = z.string().regex(/^[!#$%&'*+.^`|~\w-]+\/[!#$%&'*+.^`|~\w-]+$/, 'MIME type must use the type/subtype format');
|
|
6
|
+
const uploadFileSchema = z.object({
|
|
7
|
+
filename: z.string(),
|
|
8
|
+
mimeType: z.string(),
|
|
9
|
+
size: z.number().int().nonnegative(),
|
|
10
|
+
uploadReference: z.record(z.string(), z.unknown())
|
|
11
|
+
});
|
|
6
12
|
export const fileInputSchema = z.discriminatedUnion('source', [
|
|
7
13
|
z.object({
|
|
8
14
|
name: z.string().min(1).describe('The file name, including its extension'),
|
|
@@ -12,14 +18,32 @@ export const fileInputSchema = z.discriminatedUnion('source', [
|
|
|
12
18
|
}),
|
|
13
19
|
z.object({
|
|
14
20
|
name: z.string().min(1).describe('Optional file name override').optional(),
|
|
15
|
-
source: z.literal('
|
|
21
|
+
source: z.literal('externalURL'),
|
|
16
22
|
url: z.url().describe('The http or https URL to download')
|
|
23
|
+
}),
|
|
24
|
+
z.object({
|
|
25
|
+
file: uploadFileSchema.describe('getUploadInstructions file field post-upload'),
|
|
26
|
+
source: z.literal('uploadReference')
|
|
17
27
|
})
|
|
18
|
-
]).describe('A file for an upload collection.
|
|
19
|
-
export async function
|
|
28
|
+
]).describe('A file for an upload collection. Prefer uploadReference after its upload succeeds; use base64 only for small local files or externalURL for an online file.');
|
|
29
|
+
export async function resolveFile({ collectionSlug, input, req }) {
|
|
20
30
|
if (!input) {
|
|
21
31
|
return undefined;
|
|
22
32
|
}
|
|
33
|
+
if (input.source === 'uploadReference') {
|
|
34
|
+
try {
|
|
35
|
+
return await getFileFromUploadInstructions({
|
|
36
|
+
collectionSlug,
|
|
37
|
+
file: input.file,
|
|
38
|
+
req
|
|
39
|
+
});
|
|
40
|
+
} catch (error) {
|
|
41
|
+
if (error instanceof Error && error.message === 'Staged upload was not found.') {
|
|
42
|
+
throw new APIError('Staged upload not found. Complete the upload action first, or use base64 for small local files.', 400);
|
|
43
|
+
}
|
|
44
|
+
throw error;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
23
47
|
const uploadConfig = req.payload.collections[collectionSlug]?.config.upload;
|
|
24
48
|
if (!uploadConfig) {
|
|
25
49
|
throw new APIError(`Collection "${collectionSlug}" does not support file uploads.`, 400);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/mcp/builtin/collections/fileInput.ts"],"sourcesContent":["import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'\n\nimport { APIError } from 'payload'\nimport { getExternalFile, isURLAllowed } from 'payload/internal'\nimport { sanitizeFilename } from 'payload/shared'\nimport { z } from 'zod'\n\nconst mimeTypeSchema = z\n .string()\n .regex(/^[!#$%&'*+.^`|~\\w-]+\\/[!#$%&'*+.^`|~\\w-]+$/, 'MIME type must use the type/subtype format')\n\nexport const fileInputSchema = z\n .discriminatedUnion('source', [\n z.object({\n name: z.string().min(1).describe('The file name, including its extension'),\n data: z.string().describe('The base64-encoded file bytes, without a data URL prefix'),\n mimeType: mimeTypeSchema.describe('The file MIME type, for example image/png'),\n source: z.literal('base64'),\n }),\n z.object({\n name: z.string().min(1).describe('Optional file name override').optional(),\n source: z.literal('
|
|
1
|
+
{"version":3,"sources":["../../../../src/mcp/builtin/collections/fileInput.ts"],"sourcesContent":["import type { CollectionSlug, File, FileData, PayloadRequest } from 'payload'\n\nimport { APIError } from 'payload'\nimport { getExternalFile, getFileFromUploadInstructions, isURLAllowed } from 'payload/internal'\nimport { sanitizeFilename } from 'payload/shared'\nimport { z } from 'zod'\n\nconst mimeTypeSchema = z\n .string()\n .regex(/^[!#$%&'*+.^`|~\\w-]+\\/[!#$%&'*+.^`|~\\w-]+$/, 'MIME type must use the type/subtype format')\n\nconst uploadFileSchema = z.object({\n filename: z.string(),\n mimeType: z.string(),\n size: z.number().int().nonnegative(),\n uploadReference: z.record(z.string(), z.unknown()),\n})\n\nexport const fileInputSchema = z\n .discriminatedUnion('source', [\n z.object({\n name: z.string().min(1).describe('The file name, including its extension'),\n data: z.string().describe('The base64-encoded file bytes, without a data URL prefix'),\n mimeType: mimeTypeSchema.describe('The file MIME type, for example image/png'),\n source: z.literal('base64'),\n }),\n z.object({\n name: z.string().min(1).describe('Optional file name override').optional(),\n source: z.literal('externalURL'),\n url: z.url().describe('The http or https URL to download'),\n }),\n z.object({\n file: uploadFileSchema.describe('getUploadInstructions file field post-upload'),\n source: z.literal('uploadReference'),\n }),\n ])\n .describe(\n 'A file for an upload collection. Prefer uploadReference after its upload succeeds; use base64 only for small local files or externalURL for an online file.',\n )\n\ntype FileInput = z.infer<typeof fileInputSchema>\n\nexport async function resolveFile({\n collectionSlug,\n input,\n req,\n}: {\n collectionSlug: CollectionSlug\n input?: FileInput\n req: PayloadRequest\n}): Promise<File | undefined> {\n if (!input) {\n return undefined\n }\n\n if (input.source === 'uploadReference') {\n try {\n return await getFileFromUploadInstructions({ collectionSlug, file: input.file, req })\n } catch (error) {\n if (error instanceof Error && error.message === 'Staged upload was not found.') {\n throw new APIError(\n 'Staged upload not found. Complete the upload action first, or use base64 for small local files.',\n 400,\n )\n }\n throw error\n }\n }\n\n const uploadConfig = req.payload.collections[collectionSlug]?.config.upload\n\n if (!uploadConfig) {\n throw new APIError(`Collection \"${collectionSlug}\" does not support file uploads.`, 400)\n }\n\n const maxFileSize = req.payload.config.upload.limits?.fileSize\n let file: File\n\n if (input.source === 'base64') {\n const data = decodeBase64({ maxFileSize, value: input.data })\n\n file = {\n name: sanitizeFilename(input.name),\n data,\n mimetype: input.mimeType,\n size: data.length,\n }\n } else {\n if (uploadConfig.pasteURL === false) {\n throw new APIError(\n `Uploading files from URLs is disabled for collection \"${collectionSlug}\".`,\n 400,\n )\n }\n\n const url = new URL(input.url)\n\n if (!['http:', 'https:'].includes(url.protocol)) {\n throw new APIError('File URLs must use http or https.', 400)\n }\n\n if (\n typeof uploadConfig.pasteURL === 'object' &&\n !isURLAllowed(input.url, uploadConfig.pasteURL.allowList)\n ) {\n throw new APIError('The provided file URL is not allowed.', 400)\n }\n\n file = await getExternalFile({\n data: {\n filename: sanitizeFilename(input.name || getURLFilename(url)),\n url: input.url,\n } as FileData,\n req,\n uploadConfig: {\n ...uploadConfig,\n externalFileHeaderFilter: uploadConfig.externalFileHeaderFilter ?? (() => ({})),\n },\n })\n file.mimetype = file.mimetype?.split(';')[0] || 'application/octet-stream'\n file.size = file.data.length\n }\n\n if (maxFileSize !== undefined && Number.isFinite(maxFileSize) && file.size > maxFileSize) {\n throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)\n }\n\n return file\n}\n\nfunction decodeBase64({ maxFileSize, value }: { maxFileSize?: number; value: string }): Buffer {\n const normalized = value.replace(/\\s/g, '')\n\n if (!/^[a-z0-9+/]*={0,2}$/i.test(normalized) || normalized.length % 4 === 1) {\n throw new APIError('File data must be valid base64.', 400)\n }\n\n if (maxFileSize !== undefined && Number.isFinite(maxFileSize)) {\n const paddingLength = normalized.endsWith('==') ? 2 : normalized.endsWith('=') ? 1 : 0\n const decodedSize = Math.floor((normalized.length * 3) / 4) - paddingLength\n\n if (decodedSize > maxFileSize) {\n throw new APIError(`File exceeds the ${maxFileSize} byte upload limit.`, 400)\n }\n }\n\n const data = Buffer.from(normalized, 'base64')\n\n if (data.toString('base64').replace(/=+$/, '') !== normalized.replace(/=+$/, '')) {\n throw new APIError('File data must be valid base64.', 400)\n }\n\n return data\n}\n\nfunction getURLFilename(url: URL): string {\n const pathSegment = url.pathname.split('/').pop() || 'upload'\n\n try {\n return decodeURIComponent(pathSegment)\n } catch {\n return pathSegment\n }\n}\n"],"names":["APIError","getExternalFile","getFileFromUploadInstructions","isURLAllowed","sanitizeFilename","z","mimeTypeSchema","string","regex","uploadFileSchema","object","filename","mimeType","size","number","int","nonnegative","uploadReference","record","unknown","fileInputSchema","discriminatedUnion","name","min","describe","data","source","literal","optional","url","file","resolveFile","collectionSlug","input","req","undefined","error","Error","message","uploadConfig","payload","collections","config","upload","maxFileSize","limits","fileSize","decodeBase64","value","mimetype","length","pasteURL","URL","includes","protocol","allowList","getURLFilename","externalFileHeaderFilter","split","Number","isFinite","normalized","replace","test","paddingLength","endsWith","decodedSize","Math","floor","Buffer","from","toString","pathSegment","pathname","pop","decodeURIComponent"],"mappings":"AAEA,SAASA,QAAQ,QAAQ,UAAS;AAClC,SAASC,eAAe,EAAEC,6BAA6B,EAAEC,YAAY,QAAQ,mBAAkB;AAC/F,SAASC,gBAAgB,QAAQ,iBAAgB;AACjD,SAASC,CAAC,QAAQ,MAAK;AAEvB,MAAMC,iBAAiBD,EACpBE,MAAM,GACNC,KAAK,CAAC,8CAA8C;AAEvD,MAAMC,mBAAmBJ,EAAEK,MAAM,CAAC;IAChCC,UAAUN,EAAEE,MAAM;IAClBK,UAAUP,EAAEE,MAAM;IAClBM,MAAMR,EAAES,MAAM,GAAGC,GAAG,GAAGC,WAAW;IAClCC,iBAAiBZ,EAAEa,MAAM,CAACb,EAAEE,MAAM,IAAIF,EAAEc,OAAO;AACjD;AAEA,OAAO,MAAMC,kBAAkBf,EAC5BgB,kBAAkB,CAAC,UAAU;IAC5BhB,EAAEK,MAAM,CAAC;QACPY,MAAMjB,EAAEE,MAAM,GAAGgB,GAAG,CAAC,GAAGC,QAAQ,CAAC;QACjCC,MAAMpB,EAAEE,MAAM,GAAGiB,QAAQ,CAAC;QAC1BZ,UAAUN,eAAekB,QAAQ,CAAC;QAClCE,QAAQrB,EAAEsB,OAAO,CAAC;IACpB;IACAtB,EAAEK,MAAM,CAAC;QACPY,MAAMjB,EAAEE,MAAM,GAAGgB,GAAG,CAAC,GAAGC,QAAQ,CAAC,+BAA+BI,QAAQ;QACxEF,QAAQrB,EAAEsB,OAAO,CAAC;QAClBE,KAAKxB,EAAEwB,GAAG,GAAGL,QAAQ,CAAC;IACxB;IACAnB,EAAEK,MAAM,CAAC;QACPoB,MAAMrB,iBAAiBe,QAAQ,CAAC;QAChCE,QAAQrB,EAAEsB,OAAO,CAAC;IACpB;CACD,EACAH,QAAQ,CACP,+JACD;AAIH,OAAO,eAAeO,YAAY,EAChCC,cAAc,EACdC,KAAK,EACLC,GAAG,EAKJ;IACC,IAAI,CAACD,OAAO;QACV,OAAOE;IACT;IAEA,IAAIF,MAAMP,MAAM,KAAK,mBAAmB;QACtC,IAAI;YACF,OAAO,MAAMxB,8BAA8B;gBAAE8B;gBAAgBF,MAAMG,MAAMH,IAAI;gBAAEI;YAAI;QACrF,EAAE,OAAOE,OAAO;YACd,IAAIA,iBAAiBC,SAASD,MAAME,OAAO,KAAK,gCAAgC;gBAC9E,MAAM,IAAItC,SACR,mGACA;YAEJ;YACA,MAAMoC;QACR;IACF;IAEA,MAAMG,eAAeL,IAAIM,OAAO,CAACC,WAAW,CAACT,eAAe,EAAEU,OAAOC;IAErE,IAAI,CAACJ,cAAc;QACjB,MAAM,IAAIvC,SAAS,CAAC,YAAY,EAAEgC,eAAe,gCAAgC,CAAC,EAAE;IACtF;IAEA,MAAMY,cAAcV,IAAIM,OAAO,CAACE,MAAM,CAACC,MAAM,CAACE,MAAM,EAAEC;IACtD,IAAIhB;IAEJ,IAAIG,MAAMP,MAAM,KAAK,UAAU;QAC7B,MAAMD,OAAOsB,aAAa;YAAEH;YAAaI,OAAOf,MAAMR,IAAI;QAAC;QAE3DK,OAAO;YACLR,MAAMlB,iBAAiB6B,MAAMX,IAAI;YACjCG;YACAwB,UAAUhB,MAAMrB,QAAQ;YACxBC,MAAMY,KAAKyB,MAAM;QACnB;IACF,OAAO;QACL,IAAIX,aAAaY,QAAQ,KAAK,OAAO;YACnC,MAAM,IAAInD,SACR,CAAC,sDAAsD,EAAEgC,eAAe,EAAE,CAAC,EAC3E;QAEJ;QAEA,MAAMH,MAAM,IAAIuB,IAAInB,MAAMJ,GAAG;QAE7B,IAAI,CAAC;YAAC;YAAS;SAAS,CAACwB,QAAQ,CAACxB,IAAIyB,QAAQ,GAAG;YAC/C,MAAM,IAAItD,SAAS,qCAAqC;QAC1D;QAEA,IACE,OAAOuC,aAAaY,QAAQ,KAAK,YACjC,CAAChD,aAAa8B,MAAMJ,GAAG,EAAEU,aAAaY,QAAQ,CAACI,SAAS,GACxD;YACA,MAAM,IAAIvD,SAAS,yCAAyC;QAC9D;QAEA8B,OAAO,MAAM7B,gBAAgB;YAC3BwB,MAAM;gBACJd,UAAUP,iBAAiB6B,MAAMX,IAAI,IAAIkC,eAAe3B;gBACxDA,KAAKI,MAAMJ,GAAG;YAChB;YACAK;YACAK,cAAc;gBACZ,GAAGA,YAAY;gBACfkB,0BAA0BlB,aAAakB,wBAAwB,IAAK,CAAA,IAAO,CAAA,CAAC,CAAA,CAAC;YAC/E;QACF;QACA3B,KAAKmB,QAAQ,GAAGnB,KAAKmB,QAAQ,EAAES,MAAM,IAAI,CAAC,EAAE,IAAI;QAChD5B,KAAKjB,IAAI,GAAGiB,KAAKL,IAAI,CAACyB,MAAM;IAC9B;IAEA,IAAIN,gBAAgBT,aAAawB,OAAOC,QAAQ,CAAChB,gBAAgBd,KAAKjB,IAAI,GAAG+B,aAAa;QACxF,MAAM,IAAI5C,SAAS,CAAC,iBAAiB,EAAE4C,YAAY,mBAAmB,CAAC,EAAE;IAC3E;IAEA,OAAOd;AACT;AAEA,SAASiB,aAAa,EAAEH,WAAW,EAAEI,KAAK,EAA2C;IACnF,MAAMa,aAAab,MAAMc,OAAO,CAAC,OAAO;IAExC,IAAI,CAAC,uBAAuBC,IAAI,CAACF,eAAeA,WAAWX,MAAM,GAAG,MAAM,GAAG;QAC3E,MAAM,IAAIlD,SAAS,mCAAmC;IACxD;IAEA,IAAI4C,gBAAgBT,aAAawB,OAAOC,QAAQ,CAAChB,cAAc;QAC7D,MAAMoB,gBAAgBH,WAAWI,QAAQ,CAAC,QAAQ,IAAIJ,WAAWI,QAAQ,CAAC,OAAO,IAAI;QACrF,MAAMC,cAAcC,KAAKC,KAAK,CAAC,AAACP,WAAWX,MAAM,GAAG,IAAK,KAAKc;QAE9D,IAAIE,cAActB,aAAa;YAC7B,MAAM,IAAI5C,SAAS,CAAC,iBAAiB,EAAE4C,YAAY,mBAAmB,CAAC,EAAE;QAC3E;IACF;IAEA,MAAMnB,OAAO4C,OAAOC,IAAI,CAACT,YAAY;IAErC,IAAIpC,KAAK8C,QAAQ,CAAC,UAAUT,OAAO,CAAC,OAAO,QAAQD,WAAWC,OAAO,CAAC,OAAO,KAAK;QAChF,MAAM,IAAI9D,SAAS,mCAAmC;IACxD;IAEA,OAAOyB;AACT;AAEA,SAAS+B,eAAe3B,GAAQ;IAC9B,MAAM2C,cAAc3C,IAAI4C,QAAQ,CAACf,KAAK,CAAC,KAAKgB,GAAG,MAAM;IAErD,IAAI;QACF,OAAOC,mBAAmBH;IAC5B,EAAE,OAAM;QACN,OAAOA;IACT;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { describe, expect, it } from 'vitest';
|
|
2
|
-
import { fileInputSchema,
|
|
2
|
+
import { fileInputSchema, resolveFile } from './fileInput.js';
|
|
3
3
|
describe('MCP file input', ()=>{
|
|
4
4
|
it('should reject malformed MIME types', ()=>{
|
|
5
5
|
const result = fileInputSchema.safeParse({
|
|
@@ -10,11 +10,25 @@ describe('MCP file input', ()=>{
|
|
|
10
10
|
});
|
|
11
11
|
expect(result.success).toBe(false);
|
|
12
12
|
});
|
|
13
|
+
it('should accept a prepared upload', ()=>{
|
|
14
|
+
const result = fileInputSchema.safeParse({
|
|
15
|
+
file: {
|
|
16
|
+
filename: 'image.png',
|
|
17
|
+
mimeType: 'image/png',
|
|
18
|
+
size: 123,
|
|
19
|
+
uploadReference: {
|
|
20
|
+
uploadId: 'upload-id'
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
source: 'uploadReference'
|
|
24
|
+
});
|
|
25
|
+
expect(result.success).toBe(true);
|
|
26
|
+
});
|
|
13
27
|
it('should reject oversized base64 files', async ()=>{
|
|
14
28
|
const req = createRequest({
|
|
15
29
|
maxFileSize: 4
|
|
16
30
|
});
|
|
17
|
-
await expect(
|
|
31
|
+
await expect(resolveFile({
|
|
18
32
|
collectionSlug: 'media',
|
|
19
33
|
input: {
|
|
20
34
|
data: Buffer.from('hello').toString('base64'),
|
|
@@ -34,10 +48,10 @@ describe('MCP file input', ()=>{
|
|
|
34
48
|
}
|
|
35
49
|
]
|
|
36
50
|
});
|
|
37
|
-
await expect(
|
|
51
|
+
await expect(resolveFile({
|
|
38
52
|
collectionSlug: 'media',
|
|
39
53
|
input: {
|
|
40
|
-
source: '
|
|
54
|
+
source: 'externalURL',
|
|
41
55
|
url: 'https://example.com/image.png'
|
|
42
56
|
},
|
|
43
57
|
req
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/mcp/builtin/collections/fileInput.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport { fileInputSchema,
|
|
1
|
+
{"version":3,"sources":["../../../../src/mcp/builtin/collections/fileInput.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport { fileInputSchema, resolveFile } from './fileInput.js'\n\ndescribe('MCP file input', () => {\n it('should reject malformed MIME types', () => {\n const result = fileInputSchema.safeParse({\n data: 'aGVsbG8=',\n mimeType: 'text/plain\\r\\nx-test: value',\n name: 'hello.txt',\n source: 'base64',\n })\n\n expect(result.success).toBe(false)\n })\n\n it('should accept a prepared upload', () => {\n const result = fileInputSchema.safeParse({\n file: {\n filename: 'image.png',\n mimeType: 'image/png',\n size: 123,\n uploadReference: { uploadId: 'upload-id' },\n },\n source: 'uploadReference',\n })\n\n expect(result.success).toBe(true)\n })\n\n it('should reject oversized base64 files', async () => {\n const req = createRequest({ maxFileSize: 4 })\n\n await expect(\n resolveFile({\n collectionSlug: 'media',\n input: {\n data: Buffer.from('hello').toString('base64'),\n mimeType: 'text/plain',\n name: 'hello.txt',\n source: 'base64',\n },\n req,\n }),\n ).rejects.toThrow('File exceeds the 4 byte upload limit.')\n })\n\n it('should reject URLs outside the collection allowlist', async () => {\n const req = createRequest({\n allowList: [{ hostname: 'assets.example.com', protocol: 'https' }],\n })\n\n await expect(\n resolveFile({\n collectionSlug: 'media',\n input: {\n source: 'externalURL',\n url: 'https://example.com/image.png',\n },\n req,\n }),\n ).rejects.toThrow('The provided file URL is not allowed.')\n })\n})\n\nfunction createRequest({\n allowList,\n maxFileSize,\n}: {\n allowList?: Array<{ hostname: string; protocol: 'http' | 'https' }>\n maxFileSize?: number\n}): PayloadRequest {\n return {\n payload: {\n collections: {\n media: {\n config: {\n upload: allowList ? { pasteURL: { allowList } } : {},\n },\n },\n },\n config: {\n upload: {\n limits: {\n fileSize: maxFileSize,\n },\n },\n },\n },\n } as unknown as PayloadRequest\n}\n"],"names":["describe","expect","it","fileInputSchema","resolveFile","result","safeParse","data","mimeType","name","source","success","toBe","file","filename","size","uploadReference","uploadId","req","createRequest","maxFileSize","collectionSlug","input","Buffer","from","toString","rejects","toThrow","allowList","hostname","protocol","url","payload","collections","media","config","upload","pasteURL","limits","fileSize"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAE7C,SAASC,eAAe,EAAEC,WAAW,QAAQ,iBAAgB;AAE7DJ,SAAS,kBAAkB;IACzBE,GAAG,sCAAsC;QACvC,MAAMG,SAASF,gBAAgBG,SAAS,CAAC;YACvCC,MAAM;YACNC,UAAU;YACVC,MAAM;YACNC,QAAQ;QACV;QAEAT,OAAOI,OAAOM,OAAO,EAAEC,IAAI,CAAC;IAC9B;IAEAV,GAAG,mCAAmC;QACpC,MAAMG,SAASF,gBAAgBG,SAAS,CAAC;YACvCO,MAAM;gBACJC,UAAU;gBACVN,UAAU;gBACVO,MAAM;gBACNC,iBAAiB;oBAAEC,UAAU;gBAAY;YAC3C;YACAP,QAAQ;QACV;QAEAT,OAAOI,OAAOM,OAAO,EAAEC,IAAI,CAAC;IAC9B;IAEAV,GAAG,wCAAwC;QACzC,MAAMgB,MAAMC,cAAc;YAAEC,aAAa;QAAE;QAE3C,MAAMnB,OACJG,YAAY;YACViB,gBAAgB;YAChBC,OAAO;gBACLf,MAAMgB,OAAOC,IAAI,CAAC,SAASC,QAAQ,CAAC;gBACpCjB,UAAU;gBACVC,MAAM;gBACNC,QAAQ;YACV;YACAQ;QACF,IACAQ,OAAO,CAACC,OAAO,CAAC;IACpB;IAEAzB,GAAG,uDAAuD;QACxD,MAAMgB,MAAMC,cAAc;YACxBS,WAAW;gBAAC;oBAAEC,UAAU;oBAAsBC,UAAU;gBAAQ;aAAE;QACpE;QAEA,MAAM7B,OACJG,YAAY;YACViB,gBAAgB;YAChBC,OAAO;gBACLZ,QAAQ;gBACRqB,KAAK;YACP;YACAb;QACF,IACAQ,OAAO,CAACC,OAAO,CAAC;IACpB;AACF;AAEA,SAASR,cAAc,EACrBS,SAAS,EACTR,WAAW,EAIZ;IACC,OAAO;QACLY,SAAS;YACPC,aAAa;gBACXC,OAAO;oBACLC,QAAQ;wBACNC,QAAQR,YAAY;4BAAES,UAAU;gCAAET;4BAAU;wBAAE,IAAI,CAAC;oBACrD;gBACF;YACF;YACAO,QAAQ;gBACNC,QAAQ;oBACNE,QAAQ;wBACNC,UAAUnB;oBACZ;gBACF;YACF;QACF;IACF;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getCollectionSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,uBAAuB,
|
|
1
|
+
{"version":3,"file":"getCollectionSchemaTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,uBAAuB,4CAyElC,CAAA"}
|
|
@@ -58,9 +58,10 @@ export const getCollectionSchemaTool = defineCollectionTool({
|
|
|
58
58
|
],
|
|
59
59
|
sources: [
|
|
60
60
|
...uploadConfig.pasteURL !== false ? [
|
|
61
|
-
'
|
|
61
|
+
'externalURL'
|
|
62
62
|
] : [],
|
|
63
|
-
'base64'
|
|
63
|
+
'base64',
|
|
64
|
+
'uploadReference'
|
|
64
65
|
],
|
|
65
66
|
...typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? {
|
|
66
67
|
maxFileSize
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { getAccessResults } from 'payload'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n access: (args) => {\n const permissions = args.permissions?.collections?.[args.collectionSlug]\n\n return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)\n },\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(async ({ authorizedMCP, collectionSlug, req }) => {\n const permissions = authorizedMCP.overrideAccess\n ? null\n : (await getAccessResults({ req })).collections?.[collectionSlug]\n\n if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {\n return {\n content: [\n {\n type: 'text',\n text: `Error: MCP access to \"getCollectionSchema\" is not enabled for collection \"${collectionSlug}\"`,\n },\n ],\n isError: true,\n }\n }\n\n const inputSchema = getCollectionInputSchema({\n collectionSlug,\n req,\n ...(permissions ? { permissions } : {}),\n })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${collectionSlug}\" not found` }],\n isError: true,\n }\n }\n\n const uploadConfig = req.payload.collections[collectionSlug]?.config.upload\n const maxFileSize = req.payload.config.upload.limits?.fileSize\n const upload = uploadConfig\n ? {\n enabled: true,\n filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,\n mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],\n sources: [...(uploadConfig.pasteURL !== false ? ['
|
|
1
|
+
{"version":3,"sources":["../../../../src/mcp/builtin/collections/getCollectionSchemaTool.ts"],"sourcesContent":["import { getAccessResults } from 'payload'\n\nimport { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getCollectionInputSchema } from '../../../utils/schemaConversion/getEntityInputSchema.js'\n\nexport const getCollectionSchemaTool = defineCollectionTool({\n access: (args) => {\n const permissions = args.permissions?.collections?.[args.collectionSlug]\n\n return defaultAccess(args) && Boolean(permissions?.create || permissions?.update)\n },\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(async ({ authorizedMCP, collectionSlug, req }) => {\n const permissions = authorizedMCP.overrideAccess\n ? null\n : (await getAccessResults({ req })).collections?.[collectionSlug]\n\n if (!authorizedMCP.overrideAccess && !permissions?.create && !permissions?.update) {\n return {\n content: [\n {\n type: 'text',\n text: `Error: MCP access to \"getCollectionSchema\" is not enabled for collection \"${collectionSlug}\"`,\n },\n ],\n isError: true,\n }\n }\n\n const inputSchema = getCollectionInputSchema({\n collectionSlug,\n req,\n ...(permissions ? { permissions } : {}),\n })\n\n if (!inputSchema) {\n return {\n content: [{ type: 'text', text: `Error: Collection \"${collectionSlug}\" not found` }],\n isError: true,\n }\n }\n\n const uploadConfig = req.payload.collections[collectionSlug]?.config.upload\n const maxFileSize = req.payload.config.upload.limits?.fileSize\n const upload = uploadConfig\n ? {\n enabled: true,\n filesRequiredOnCreate: uploadConfig.filesRequiredOnCreate !== false,\n mimeTypes: uploadConfig.mimeTypes ?? ['*/*'],\n sources: [\n ...(uploadConfig.pasteURL !== false ? ['externalURL'] : []),\n 'base64',\n 'uploadReference',\n ],\n ...(typeof maxFileSize === 'number' && Number.isFinite(maxFileSize) ? { maxFileSize } : {}),\n }\n : { enabled: false }\n\n return {\n content: [\n {\n type: 'text',\n text: `Schema for collection \"${collectionSlug}\":\\n\\`\\`\\`json\\n${JSON.stringify(inputSchema)}\\n\\`\\`\\`\\nUpload configuration:\\n\\`\\`\\`json\\n${JSON.stringify(upload)}\\n\\`\\`\\``,\n },\n ],\n structuredContent: {\n collectionSlug,\n schema: inputSchema,\n upload,\n },\n }\n})\n"],"names":["getAccessResults","defaultAccess","defineCollectionTool","getCollectionInputSchema","getCollectionSchemaTool","access","args","permissions","collections","collectionSlug","Boolean","create","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","handler","authorizedMCP","req","overrideAccess","content","type","text","isError","inputSchema","uploadConfig","payload","config","upload","maxFileSize","limits","fileSize","enabled","filesRequiredOnCreate","mimeTypes","sources","pasteURL","Number","isFinite","JSON","stringify","structuredContent","schema"],"mappings":"AAAA,SAASA,gBAAgB,QAAQ,UAAS;AAE1C,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,wBAAwB,QAAQ,0DAAyD;AAElG,OAAO,MAAMC,0BAA0BF,qBAAqB;IAC1DG,QAAQ,CAACC;QACP,MAAMC,cAAcD,KAAKC,WAAW,EAAEC,aAAa,CAACF,KAAKG,cAAc,CAAC;QAExE,OAAOR,cAAcK,SAASI,QAAQH,aAAaI,UAAUJ,aAAaK;IAC5E;IACAC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAa;AACf,GAAGC,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEZ,cAAc,EAAEa,GAAG,EAAE;IACtD,MAAMf,cAAcc,cAAcE,cAAc,GAC5C,OACA,AAAC,CAAA,MAAMvB,iBAAiB;QAAEsB;IAAI,EAAC,EAAGd,WAAW,EAAE,CAACC,eAAe;IAEnE,IAAI,CAACY,cAAcE,cAAc,IAAI,CAAChB,aAAaI,UAAU,CAACJ,aAAaK,QAAQ;QACjF,OAAO;YACLY,SAAS;gBACP;oBACEC,MAAM;oBACNC,MAAM,CAAC,0EAA0E,EAAEjB,eAAe,CAAC,CAAC;gBACtG;aACD;YACDkB,SAAS;QACX;IACF;IAEA,MAAMC,cAAczB,yBAAyB;QAC3CM;QACAa;QACA,GAAIf,cAAc;YAAEA;QAAY,IAAI,CAAC,CAAC;IACxC;IAEA,IAAI,CAACqB,aAAa;QAChB,OAAO;YACLJ,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAM,CAAC,mBAAmB,EAAEjB,eAAe,WAAW,CAAC;gBAAC;aAAE;YACpFkB,SAAS;QACX;IACF;IAEA,MAAME,eAAeP,IAAIQ,OAAO,CAACtB,WAAW,CAACC,eAAe,EAAEsB,OAAOC;IACrE,MAAMC,cAAcX,IAAIQ,OAAO,CAACC,MAAM,CAACC,MAAM,CAACE,MAAM,EAAEC;IACtD,MAAMH,SAASH,eACX;QACEO,SAAS;QACTC,uBAAuBR,aAAaQ,qBAAqB,KAAK;QAC9DC,WAAWT,aAAaS,SAAS,IAAI;YAAC;SAAM;QAC5CC,SAAS;eACHV,aAAaW,QAAQ,KAAK,QAAQ;gBAAC;aAAc,GAAG,EAAE;YAC1D;YACA;SACD;QACD,GAAI,OAAOP,gBAAgB,YAAYQ,OAAOC,QAAQ,CAACT,eAAe;YAAEA;QAAY,IAAI,CAAC,CAAC;IAC5F,IACA;QAAEG,SAAS;IAAM;IAErB,OAAO;QACLZ,SAAS;YACP;gBACEC,MAAM;gBACNC,MAAM,CAAC,uBAAuB,EAAEjB,eAAe,gBAAgB,EAAEkC,KAAKC,SAAS,CAAChB,aAAa,6CAA6C,EAAEe,KAAKC,SAAS,CAACZ,QAAQ,QAAQ,CAAC;YAC9K;SACD;QACDa,mBAAmB;YACjBpC;YACAqC,QAAQlB;YACRI;QACF;IACF;AACF,GAAE"}
|
|
@@ -7,9 +7,9 @@ import { getCollectionInputSchema } from '../../../utils/schemaConversion/getEnt
|
|
|
7
7
|
import { transformPointDataToPayload } from '../../../utils/transformPointDataToPayload.js';
|
|
8
8
|
import { whereSchema } from '../../../utils/whereSchema.js';
|
|
9
9
|
import { validateCollectionData } from '../validateEntityData.js';
|
|
10
|
-
import { fileInputSchema,
|
|
10
|
+
import { fileInputSchema, resolveFile } from './fileInput.js';
|
|
11
11
|
import { formatCollectionError } from './formatCollectionError.js';
|
|
12
|
-
const DEFAULT_DESCRIPTION = 'Update documents
|
|
12
|
+
const DEFAULT_DESCRIPTION = 'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.';
|
|
13
13
|
export const updateDocumentTool = defineCollectionTool({
|
|
14
14
|
access: (args)=>defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),
|
|
15
15
|
annotations: {
|
|
@@ -67,7 +67,7 @@ export const updateDocumentTool = defineCollectionTool({
|
|
|
67
67
|
return validationError;
|
|
68
68
|
}
|
|
69
69
|
const parsedData = transformPointDataToPayload(inputData);
|
|
70
|
-
const file = await
|
|
70
|
+
const file = await resolveFile({
|
|
71
71
|
collectionSlug,
|
|
72
72
|
input: fileInput,
|
|
73
73
|
req
|
|
@@ -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 { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.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 { fileInputSchema, resolveFileInput } from './fileInput.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 access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),\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\n .record(z.string(), z.unknown())\n .describe(\n 'The fields to update. Only include fields permitted by the schema returned by getCollectionSchema.',\n ),\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(\n '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.',\n )\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 file: fileInputSchema.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 publishAllLocales: z\n .boolean()\n .describe(\n 'For collections with localized publishing status, whether publishing should affect every locale. Set false with locale to publish only that 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 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 file: fileInput,\n locale,\n overrideLock,\n overwriteExistingFiles,\n publishAllLocales,\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 const file = await resolveFileInput({ collectionSlug, input: fileInput, req })\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 overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n req,\n ...(file ? { file } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),\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 overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n req,\n where: whereClause,\n ...(file ? { file } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),\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","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","getCollectionInputSchema","transformPointDataToPayload","whereSchema","validateCollectionData","fileInputSchema","resolveFileInput","formatCollectionError","DEFAULT_DESCRIPTION","updateDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","data","record","unknown","depth","default","draft","boolean","fallbackLocale","file","locale","overrideLock","overwriteExistingFiles","publishAllLocales","select","where","handler","authorizedMCP","req","payload","logger","fileInput","info","content","type","text","virtualFieldNames","config","inputData","validationError","partial","parsedData","whereClause","result","collection","overrideAccess","undefined","JSON","stringify","doc","docs","errors","responseText","length","errorSchema","isError","structuredContent","schema","error","errorMessage","Error","message","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,wBAAwB,QAAQ,0DAAyD;AAClG,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,eAAe,EAAEC,gBAAgB,QAAQ,iBAAgB;AAClE,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBZ,qBAAqB;IACrDa,QAAQ,CAACC,OACPf,cAAce,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAO7B,EAAE8B,MAAM,CAAC;QACdC,IAAI/B,EAAEgC,KAAK,CAAC;YAAChC,EAAEiC,MAAM;YAAIjC,EAAEkC,MAAM;SAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;QAC3FC,MAAMrC,EACHsC,MAAM,CAACtC,EAAEiC,MAAM,IAAIjC,EAAEuC,OAAO,IAC5BJ,QAAQ,CACP;QAEJK,OAAOxC,EACJkC,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAO1C,EACJ2C,OAAO,GACPR,QAAQ,CACP,+LAEDC,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgB5C,EACbiC,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,MAAMnC,gBAAgB0B,QAAQ;QAC9BU,QAAQ9C,EACLiC,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;QACXW,cAAc/C,EACX2C,OAAO,GACPR,QAAQ,CAAC,sCACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,wBAAwBhD,EACrB2C,OAAO,GACPR,QAAQ,CAAC,uCACTC,QAAQ,GACRK,OAAO,CAAC;QACXQ,mBAAmBjD,EAChB2C,OAAO,GACPR,QAAQ,CACP,uJAEDC,QAAQ;QACXc,QAAQlD,EACLsC,MAAM,CAACtC,EAAEiC,MAAM,IAAIjC,EAAEuC,OAAO,IAC5BJ,QAAQ,CACP,sGAEDC,QAAQ;QACXe,OAAO3C,YACJ2B,QAAQ,CACP,yJAEDC,QAAQ;IACb;AACF,GAAGgB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEjC,cAAc,EAAES,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASrD,UAAU;QAAEoD;IAAQ;IAEnC,MAAM,EACJxB,EAAE,EACFM,IAAI,EACJG,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,MAAMY,SAAS,EACfX,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,iBAAiB,EACjBC,MAAM,EACNC,KAAK,EACN,GAAGtB;IAEJ2B,OAAOE,IAAI,CACT,CAAC,iCAAiC,EAAEtC,iBAAiBW,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEW,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACf,MAAM,CAACoB,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,oBAAoB1D,+BAA+BmD,QAAQQ,MAAM,EAAE3C;QACzE,MAAM4C,YAAY3D,mBAAmBgC,MAAMyB;QAC3C,MAAMG,kBAAkBxD,uBAAuB;YAC7CW;YACAiB,MAAM2B;YACNE,SAAS;YACTZ;QACF;QAEA,IAAIW,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAME,aAAa5D,4BAA4ByD;QAC/C,MAAMnB,OAAO,MAAMlC,iBAAiB;YAAES;YAAgBS,OAAO4B;YAAWH;QAAI;QAE5E,MAAMc,cAAqBjB,SAAS,CAAC;QAErC,IAAIpB,IAAI;YACN,MAAMsC,SAAS,MAAMd,QAAQlC,MAAM,CAAC;gBAClCU;gBACAuC,YAAYlD;gBACZiB,MAAM8B;gBACN3B;gBACAE;gBACA6B,gBAAgBlB,cAAckB,cAAc;gBAC5CxB;gBACAO;gBACA,GAAIT,OAAO;oBAAEA;gBAAK,IAAI,CAAC,CAAC;gBACxB,GAAIG,yBAAyB;oBAAEA;gBAAuB,IAAI,CAAC,CAAC;gBAC5D,GAAIC,sBAAsBuB,YAAY;oBAAEvB;gBAAkB,IAAI,CAAC,CAAC;gBAChE,GAAIH,SAAS;oBAAEA;gBAAO,IAAI,CAAC,CAAC;gBAC5B,GAAIF,iBAAiB;oBAAEA;gBAAe,IAAI,CAAC,CAAC;gBAC5C,GAAIM,SAAS;oBAAEA,QAAQA;gBAAqB,IAAI,CAAC,CAAC;YACpD;YAEA,OAAO;gBACLS,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEzC,eAAe,mCAAmC,EAAEqD,KAAKC,SAAS,CAACL,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDM,KAAKN;YACP;QACF;QAEA,MAAMA,SAAS,MAAMd,QAAQlC,MAAM,CAAC;YAClCiD,YAAYlD;YACZiB,MAAM8B;YACN3B;YACAE;YACA6B,gBAAgBlB,cAAckB,cAAc;YAC5CxB;YACAO;YACAH,OAAOiB;YACP,GAAIvB,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIG,yBAAyB;gBAAEA;YAAuB,IAAI,CAAC,CAAC;YAC5D,GAAIC,sBAAsBuB,YAAY;gBAAEvB;YAAkB,IAAI,CAAC,CAAC;YAChE,GAAIH,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIM,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEA,MAAM0B,OAAOP,OAAOO,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASR,OAAOQ,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,0CAA0C,EAAE1D,eAAe,aAAa,EAAEwD,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,cAAc1E,yBAAyB;gBAAEc;gBAAgBkC;YAAI;YAEnE,IAAI0B,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEL,KAAKC,SAAS,CAACM,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLrB,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMiB;oBAAa;iBAAE;gBAC/CH,KAAK;oBAAEC;oBAAMC;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB9D;wBACAwD;wBACAC;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLrB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMiB;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D/B,OAAO4B,KAAK,CAAC,CAAC,2BAA2B,EAAEhE,eAAe,EAAE,EAAEiE,cAAc;QAC5E,OAAOzE,sBAAsB;YAAE4E,QAAQ;YAAYpE;YAAgBgE;YAAO9B;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 { defaultAccess } from '../../../defaultAccess.js'\nimport { defineCollectionTool } from '../../../defineTool.js'\nimport { getLogger } from '../../../utils/getLogger.js'\nimport {\n getCollectionVirtualFieldNames,\n stripVirtualFields,\n} from '../../../utils/getVirtualFieldNames.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 { fileInputSchema, resolveFile } from './fileInput.js'\nimport { formatCollectionError } from './formatCollectionError.js'\n\nconst DEFAULT_DESCRIPTION =\n 'Update documents. Prefer uploadReference after upload, externalURL for URLs, or base64 for small local files.'\n\nexport const updateDocumentTool = defineCollectionTool({\n access: (args) =>\n defaultAccess(args) && Boolean(args.permissions?.collections?.[args.collectionSlug]?.update),\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\n .record(z.string(), z.unknown())\n .describe(\n 'The fields to update. Only include fields permitted by the schema returned by getCollectionSchema.',\n ),\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(\n '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.',\n )\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 file: fileInputSchema.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 publishAllLocales: z\n .boolean()\n .describe(\n 'For collections with localized publishing status, whether publishing should affect every locale. Set false with locale to publish only that 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 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 file: fileInput,\n locale,\n overrideLock,\n overwriteExistingFiles,\n publishAllLocales,\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 const file = await resolveFile({ collectionSlug, input: fileInput, req })\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 overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n req,\n ...(file ? { file } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),\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 overrideAccess: authorizedMCP.overrideAccess,\n overrideLock,\n req,\n where: whereClause,\n ...(file ? { file } : {}),\n ...(overwriteExistingFiles ? { overwriteExistingFiles } : {}),\n ...(publishAllLocales !== undefined ? { publishAllLocales } : {}),\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","defaultAccess","defineCollectionTool","getLogger","getCollectionVirtualFieldNames","stripVirtualFields","getCollectionInputSchema","transformPointDataToPayload","whereSchema","validateCollectionData","fileInputSchema","resolveFile","formatCollectionError","DEFAULT_DESCRIPTION","updateDocumentTool","access","args","Boolean","permissions","collections","collectionSlug","update","annotations","destructiveHint","idempotentHint","openWorldHint","readOnlyHint","title","description","input","object","id","union","string","number","describe","optional","data","record","unknown","depth","default","draft","boolean","fallbackLocale","file","locale","overrideLock","overwriteExistingFiles","publishAllLocales","select","where","handler","authorizedMCP","req","payload","logger","fileInput","info","content","type","text","virtualFieldNames","config","inputData","validationError","partial","parsedData","whereClause","result","collection","overrideAccess","undefined","JSON","stringify","doc","docs","errors","responseText","length","errorSchema","isError","structuredContent","schema","error","errorMessage","Error","message","action"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAEvB,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,oBAAoB,QAAQ,yBAAwB;AAC7D,SAASC,SAAS,QAAQ,8BAA6B;AACvD,SACEC,8BAA8B,EAC9BC,kBAAkB,QACb,yCAAwC;AAC/C,SAASC,wBAAwB,QAAQ,0DAAyD;AAClG,SAASC,2BAA2B,QAAQ,gDAA+C;AAC3F,SAASC,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,sBAAsB,QAAQ,2BAA0B;AACjE,SAASC,eAAe,EAAEC,WAAW,QAAQ,iBAAgB;AAC7D,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,sBACJ;AAEF,OAAO,MAAMC,qBAAqBZ,qBAAqB;IACrDa,QAAQ,CAACC,OACPf,cAAce,SAASC,QAAQD,KAAKE,WAAW,EAAEC,aAAa,CAACH,KAAKI,cAAc,CAAC,EAAEC;IACvFC,aAAa;QACXC,iBAAiB;QACjBC,gBAAgB;QAChBC,eAAe;QACfC,cAAc;QACdC,OAAO;IACT;IACAC,aAAaf;IACbgB,OAAO7B,EAAE8B,MAAM,CAAC;QACdC,IAAI/B,EAAEgC,KAAK,CAAC;YAAChC,EAAEiC,MAAM;YAAIjC,EAAEkC,MAAM;SAAG,EAAEC,QAAQ,CAAC,oCAAoCC,QAAQ;QAC3FC,MAAMrC,EACHsC,MAAM,CAACtC,EAAEiC,MAAM,IAAIjC,EAAEuC,OAAO,IAC5BJ,QAAQ,CACP;QAEJK,OAAOxC,EACJkC,MAAM,GACNC,QAAQ,CAAC,kDACTC,QAAQ,GACRK,OAAO,CAAC;QACXC,OAAO1C,EACJ2C,OAAO,GACPR,QAAQ,CACP,+LAEDC,QAAQ,GACRK,OAAO,CAAC;QACXG,gBAAgB5C,EACbiC,MAAM,GACNE,QAAQ,CAAC,gFACTC,QAAQ;QACXS,MAAMnC,gBAAgB0B,QAAQ;QAC9BU,QAAQ9C,EACLiC,MAAM,GACNE,QAAQ,CACP,sGAEDC,QAAQ;QACXW,cAAc/C,EACX2C,OAAO,GACPR,QAAQ,CAAC,sCACTC,QAAQ,GACRK,OAAO,CAAC;QACXO,wBAAwBhD,EACrB2C,OAAO,GACPR,QAAQ,CAAC,uCACTC,QAAQ,GACRK,OAAO,CAAC;QACXQ,mBAAmBjD,EAChB2C,OAAO,GACPR,QAAQ,CACP,uJAEDC,QAAQ;QACXc,QAAQlD,EACLsC,MAAM,CAACtC,EAAEiC,MAAM,IAAIjC,EAAEuC,OAAO,IAC5BJ,QAAQ,CACP,sGAEDC,QAAQ;QACXe,OAAO3C,YACJ2B,QAAQ,CACP,yJAEDC,QAAQ;IACb;AACF,GAAGgB,OAAO,CAAC,OAAO,EAAEC,aAAa,EAAEjC,cAAc,EAAES,KAAK,EAAEyB,GAAG,EAAE;IAC7D,MAAMC,UAAUD,IAAIC,OAAO;IAC3B,MAAMC,SAASrD,UAAU;QAAEoD;IAAQ;IAEnC,MAAM,EACJxB,EAAE,EACFM,IAAI,EACJG,KAAK,EACLE,KAAK,EACLE,cAAc,EACdC,MAAMY,SAAS,EACfX,MAAM,EACNC,YAAY,EACZC,sBAAsB,EACtBC,iBAAiB,EACjBC,MAAM,EACNC,KAAK,EACN,GAAGtB;IAEJ2B,OAAOE,IAAI,CACT,CAAC,iCAAiC,EAAEtC,iBAAiBW,KAAK,CAAC,UAAU,EAAEA,IAAI,GAAG,qBAAqB,SAAS,EAAEW,QAAQI,SAAS,CAAC,UAAU,EAAEA,QAAQ,GAAG,IAAI;IAG7J,IAAI;QACF,IAAI,CAACf,MAAM,CAACoB,OAAO;YACjB,OAAO;gBACLQ,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAM;oBAAoD;iBAAE;YACxF;QACF;QAEA,MAAMC,oBAAoB1D,+BAA+BmD,QAAQQ,MAAM,EAAE3C;QACzE,MAAM4C,YAAY3D,mBAAmBgC,MAAMyB;QAC3C,MAAMG,kBAAkBxD,uBAAuB;YAC7CW;YACAiB,MAAM2B;YACNE,SAAS;YACTZ;QACF;QAEA,IAAIW,iBAAiB;YACnB,OAAOA;QACT;QAEA,MAAME,aAAa5D,4BAA4ByD;QAC/C,MAAMnB,OAAO,MAAMlC,YAAY;YAAES;YAAgBS,OAAO4B;YAAWH;QAAI;QAEvE,MAAMc,cAAqBjB,SAAS,CAAC;QAErC,IAAIpB,IAAI;YACN,MAAMsC,SAAS,MAAMd,QAAQlC,MAAM,CAAC;gBAClCU;gBACAuC,YAAYlD;gBACZiB,MAAM8B;gBACN3B;gBACAE;gBACA6B,gBAAgBlB,cAAckB,cAAc;gBAC5CxB;gBACAO;gBACA,GAAIT,OAAO;oBAAEA;gBAAK,IAAI,CAAC,CAAC;gBACxB,GAAIG,yBAAyB;oBAAEA;gBAAuB,IAAI,CAAC,CAAC;gBAC5D,GAAIC,sBAAsBuB,YAAY;oBAAEvB;gBAAkB,IAAI,CAAC,CAAC;gBAChE,GAAIH,SAAS;oBAAEA;gBAAO,IAAI,CAAC,CAAC;gBAC5B,GAAIF,iBAAiB;oBAAEA;gBAAe,IAAI,CAAC,CAAC;gBAC5C,GAAIM,SAAS;oBAAEA,QAAQA;gBAAqB,IAAI,CAAC,CAAC;YACpD;YAEA,OAAO;gBACLS,SAAS;oBACP;wBACEC,MAAM;wBACNC,MAAM,CAAC,6CAA6C,EAAEzC,eAAe,mCAAmC,EAAEqD,KAAKC,SAAS,CAACL,QAAQ,QAAQ,CAAC;oBAC5I;iBACD;gBACDM,KAAKN;YACP;QACF;QAEA,MAAMA,SAAS,MAAMd,QAAQlC,MAAM,CAAC;YAClCiD,YAAYlD;YACZiB,MAAM8B;YACN3B;YACAE;YACA6B,gBAAgBlB,cAAckB,cAAc;YAC5CxB;YACAO;YACAH,OAAOiB;YACP,GAAIvB,OAAO;gBAAEA;YAAK,IAAI,CAAC,CAAC;YACxB,GAAIG,yBAAyB;gBAAEA;YAAuB,IAAI,CAAC,CAAC;YAC5D,GAAIC,sBAAsBuB,YAAY;gBAAEvB;YAAkB,IAAI,CAAC,CAAC;YAChE,GAAIH,SAAS;gBAAEA;YAAO,IAAI,CAAC,CAAC;YAC5B,GAAIF,iBAAiB;gBAAEA;YAAe,IAAI,CAAC,CAAC;YAC5C,GAAIM,SAAS;gBAAEA,QAAQA;YAAqB,IAAI,CAAC,CAAC;QACpD;QAEA,MAAM0B,OAAOP,OAAOO,IAAI,IAAI,EAAE;QAC9B,MAAMC,SAASR,OAAOQ,MAAM,IAAI,EAAE;QAElC,IAAIC,eAAe,CAAC,0CAA0C,EAAE1D,eAAe,aAAa,EAAEwD,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,cAAc1E,yBAAyB;gBAAEc;gBAAgBkC;YAAI;YAEnE,IAAI0B,aAAa;gBACfF,gBAAgB,CAAC,2CAA2C,EAAEL,KAAKC,SAAS,CAACM,aAAa,QAAQ,CAAC;YACrG;YAEA,OAAO;gBACLrB,SAAS;oBAAC;wBAAEC,MAAM;wBAAQC,MAAMiB;oBAAa;iBAAE;gBAC/CH,KAAK;oBAAEC;oBAAMC;gBAAO;gBACpBI,SAAS;gBACT,GAAID,cACA;oBACEE,mBAAmB;wBACjB9D;wBACAwD;wBACAC;wBACAM,QAAQH;oBACV;gBACF,IACA,CAAC,CAAC;YACR;QACF;QAEA,OAAO;YACLrB,SAAS;gBAAC;oBAAEC,MAAM;oBAAQC,MAAMiB;gBAAa;aAAE;YAC/CH,KAAK;gBAAEC;gBAAMC;YAAO;QACtB;IACF,EAAE,OAAOO,OAAO;QACd,MAAMC,eAAeD,iBAAiBE,QAAQF,MAAMG,OAAO,GAAG;QAC9D/B,OAAO4B,KAAK,CAAC,CAAC,2BAA2B,EAAEhE,eAAe,EAAE,EAAEiE,cAAc;QAC5E,OAAOzE,sBAAsB;YAAE4E,QAAQ;YAAYpE;YAAgBgE;YAAO9B;QAAI;IAChF;AACF,GAAE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"uploadInstructionsTool.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/uploadInstructionsTool.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,yBAAyB,4CAyDpC,CAAA"}
|