@payloadcms/plugin-mcp 4.0.0-internal.d28e9fb → 4.0.0-internal.d3909a9
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/LICENSE.md +1 -1
- package/bin.js +39 -0
- package/dist/defaultAccess.d.ts +3 -0
- package/dist/defaultAccess.d.ts.map +1 -0
- package/dist/defaultAccess.js +3 -0
- package/dist/defaultAccess.js.map +1 -0
- package/dist/defineTool.d.ts +26 -0
- package/dist/defineTool.d.ts.map +1 -0
- package/dist/defineTool.js +37 -0
- package/dist/defineTool.js.map +1 -0
- package/dist/endpoint/access.d.ts +17 -0
- package/dist/endpoint/access.d.ts.map +1 -0
- package/dist/endpoint/access.js +93 -0
- package/dist/endpoint/access.js.map +1 -0
- package/dist/endpoint/index.d.ts +3 -0
- package/dist/endpoint/index.d.ts.map +1 -0
- package/dist/endpoint/index.js +116 -0
- package/dist/endpoint/index.js.map +1 -0
- package/dist/exports/client.d.ts +2 -0
- package/dist/exports/client.d.ts.map +1 -0
- package/dist/exports/client.js +4 -0
- package/dist/exports/client.js.map +1 -0
- package/dist/exports/internal.d.ts +2 -0
- package/dist/exports/internal.d.ts.map +1 -0
- package/dist/exports/internal.js +3 -0
- package/dist/exports/internal.js.map +1 -0
- package/dist/index.d.ts +6 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +39 -67
- package/dist/index.js.map +1 -1
- package/dist/mcp/buildMcpServer.d.ts +19 -0
- package/dist/mcp/buildMcpServer.d.ts.map +1 -0
- package/dist/mcp/buildMcpServer.js +235 -0
- package/dist/mcp/buildMcpServer.js.map +1 -0
- package/dist/mcp/builtin/collections/authTools.d.ts +7 -0
- package/dist/mcp/builtin/collections/authTools.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/authTools.js +312 -0
- package/dist/mcp/builtin/collections/authTools.js.map +1 -0
- package/dist/mcp/builtin/collections/countTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/countTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/countTool.js +63 -0
- package/dist/mcp/builtin/collections/countTool.js.map +1 -0
- package/dist/mcp/builtin/collections/countVersionsTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/countVersionsTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/countVersionsTool.js +60 -0
- package/dist/mcp/builtin/collections/countVersionsTool.js.map +1 -0
- package/dist/mcp/builtin/collections/createTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/createTool.js +137 -0
- package/dist/mcp/builtin/collections/createTool.js.map +1 -0
- package/dist/mcp/builtin/collections/deleteTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/deleteTool.js +111 -0
- package/dist/mcp/builtin/collections/deleteTool.js.map +1 -0
- package/dist/mcp/builtin/collections/duplicateTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/duplicateTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/duplicateTool.js +90 -0
- package/dist/mcp/builtin/collections/duplicateTool.js.map +1 -0
- package/dist/mcp/builtin/collections/fileInput.d.ts +28 -0
- package/dist/mcp/builtin/collections/fileInput.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/fileInput.js +88 -0
- package/dist/mcp/builtin/collections/fileInput.js.map +1 -0
- package/dist/mcp/builtin/collections/findDistinctTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/findDistinctTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/findDistinctTool.js +77 -0
- package/dist/mcp/builtin/collections/findDistinctTool.js.map +1 -0
- package/dist/mcp/builtin/collections/findTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/findTool.js +146 -0
- package/dist/mcp/builtin/collections/findTool.js.map +1 -0
- package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/findVersionByIDTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/findVersionByIDTool.js +74 -0
- package/dist/mcp/builtin/collections/findVersionByIDTool.js.map +1 -0
- package/dist/mcp/builtin/collections/findVersionsTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/findVersionsTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/findVersionsTool.js +84 -0
- package/dist/mcp/builtin/collections/findVersionsTool.js.map +1 -0
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.js +103 -0
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
- package/dist/mcp/builtin/collections/restoreVersionTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/restoreVersionTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/restoreVersionTool.js +69 -0
- package/dist/mcp/builtin/collections/restoreVersionTool.js.map +1 -0
- package/dist/mcp/builtin/collections/updateTool.d.ts +2 -0
- package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/updateTool.js +172 -0
- package/dist/mcp/builtin/collections/updateTool.js.map +1 -0
- 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/builtin/formatEntityError.d.ts +16 -0
- package/dist/mcp/builtin/formatEntityError.d.ts.map +1 -0
- package/dist/mcp/builtin/formatEntityError.js +55 -0
- package/dist/mcp/builtin/formatEntityError.js.map +1 -0
- package/dist/mcp/builtin/getConfigInfoTool.d.ts +2 -0
- package/dist/mcp/builtin/getConfigInfoTool.d.ts.map +1 -0
- package/dist/mcp/builtin/getConfigInfoTool.js +69 -0
- package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
- package/dist/mcp/builtin/globals/countVersionsTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/countVersionsTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/countVersionsTool.js +60 -0
- package/dist/mcp/builtin/globals/countVersionsTool.js.map +1 -0
- package/dist/mcp/builtin/globals/findTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/findTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/findTool.js +67 -0
- package/dist/mcp/builtin/globals/findTool.js.map +1 -0
- package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/findVersionByIDTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/findVersionByIDTool.js +68 -0
- package/dist/mcp/builtin/globals/findVersionByIDTool.js.map +1 -0
- package/dist/mcp/builtin/globals/findVersionsTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/findVersionsTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/findVersionsTool.js +78 -0
- package/dist/mcp/builtin/globals/findVersionsTool.js.map +1 -0
- package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/getGlobalSchemaTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/getGlobalSchemaTool.js +81 -0
- package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
- package/dist/mcp/builtin/globals/restoreVersionTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/restoreVersionTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/restoreVersionTool.js +70 -0
- package/dist/mcp/builtin/globals/restoreVersionTool.js.map +1 -0
- package/dist/mcp/builtin/globals/updateTool.d.ts +2 -0
- package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -0
- package/dist/mcp/builtin/globals/updateTool.js +78 -0
- package/dist/mcp/builtin/globals/updateTool.js.map +1 -0
- package/dist/mcp/builtinTools.d.ts +168 -0
- package/dist/mcp/builtinTools.d.ts.map +1 -0
- package/dist/mcp/builtinTools.js +169 -0
- package/dist/mcp/builtinTools.js.map +1 -0
- package/dist/mcp/sanitizeMCPConfig.d.ts +16 -0
- package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -0
- package/dist/mcp/sanitizeMCPConfig.js +233 -0
- package/dist/mcp/sanitizeMCPConfig.js.map +1 -0
- package/dist/stdio.d.ts +8 -0
- package/dist/stdio.d.ts.map +1 -0
- package/dist/stdio.js +128 -0
- package/dist/stdio.js.map +1 -0
- package/dist/types.d.ts +263 -447
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +4 -1
- package/dist/types.js.map +1 -1
- package/dist/utils/getLogger.d.ts +10 -0
- package/dist/utils/getLogger.d.ts.map +1 -0
- package/dist/utils/getLogger.js +22 -0
- package/dist/utils/getLogger.js.map +1 -0
- package/dist/utils/getPluginConfig.d.ts +12 -0
- package/dist/utils/getPluginConfig.d.ts.map +1 -0
- package/dist/utils/getPluginConfig.js +15 -0
- package/dist/utils/getPluginConfig.js.map +1 -0
- package/dist/utils/resolveProjectRoot.d.ts +7 -0
- package/dist/utils/resolveProjectRoot.d.ts.map +1 -0
- package/dist/utils/resolveProjectRoot.js +15 -0
- package/dist/utils/resolveProjectRoot.js.map +1 -0
- package/dist/utils/toStandardSchema.d.ts +5 -0
- package/dist/utils/toStandardSchema.d.ts.map +1 -0
- package/dist/utils/toStandardSchema.js +4 -0
- package/dist/utils/toStandardSchema.js.map +1 -0
- package/package.json +41 -26
- package/src/defaultAccess.ts +3 -0
- package/src/defineTool.ts +44 -0
- package/src/endpoint/access.ts +111 -0
- package/src/endpoint/index.ts +107 -0
- package/src/exports/client.ts +3 -0
- package/src/exports/internal.ts +1 -0
- package/src/index.ts +31 -89
- package/src/mcp/buildMcpServer.ts +294 -0
- package/src/mcp/builtin/collections/authTools.ts +280 -0
- package/src/mcp/builtin/collections/countTool.ts +61 -0
- package/src/mcp/builtin/collections/countVersionsTool.ts +60 -0
- package/src/mcp/builtin/collections/createTool.ts +143 -0
- package/src/mcp/builtin/collections/deleteTool.ts +97 -0
- package/src/mcp/builtin/collections/duplicateTool.ts +84 -0
- package/src/mcp/builtin/collections/fileInput.spec.ts +93 -0
- package/src/mcp/builtin/collections/fileInput.ts +127 -0
- package/src/mcp/builtin/collections/findDistinctTool.ts +67 -0
- package/src/mcp/builtin/collections/findTool.ts +134 -0
- package/src/mcp/builtin/collections/findVersionByIDTool.ts +66 -0
- package/src/mcp/builtin/collections/findVersionsTool.ts +83 -0
- package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +91 -0
- package/src/mcp/builtin/collections/restoreVersionTool.ts +65 -0
- package/src/mcp/builtin/collections/updateTool.ts +173 -0
- package/src/mcp/builtin/collections/uploadInstructionsTool.ts +64 -0
- package/src/mcp/builtin/formatEntityError.ts +77 -0
- package/src/mcp/builtin/getConfigInfoTool.ts +68 -0
- package/src/mcp/builtin/globals/countVersionsTool.ts +60 -0
- package/src/mcp/builtin/globals/findTool.ts +66 -0
- package/src/mcp/builtin/globals/findVersionByIDTool.ts +64 -0
- package/src/mcp/builtin/globals/findVersionsTool.ts +69 -0
- package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +73 -0
- package/src/mcp/builtin/globals/restoreVersionTool.ts +68 -0
- package/src/mcp/builtin/globals/updateTool.ts +92 -0
- package/src/mcp/builtinTools.ts +161 -0
- package/src/mcp/sanitizeMCPConfig.ts +281 -0
- package/src/stdio.ts +131 -0
- package/src/types.ts +312 -486
- package/src/utils/getLogger.ts +22 -0
- package/src/utils/getPluginConfig.ts +24 -0
- package/src/utils/resolveProjectRoot.ts +17 -0
- package/src/utils/toStandardSchema.ts +9 -0
- package/dist/collections/createApiKeysCollection.d.ts +0 -7
- package/dist/collections/createApiKeysCollection.d.ts.map +0 -1
- package/dist/collections/createApiKeysCollection.js +0 -317
- package/dist/collections/createApiKeysCollection.js.map +0 -1
- package/dist/defaults.d.ts +0 -4
- package/dist/defaults.d.ts.map +0 -1
- package/dist/defaults.js +0 -5
- package/dist/defaults.js.map +0 -1
- package/dist/endpoints/mcp.d.ts +0 -4
- package/dist/endpoints/mcp.d.ts.map +0 -1
- package/dist/endpoints/mcp.js +0 -71
- package/dist/endpoints/mcp.js.map +0 -1
- package/dist/mcp/createRequest.d.ts +0 -3
- package/dist/mcp/createRequest.d.ts.map +0 -1
- package/dist/mcp/createRequest.js +0 -14
- package/dist/mcp/createRequest.js.map +0 -1
- package/dist/mcp/getMcpHandler.d.ts +0 -4
- package/dist/mcp/getMcpHandler.d.ts.map +0 -1
- package/dist/mcp/getMcpHandler.js +0 -231
- package/dist/mcp/getMcpHandler.js.map +0 -1
- package/dist/mcp/helpers/config.d.ts +0 -22
- package/dist/mcp/helpers/config.d.ts.map +0 -1
- package/dist/mcp/helpers/config.js +0 -153
- package/dist/mcp/helpers/config.js.map +0 -1
- package/dist/mcp/helpers/fields.d.ts +0 -19
- package/dist/mcp/helpers/fields.d.ts.map +0 -1
- package/dist/mcp/helpers/fields.js +0 -102
- package/dist/mcp/helpers/fields.js.map +0 -1
- package/dist/mcp/helpers/fileValidation.d.ts +0 -67
- package/dist/mcp/helpers/fileValidation.d.ts.map +0 -1
- package/dist/mcp/helpers/fileValidation.js +0 -267
- package/dist/mcp/helpers/fileValidation.js.map +0 -1
- package/dist/mcp/registerTool.d.ts +0 -6
- package/dist/mcp/registerTool.d.ts.map +0 -1
- package/dist/mcp/registerTool.js +0 -18
- package/dist/mcp/registerTool.js.map +0 -1
- package/dist/mcp/tools/auth/auth.d.ts +0 -4
- package/dist/mcp/tools/auth/auth.d.ts.map +0 -1
- package/dist/mcp/tools/auth/auth.js +0 -57
- package/dist/mcp/tools/auth/auth.js.map +0 -1
- package/dist/mcp/tools/auth/forgotPassword.d.ts +0 -4
- package/dist/mcp/tools/auth/forgotPassword.d.ts.map +0 -1
- package/dist/mcp/tools/auth/forgotPassword.js +0 -48
- package/dist/mcp/tools/auth/forgotPassword.js.map +0 -1
- package/dist/mcp/tools/auth/login.d.ts +0 -4
- package/dist/mcp/tools/auth/login.d.ts.map +0 -1
- package/dist/mcp/tools/auth/login.js +0 -51
- package/dist/mcp/tools/auth/login.js.map +0 -1
- package/dist/mcp/tools/auth/resetPassword.d.ts +0 -4
- package/dist/mcp/tools/auth/resetPassword.d.ts.map +0 -1
- package/dist/mcp/tools/auth/resetPassword.js +0 -49
- package/dist/mcp/tools/auth/resetPassword.js.map +0 -1
- package/dist/mcp/tools/auth/unlock.d.ts +0 -4
- package/dist/mcp/tools/auth/unlock.d.ts.map +0 -1
- package/dist/mcp/tools/auth/unlock.js +0 -48
- package/dist/mcp/tools/auth/unlock.js.map +0 -1
- package/dist/mcp/tools/auth/verify.d.ts +0 -4
- package/dist/mcp/tools/auth/verify.d.ts.map +0 -1
- package/dist/mcp/tools/auth/verify.js +0 -45
- package/dist/mcp/tools/auth/verify.js.map +0 -1
- package/dist/mcp/tools/collection/create.d.ts +0 -10
- package/dist/mcp/tools/collection/create.d.ts.map +0 -1
- package/dist/mcp/tools/collection/create.js +0 -139
- package/dist/mcp/tools/collection/create.js.map +0 -1
- package/dist/mcp/tools/collection/delete.d.ts +0 -10
- package/dist/mcp/tools/collection/delete.d.ts.map +0 -1
- package/dist/mcp/tools/collection/delete.js +0 -154
- package/dist/mcp/tools/collection/delete.js.map +0 -1
- package/dist/mcp/tools/collection/find.d.ts +0 -10
- package/dist/mcp/tools/collection/find.d.ts.map +0 -1
- package/dist/mcp/tools/collection/find.js +0 -165
- package/dist/mcp/tools/collection/find.js.map +0 -1
- package/dist/mcp/tools/collection/update.d.ts +0 -10
- package/dist/mcp/tools/collection/update.d.ts.map +0 -1
- package/dist/mcp/tools/collection/update.js +0 -209
- package/dist/mcp/tools/collection/update.js.map +0 -1
- package/dist/mcp/tools/config/find.d.ts +0 -10
- package/dist/mcp/tools/config/find.d.ts.map +0 -1
- package/dist/mcp/tools/config/find.js +0 -97
- package/dist/mcp/tools/config/find.js.map +0 -1
- package/dist/mcp/tools/config/update.d.ts +0 -10
- package/dist/mcp/tools/config/update.d.ts.map +0 -1
- package/dist/mcp/tools/config/update.js +0 -215
- package/dist/mcp/tools/config/update.js.map +0 -1
- package/dist/mcp/tools/global/find.d.ts +0 -5
- package/dist/mcp/tools/global/find.d.ts.map +0 -1
- package/dist/mcp/tools/global/find.js +0 -82
- package/dist/mcp/tools/global/find.js.map +0 -1
- package/dist/mcp/tools/global/update.d.ts +0 -6
- package/dist/mcp/tools/global/update.d.ts.map +0 -1
- package/dist/mcp/tools/global/update.js +0 -124
- package/dist/mcp/tools/global/update.js.map +0 -1
- package/dist/mcp/tools/job/create.d.ts +0 -10
- package/dist/mcp/tools/job/create.d.ts.map +0 -1
- package/dist/mcp/tools/job/create.js +0 -293
- package/dist/mcp/tools/job/create.js.map +0 -1
- package/dist/mcp/tools/job/run.d.ts +0 -10
- package/dist/mcp/tools/job/run.d.ts.map +0 -1
- package/dist/mcp/tools/job/run.js +0 -129
- package/dist/mcp/tools/job/run.js.map +0 -1
- package/dist/mcp/tools/job/update.d.ts +0 -11
- package/dist/mcp/tools/job/update.d.ts.map +0 -1
- package/dist/mcp/tools/job/update.js +0 -186
- package/dist/mcp/tools/job/update.js.map +0 -1
- package/dist/mcp/tools/resource/create.d.ts +0 -6
- package/dist/mcp/tools/resource/create.d.ts.map +0 -1
- package/dist/mcp/tools/resource/create.js +0 -124
- package/dist/mcp/tools/resource/create.js.map +0 -1
- package/dist/mcp/tools/resource/delete.d.ts +0 -5
- package/dist/mcp/tools/resource/delete.d.ts.map +0 -1
- package/dist/mcp/tools/resource/delete.js +0 -151
- package/dist/mcp/tools/resource/delete.js.map +0 -1
- package/dist/mcp/tools/resource/find.d.ts +0 -5
- package/dist/mcp/tools/resource/find.d.ts.map +0 -1
- package/dist/mcp/tools/resource/find.js +0 -170
- package/dist/mcp/tools/resource/find.js.map +0 -1
- package/dist/mcp/tools/resource/update.d.ts +0 -6
- package/dist/mcp/tools/resource/update.d.ts.map +0 -1
- package/dist/mcp/tools/resource/update.js +0 -256
- package/dist/mcp/tools/resource/update.js.map +0 -1
- package/dist/mcp/tools/schemas.d.ts +0 -457
- package/dist/mcp/tools/schemas.d.ts.map +0 -1
- package/dist/mcp/tools/schemas.js +0 -243
- package/dist/mcp/tools/schemas.js.map +0 -1
- package/dist/utils/adminEntitySettings.d.ts +0 -17
- package/dist/utils/adminEntitySettings.d.ts.map +0 -1
- package/dist/utils/adminEntitySettings.js +0 -41
- package/dist/utils/adminEntitySettings.js.map +0 -1
- package/dist/utils/createApiKeyFields.d.ts +0 -15
- package/dist/utils/createApiKeyFields.d.ts.map +0 -1
- package/dist/utils/createApiKeyFields.js +0 -57
- package/dist/utils/createApiKeyFields.js.map +0 -1
- package/dist/utils/getEnabledSlugs.d.ts +0 -13
- package/dist/utils/getEnabledSlugs.d.ts.map +0 -1
- package/dist/utils/getEnabledSlugs.js +0 -32
- package/dist/utils/getEnabledSlugs.js.map +0 -1
- package/dist/utils/getVirtualFieldNames.d.ts +0 -14
- package/dist/utils/getVirtualFieldNames.d.ts.map +0 -1
- package/dist/utils/getVirtualFieldNames.js +0 -35
- package/dist/utils/getVirtualFieldNames.js.map +0 -1
- package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts +0 -3
- package/dist/utils/schemaConversion/convertCollectionSchemaToZod.d.ts.map +0 -1
- package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js +0 -43
- package/dist/utils/schemaConversion/convertCollectionSchemaToZod.js.map +0 -1
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +0 -7
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +0 -1
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js +0 -20
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +0 -1
- package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +0 -13
- package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +0 -1
- package/dist/utils/schemaConversion/sanitizeJsonSchema.js +0 -56
- package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +0 -1
- package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +0 -20
- package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +0 -1
- package/dist/utils/schemaConversion/simplifyRelationshipFields.js +0 -53
- package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +0 -1
- package/dist/utils/schemaConversion/transformPointFields.d.ts +0 -3
- package/dist/utils/schemaConversion/transformPointFields.d.ts.map +0 -1
- package/dist/utils/schemaConversion/transformPointFields.js +0 -51
- package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
- package/dist/utils/transformPointDataToPayload.d.ts +0 -7
- package/dist/utils/transformPointDataToPayload.d.ts.map +0 -1
- package/dist/utils/transformPointDataToPayload.js +0 -28
- package/dist/utils/transformPointDataToPayload.js.map +0 -1
- package/src/collections/createApiKeysCollection.ts +0 -373
- package/src/defaults.ts +0 -3
- package/src/endpoints/mcp.ts +0 -91
- package/src/mcp/createRequest.ts +0 -13
- package/src/mcp/getMcpHandler.ts +0 -545
- package/src/mcp/helpers/config.ts +0 -213
- package/src/mcp/helpers/fields.ts +0 -154
- package/src/mcp/helpers/fileValidation.ts +0 -362
- package/src/mcp/registerTool.ts +0 -22
- package/src/mcp/tools/auth/auth.ts +0 -71
- package/src/mcp/tools/auth/forgotPassword.ts +0 -70
- package/src/mcp/tools/auth/login.ts +0 -72
- package/src/mcp/tools/auth/resetPassword.ts +0 -61
- package/src/mcp/tools/auth/unlock.ts +0 -64
- package/src/mcp/tools/auth/verify.ts +0 -57
- package/src/mcp/tools/collection/create.ts +0 -210
- package/src/mcp/tools/collection/delete.ts +0 -211
- package/src/mcp/tools/collection/find.ts +0 -224
- package/src/mcp/tools/collection/update.ts +0 -290
- package/src/mcp/tools/config/find.ts +0 -128
- package/src/mcp/tools/config/update.ts +0 -280
- package/src/mcp/tools/global/find.ts +0 -128
- package/src/mcp/tools/global/update.ts +0 -207
- package/src/mcp/tools/job/create.ts +0 -416
- package/src/mcp/tools/job/run.ts +0 -167
- package/src/mcp/tools/job/update.ts +0 -274
- package/src/mcp/tools/resource/create.ts +0 -211
- package/src/mcp/tools/resource/delete.ts +0 -218
- package/src/mcp/tools/resource/find.ts +0 -246
- package/src/mcp/tools/resource/update.ts +0 -383
- package/src/mcp/tools/schemas.ts +0 -520
- package/src/utils/adminEntitySettings.ts +0 -40
- package/src/utils/createApiKeyFields.ts +0 -72
- package/src/utils/getEnabledSlugs.ts +0 -42
- package/src/utils/getVirtualFieldNames.ts +0 -53
- package/src/utils/schemaConversion/convertCollectionSchemaToZod.ts +0 -52
- package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +0 -27
- package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
- package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -65
- package/src/utils/schemaConversion/transformPointFields.ts +0 -55
- package/src/utils/transformPointDataToPayload.ts +0 -40
package/src/types.ts
CHANGED
|
@@ -1,542 +1,368 @@
|
|
|
1
1
|
import type {
|
|
2
|
-
|
|
2
|
+
CallToolResult,
|
|
3
|
+
ContentBlock,
|
|
4
|
+
Implementation,
|
|
5
|
+
JsonSchemaType,
|
|
6
|
+
McpServerOptions,
|
|
7
|
+
ResourceTemplate,
|
|
8
|
+
ServerContext,
|
|
9
|
+
StandardSchemaWithJSON,
|
|
10
|
+
ToolAnnotations,
|
|
11
|
+
} from '@modelcontextprotocol/server'
|
|
12
|
+
import type {
|
|
13
|
+
AuthCollectionSlug,
|
|
3
14
|
CollectionSlug,
|
|
4
15
|
GlobalSlug,
|
|
16
|
+
MaybePromise,
|
|
5
17
|
PayloadRequest,
|
|
6
|
-
|
|
18
|
+
SanitizedPermissions,
|
|
7
19
|
} from 'payload'
|
|
8
|
-
import type { z } from 'zod'
|
|
9
20
|
|
|
10
|
-
import {
|
|
21
|
+
import type { GetAuthorizedMCPArgs } from './endpoint/access.js'
|
|
22
|
+
import type {
|
|
23
|
+
MCPCollectionAuthToolName,
|
|
24
|
+
MCPCollectionBuiltinName,
|
|
25
|
+
MCPGlobalBuiltinName,
|
|
26
|
+
} from './mcp/builtinTools.js'
|
|
11
27
|
|
|
12
|
-
export type
|
|
13
|
-
/**
|
|
14
|
-
* Set the collections that should be available as resources via MCP.
|
|
15
|
-
*/
|
|
16
|
-
collections?: Partial<
|
|
17
|
-
Record<
|
|
18
|
-
CollectionSlug,
|
|
19
|
-
{
|
|
20
|
-
/**
|
|
21
|
-
* Set the description of the collection. This is used by MCP clients to determine when to use the collecton as a resource.
|
|
22
|
-
*/
|
|
23
|
-
description?: string
|
|
24
|
-
/**
|
|
25
|
-
* Set the enabled capabilities of the collection. Admins can then allow or disallow the use of the capability by MCP clients.
|
|
26
|
-
*/
|
|
27
|
-
enabled:
|
|
28
|
-
| {
|
|
29
|
-
create?: boolean
|
|
30
|
-
delete?: boolean
|
|
31
|
-
find?: boolean
|
|
32
|
-
update?: boolean
|
|
33
|
-
}
|
|
34
|
-
| boolean
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Override the response generated by the MCP client. This allows you to modify the response that is sent to the MCP client. This is useful for adding additional data to the response, data normalization, or verifying data.
|
|
38
|
-
*/
|
|
39
|
-
overrideResponse?: (
|
|
40
|
-
response: {
|
|
41
|
-
content: Array<{
|
|
42
|
-
text: string
|
|
43
|
-
type: string
|
|
44
|
-
}>
|
|
45
|
-
},
|
|
46
|
-
doc: Record<string, unknown>,
|
|
47
|
-
req: PayloadRequest,
|
|
48
|
-
) => {
|
|
49
|
-
content: Array<{
|
|
50
|
-
text: string
|
|
51
|
-
type: string
|
|
52
|
-
}>
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
>
|
|
56
|
-
>
|
|
57
|
-
/**
|
|
58
|
-
* Disable the MCP plugin.
|
|
59
|
-
*/
|
|
60
|
-
disabled?: boolean
|
|
61
|
-
/**
|
|
62
|
-
* Experimental features
|
|
63
|
-
* **These features are for experimental purposes -- They are Disabled in Production by Default**
|
|
64
|
-
*/
|
|
65
|
-
experimental?: {
|
|
66
|
-
/**
|
|
67
|
-
* These are MCP tools that can be used by a client to modify Payload.
|
|
68
|
-
*/
|
|
69
|
-
tools: {
|
|
70
|
-
/**
|
|
71
|
-
* **Experimental** -- Auth MCP tools allow a client to change authentication priviliages for users. This is for developing ideas that help Admins with authentication tasks.
|
|
72
|
-
*/
|
|
73
|
-
auth?: {
|
|
74
|
-
/**
|
|
75
|
-
* Enable the auth MCP tools. This allows Admins to enable or disable the auth capabilities.
|
|
76
|
-
* @default false
|
|
77
|
-
*/
|
|
78
|
-
enabled: boolean
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* **Experimental** -- Collection MCP tools allow for the creation, modification, and deletion of Payload collections. This is for developing ideas that help Developers with collection tasks.
|
|
82
|
-
*/
|
|
83
|
-
collections?: {
|
|
84
|
-
/**
|
|
85
|
-
* Set the directory path to the collections directory. This can be a directory outside of your default directory, or another Payload project.
|
|
86
|
-
*/
|
|
87
|
-
collectionsDirPath: string
|
|
88
|
-
/**
|
|
89
|
-
* Enable the collection MCP tools. This allows Admins to enable or disable the Collection modification capabilities.
|
|
90
|
-
* @default false
|
|
91
|
-
*/
|
|
92
|
-
enabled: boolean
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* **Experimental** -- Config MCP tools allow for the modification of a Payload Config. This is for developing ideas that help Developers with config tasks.
|
|
96
|
-
*/
|
|
97
|
-
config?: {
|
|
98
|
-
/**
|
|
99
|
-
* Set the directory path to the config directory. This can be a directory outside of your default directory, or another Payload project.
|
|
100
|
-
*/
|
|
101
|
-
configFilePath: string
|
|
102
|
-
/**
|
|
103
|
-
* Enable the config MCP tools. This allows Admins to enable or disable the Payload Config modification capabilities.
|
|
104
|
-
* @default false
|
|
105
|
-
*/
|
|
106
|
-
enabled: boolean
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* **Experimental** -- Jobs MCP tools allow for the modification of Payload jobs. This is for developing ideas that help Developers with job tasks.
|
|
110
|
-
*/
|
|
111
|
-
jobs?: {
|
|
112
|
-
/**
|
|
113
|
-
* Enable the jobs MCP tools. This allows Admins to enable or disable the Job modification capabilities.
|
|
114
|
-
* @default false
|
|
115
|
-
*/
|
|
116
|
-
enabled: boolean
|
|
117
|
-
/**
|
|
118
|
-
* Set the directory path to the jobs directory. This can be a directory outside of your default directory, or another Payload project.
|
|
119
|
-
*/
|
|
120
|
-
jobsDirPath: string
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
/**
|
|
125
|
-
* Set the globals that should be available as resources via MCP.
|
|
126
|
-
* Globals are singleton configuration objects (e.g., site settings, navigation).
|
|
127
|
-
* Note: Globals only support find and update operations.
|
|
128
|
-
*/
|
|
129
|
-
globals?: Partial<
|
|
130
|
-
Record<
|
|
131
|
-
GlobalSlug,
|
|
132
|
-
{
|
|
133
|
-
/**
|
|
134
|
-
* Set the description of the global. This is used by MCP clients to determine when to use the global as a resource.
|
|
135
|
-
*/
|
|
136
|
-
description?: string
|
|
137
|
-
/**
|
|
138
|
-
* Set the enabled capabilities of the global. Admins can then allow or disallow the use of the capability by MCP clients.
|
|
139
|
-
* Note: Globals only support find and update operations as they are singletons.
|
|
140
|
-
*/
|
|
141
|
-
enabled:
|
|
142
|
-
| {
|
|
143
|
-
find?: boolean
|
|
144
|
-
update?: boolean
|
|
145
|
-
}
|
|
146
|
-
| boolean
|
|
147
|
-
|
|
148
|
-
/**
|
|
149
|
-
* Override the response generated by the MCP client. This allows you to modify the response that is sent to the MCP client. This is useful for adding additional data to the response, data normalization, or verifying data.
|
|
150
|
-
*/
|
|
151
|
-
overrideResponse?: (
|
|
152
|
-
response: {
|
|
153
|
-
content: Array<{
|
|
154
|
-
text: string
|
|
155
|
-
type: string
|
|
156
|
-
}>
|
|
157
|
-
},
|
|
158
|
-
doc: Record<string, unknown>,
|
|
159
|
-
req: PayloadRequest,
|
|
160
|
-
) => {
|
|
161
|
-
content: Array<{
|
|
162
|
-
text: string
|
|
163
|
-
type: string
|
|
164
|
-
}>
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
>
|
|
168
|
-
>
|
|
169
|
-
/**
|
|
170
|
-
* MCP Server options.
|
|
171
|
-
*/
|
|
172
|
-
mcp?: {
|
|
173
|
-
handlerOptions?: MCPHandlerOptions
|
|
174
|
-
/**
|
|
175
|
-
* Add custom MCP Prompts.
|
|
176
|
-
*/
|
|
177
|
-
prompts?: {
|
|
178
|
-
/**
|
|
179
|
-
* Set the args schema of the prompt. This is the args schema that will be passed to the prompt. This is used by MCP clients to determine the arguments that will be passed to the prompt.
|
|
180
|
-
*/
|
|
181
|
-
argsSchema: z.ZodRawShape
|
|
182
|
-
/**
|
|
183
|
-
* Set the description of the prompt. This is used by MCP clients to determine when to use the prompt.
|
|
184
|
-
*/
|
|
185
|
-
description: string
|
|
186
|
-
/**
|
|
187
|
-
* Set the handler of the prompt. This is the function that will be called when the prompt is used.
|
|
188
|
-
*/
|
|
189
|
-
handler: (
|
|
190
|
-
args: Record<string, unknown>,
|
|
191
|
-
req: PayloadRequest,
|
|
192
|
-
_extra: unknown,
|
|
193
|
-
) =>
|
|
194
|
-
| {
|
|
195
|
-
messages: Array<{
|
|
196
|
-
content: {
|
|
197
|
-
text: string
|
|
198
|
-
type: 'text'
|
|
199
|
-
}
|
|
200
|
-
role: 'assistant' | 'user'
|
|
201
|
-
}>
|
|
202
|
-
}
|
|
203
|
-
| Promise<{
|
|
204
|
-
messages: Array<{
|
|
205
|
-
content: {
|
|
206
|
-
text: string
|
|
207
|
-
type: 'text'
|
|
208
|
-
}
|
|
209
|
-
role: 'assistant' | 'user'
|
|
210
|
-
}>
|
|
211
|
-
}>
|
|
212
|
-
/**
|
|
213
|
-
* Set the function name of the prompt.
|
|
214
|
-
*/
|
|
215
|
-
name: string
|
|
216
|
-
/**
|
|
217
|
-
* Set the title of the prompt. LLMs will interperate the title to determine when to use the prompt.
|
|
218
|
-
*/
|
|
219
|
-
title: string
|
|
220
|
-
}[]
|
|
28
|
+
export type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName }
|
|
221
29
|
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
*/
|
|
225
|
-
resources?: {
|
|
226
|
-
/**
|
|
227
|
-
* Set the description of the resource. This is used by MCP clients to determine when to use the resource.
|
|
228
|
-
* example: 'Data is a resource that contains special data.'
|
|
229
|
-
*/
|
|
230
|
-
description: string
|
|
231
|
-
/**
|
|
232
|
-
* Set the handler of the resource. This is the function that will be called when the resource is used.
|
|
233
|
-
* The handler can have either 3 arguments (when no args are passed) or 4 arguments (when args are passed).
|
|
234
|
-
*/
|
|
235
|
-
handler: (...args: any[]) =>
|
|
236
|
-
| {
|
|
237
|
-
contents: Array<{
|
|
238
|
-
text: string
|
|
239
|
-
uri: string
|
|
240
|
-
}>
|
|
241
|
-
}
|
|
242
|
-
| Promise<{
|
|
243
|
-
contents: Array<{
|
|
244
|
-
text: string
|
|
245
|
-
uri: string
|
|
246
|
-
}>
|
|
247
|
-
}>
|
|
248
|
-
/**
|
|
249
|
-
* Set the mime type of the resource.
|
|
250
|
-
* example: 'text/plain'
|
|
251
|
-
*/
|
|
252
|
-
mimeType: string
|
|
253
|
-
/**
|
|
254
|
-
* Set the function name of the resource.
|
|
255
|
-
* example: 'data'
|
|
256
|
-
*/
|
|
257
|
-
name: string
|
|
258
|
-
/**
|
|
259
|
-
* Set the title of the resource. LLMs will interperate the title to determine when to use the resource.
|
|
260
|
-
* example: 'Data'
|
|
261
|
-
*/
|
|
262
|
-
title: string
|
|
263
|
-
/**
|
|
264
|
-
* Set the uri of the resource.
|
|
265
|
-
* example: 'data://app'
|
|
266
|
-
*/
|
|
267
|
-
uri: ResourceTemplate | string
|
|
268
|
-
}[]
|
|
269
|
-
serverOptions?: MCPServerOptions
|
|
270
|
-
/**
|
|
271
|
-
* Add custom MCP Tools.
|
|
272
|
-
*/
|
|
273
|
-
tools?: {
|
|
274
|
-
/**
|
|
275
|
-
* Set the description of the tool. This is used by MCP clients to determine when to use the tool.
|
|
276
|
-
*/
|
|
277
|
-
description: string
|
|
278
|
-
/**
|
|
279
|
-
* Set the handler of the tool. This is the function that will be called when the tool is used.
|
|
280
|
-
*/
|
|
281
|
-
handler: (
|
|
282
|
-
args: Record<string, unknown>,
|
|
283
|
-
req: PayloadRequest,
|
|
284
|
-
_extra: unknown,
|
|
285
|
-
) =>
|
|
286
|
-
| {
|
|
287
|
-
content: Array<{
|
|
288
|
-
text: string
|
|
289
|
-
type: 'text'
|
|
290
|
-
}>
|
|
291
|
-
role?: string
|
|
292
|
-
}
|
|
293
|
-
| Promise<{
|
|
294
|
-
content: Array<{
|
|
295
|
-
text: string
|
|
296
|
-
type: 'text'
|
|
297
|
-
}>
|
|
298
|
-
role?: string
|
|
299
|
-
}>
|
|
300
|
-
/**
|
|
301
|
-
* Set the name of the tool. This is the name that will be used to identify the tool. LLMs will interperate the name to determine when to use the tool.
|
|
302
|
-
*/
|
|
303
|
-
name: string
|
|
304
|
-
/**
|
|
305
|
-
* Set the parameters of the tool. This is the parameters that will be passed to the tool.
|
|
306
|
-
*/
|
|
307
|
-
parameters: z.ZodRawShape
|
|
308
|
-
}[]
|
|
309
|
-
}
|
|
30
|
+
/** Re-exported from `@modelcontextprotocol/server` — common MCP types used in plugin config. */
|
|
31
|
+
export type { JsonSchemaType, StandardSchemaWithJSON, ToolAnnotations }
|
|
310
32
|
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
overrideApiKeyCollection?: (collection: CollectionConfig) => CollectionConfig
|
|
33
|
+
/**
|
|
34
|
+
* What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw
|
|
35
|
+
* JSON Schema 2020-12 literal, or a Standard Schema instance (Zod, Valibot, …).
|
|
36
|
+
* Raw schemas may omit `$schema`; when present it must declare the 2020-12 dialect.
|
|
37
|
+
*/
|
|
38
|
+
export type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON
|
|
318
39
|
|
|
40
|
+
export type MCPToolResponse = {
|
|
41
|
+
content: ContentBlock[]
|
|
319
42
|
/**
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
* @returns The MCP access settings.
|
|
43
|
+
* If available, return the document fetched within the
|
|
44
|
+
* mcp tool. This is threaded as an additional argument to
|
|
45
|
+
* overrideResponse functions and stripped before going on the wire.
|
|
324
46
|
*/
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
getDefaultMcpAccessSettings: (overrideApiKey?: null | string) => Promise<MCPAccessSettings>,
|
|
328
|
-
) => MCPAccessSettings | Promise<MCPAccessSettings>
|
|
47
|
+
doc?: Record<string, unknown>
|
|
48
|
+
} & Pick<CallToolResult, '_meta' | 'isError' | 'structuredContent'>
|
|
329
49
|
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
50
|
+
export type MCPResponseOverride = (
|
|
51
|
+
response: MCPToolResponse,
|
|
52
|
+
doc: Record<string, unknown>,
|
|
53
|
+
req: PayloadRequest,
|
|
54
|
+
) => MCPToolResponse
|
|
55
|
+
|
|
56
|
+
export type MCPAfterToolCallHook = (args: {
|
|
57
|
+
input: unknown
|
|
58
|
+
req: PayloadRequest
|
|
59
|
+
response: MCPToolResponse
|
|
60
|
+
toolName: string
|
|
61
|
+
}) => MaybePromise<MCPToolResponse>
|
|
335
62
|
|
|
336
63
|
/**
|
|
337
|
-
*
|
|
64
|
+
* The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets
|
|
65
|
+
* its inferred output; anything else falls back to `Record<string, unknown>`.
|
|
338
66
|
*/
|
|
339
|
-
export type
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
67
|
+
export type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON
|
|
68
|
+
? StandardSchemaWithJSON extends TSchema
|
|
69
|
+
? Record<string, unknown>
|
|
70
|
+
: StandardSchemaWithJSON.InferOutput<TSchema>
|
|
71
|
+
: Record<string, unknown>
|
|
72
|
+
|
|
73
|
+
export type MCPAccessArgs = {
|
|
74
|
+
permissions?: SanitizedPermissions
|
|
75
|
+
req: PayloadRequest
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export type CollectionMCPAccessArgs = {
|
|
79
|
+
slug: CollectionSlug
|
|
80
|
+
} & MCPAccessArgs
|
|
81
|
+
|
|
82
|
+
export type GlobalMCPAccessArgs = {
|
|
83
|
+
slug: GlobalSlug
|
|
84
|
+
} & MCPAccessArgs
|
|
85
|
+
|
|
86
|
+
export type ToolHandlerArgs<TSchema = undefined> = {
|
|
87
|
+
authorizedMCP: AuthorizedMCP
|
|
88
|
+
input: TypedInput<TSchema>
|
|
89
|
+
req: PayloadRequest
|
|
90
|
+
serverContext: ServerContext
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export type CollectionToolHandlerArgs<TSchema = undefined> = {
|
|
94
|
+
slug: CollectionSlug
|
|
95
|
+
} & ToolHandlerArgs<TSchema>
|
|
96
|
+
|
|
97
|
+
export type GlobalToolHandlerArgs<TSchema = undefined> = {
|
|
98
|
+
slug: GlobalSlug
|
|
99
|
+
} & ToolHandlerArgs<TSchema>
|
|
100
|
+
|
|
101
|
+
export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
|
|
345
102
|
/**
|
|
346
|
-
*
|
|
347
|
-
*
|
|
103
|
+
* Runs while authorizing each MCP request, before the tool is advertised or called. Return
|
|
104
|
+
* `false` to make the tool unavailable for that request. This is skipped when `overrideAccess`
|
|
105
|
+
* is enabled.
|
|
348
106
|
*/
|
|
349
|
-
|
|
107
|
+
access?: (args: MCPAccessArgs) => MaybePromise<boolean>
|
|
108
|
+
annotations?: ToolAnnotations
|
|
109
|
+
description: string
|
|
110
|
+
handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
111
|
+
input?: TSchema
|
|
350
112
|
/**
|
|
351
|
-
*
|
|
352
|
-
* @default 60
|
|
113
|
+
* Override the return value of the tool handler
|
|
353
114
|
*/
|
|
354
|
-
|
|
115
|
+
overrideResponse?: MCPResponseOverride
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
export type CollectionTool<
|
|
119
|
+
TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
|
|
120
|
+
> = {
|
|
355
121
|
/**
|
|
356
|
-
*
|
|
357
|
-
*
|
|
122
|
+
* Runs while authorizing each MCP request for this collection. Return `false` to reject calls
|
|
123
|
+
* to this tool for the collection. The shared tool is not advertised when no collections allow
|
|
124
|
+
* it, but can remain advertised when it is available for another collection. This is skipped
|
|
125
|
+
* when `overrideAccess` is enabled.
|
|
358
126
|
*/
|
|
359
|
-
|
|
127
|
+
access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
|
|
128
|
+
handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
129
|
+
input?: TSchema
|
|
130
|
+
} & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>
|
|
131
|
+
|
|
132
|
+
export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =
|
|
133
|
+
{
|
|
134
|
+
/**
|
|
135
|
+
* Runs while authorizing each MCP request for this global. Return `false` to reject calls to
|
|
136
|
+
* this tool for the global. The shared tool is not advertised when no globals allow it, but
|
|
137
|
+
* can remain advertised when it is available for another global. This is skipped when
|
|
138
|
+
* `overrideAccess` is enabled.
|
|
139
|
+
*/
|
|
140
|
+
access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
|
|
141
|
+
handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
142
|
+
input?: TSchema
|
|
143
|
+
} & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Configures (or disables) a built-in tool without replacing it.
|
|
147
|
+
* `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a
|
|
148
|
+
* required handler) from being silently accepted at a built-in key slot.
|
|
149
|
+
*/
|
|
150
|
+
export type MCPBuiltInCollectionToolOverride = {
|
|
360
151
|
/**
|
|
361
|
-
*
|
|
362
|
-
*
|
|
152
|
+
* Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
|
|
153
|
+
* this collection. This is skipped when `overrideAccess` is enabled.
|
|
363
154
|
*/
|
|
364
|
-
|
|
155
|
+
access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>
|
|
156
|
+
annotations?: ToolAnnotations
|
|
157
|
+
description?: string
|
|
158
|
+
handler?: never
|
|
159
|
+
overrideResponse?: MCPResponseOverride
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export type MCPBuiltInGlobalToolOverride = {
|
|
365
163
|
/**
|
|
366
|
-
*
|
|
367
|
-
*
|
|
164
|
+
* Replaces the built-in tool's access check. Return `false` to make the tool unavailable for
|
|
165
|
+
* this global. This is skipped when `overrideAccess` is enabled.
|
|
368
166
|
*/
|
|
369
|
-
|
|
167
|
+
access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>
|
|
168
|
+
annotations?: ToolAnnotations
|
|
169
|
+
description?: string
|
|
170
|
+
handler?: never
|
|
171
|
+
overrideResponse?: MCPResponseOverride
|
|
370
172
|
}
|
|
371
173
|
|
|
372
174
|
/**
|
|
373
|
-
*
|
|
175
|
+
* Value at a custom (non-built-in) tool key. Either the tool itself, or `false`
|
|
176
|
+
* to disable it (useful when one plugin defines a custom tool and another
|
|
177
|
+
* wants to opt out per-collection).
|
|
374
178
|
*/
|
|
375
|
-
export type
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
* Set the server info of the MCP server.
|
|
382
|
-
*/
|
|
383
|
-
serverInfo?: {
|
|
384
|
-
/**
|
|
385
|
-
* Set the name of the MCP server.
|
|
386
|
-
* @default 'Payload MCP Server'
|
|
387
|
-
*/
|
|
388
|
-
name: string
|
|
389
|
-
/**
|
|
390
|
-
* Set the version of the MCP server.
|
|
391
|
-
* @default '1.0.0'
|
|
392
|
-
*/
|
|
393
|
-
version: string
|
|
394
|
-
}
|
|
179
|
+
export type MCPTopLevelToolEntry = Tool
|
|
180
|
+
|
|
181
|
+
export type MCPCollectionToolsMap = {
|
|
182
|
+
[customToolName: string]: boolean | CollectionTool | MCPBuiltInCollectionToolOverride | undefined
|
|
183
|
+
} & {
|
|
184
|
+
[K in MCPCollectionBuiltinName]?: false | MCPBuiltInCollectionToolOverride
|
|
395
185
|
}
|
|
396
186
|
|
|
397
|
-
export type
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
forgotPassword?: boolean
|
|
401
|
-
login?: boolean
|
|
402
|
-
resetPassword?: boolean
|
|
403
|
-
unlock?: boolean
|
|
404
|
-
verify?: boolean
|
|
405
|
-
}
|
|
406
|
-
collections?: {
|
|
407
|
-
create?: boolean
|
|
408
|
-
delete?: boolean
|
|
409
|
-
find?: boolean
|
|
410
|
-
update?: boolean
|
|
411
|
-
}
|
|
412
|
-
config?: {
|
|
413
|
-
find?: boolean
|
|
414
|
-
update?: boolean
|
|
415
|
-
}
|
|
416
|
-
custom?: Record<string, boolean>
|
|
417
|
-
globals?: {
|
|
418
|
-
find?: boolean
|
|
419
|
-
update?: boolean
|
|
420
|
-
}
|
|
421
|
-
jobs?: {
|
|
422
|
-
create?: boolean
|
|
423
|
-
run?: boolean
|
|
424
|
-
update?: boolean
|
|
425
|
-
}
|
|
426
|
-
'payload-mcp-prompt'?: Record<string, boolean>
|
|
427
|
-
'payload-mcp-resource'?: Record<string, boolean>
|
|
428
|
-
'payload-mcp-tool'?: Record<string, boolean>
|
|
429
|
-
user: TypedUser
|
|
430
|
-
} & Record<string, unknown>
|
|
187
|
+
export type MCPAuthCollectionToolsMap = {
|
|
188
|
+
[K in MCPCollectionAuthToolName]?: MCPBuiltInCollectionToolOverride | true
|
|
189
|
+
} & MCPCollectionToolsMap
|
|
431
190
|
|
|
432
|
-
|
|
191
|
+
/** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */
|
|
192
|
+
export type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends AuthCollectionSlug
|
|
193
|
+
? MCPAuthCollectionToolsMap
|
|
194
|
+
: MCPCollectionToolsMap
|
|
433
195
|
|
|
434
|
-
export type
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
position?: 'main' | 'sidebar'
|
|
439
|
-
required?: boolean
|
|
440
|
-
type: string
|
|
196
|
+
export type MCPGlobalToolsMap = {
|
|
197
|
+
[customToolName: string]: boolean | GlobalTool | MCPBuiltInGlobalToolOverride | undefined
|
|
198
|
+
} & {
|
|
199
|
+
[K in MCPGlobalBuiltinName]?: false | MCPBuiltInGlobalToolOverride
|
|
441
200
|
}
|
|
442
201
|
|
|
443
|
-
export type
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
type?: string
|
|
450
|
-
}
|
|
451
|
-
fieldName: string
|
|
202
|
+
export type MCPTopLevelToolsMap = Record<string, Tool>
|
|
203
|
+
|
|
204
|
+
export type PromptHandlerArgs<TSchema = undefined> = {
|
|
205
|
+
input: TypedInput<TSchema>
|
|
206
|
+
req: PayloadRequest
|
|
207
|
+
serverContext: ServerContext
|
|
452
208
|
}
|
|
453
209
|
|
|
454
|
-
export type
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
210
|
+
export type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {
|
|
211
|
+
/**
|
|
212
|
+
* Runs while authorizing each MCP request, before the prompt is advertised or used. Return
|
|
213
|
+
* `false` to make the prompt unavailable for that request. This is skipped when
|
|
214
|
+
* `overrideAccess` is enabled.
|
|
215
|
+
*/
|
|
216
|
+
access?: (args: MCPAccessArgs) => MaybePromise<boolean>
|
|
217
|
+
argsSchema: TSchema
|
|
218
|
+
description: string
|
|
219
|
+
handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{
|
|
220
|
+
messages: Array<{ content: { text: string; type: 'text' }; role: 'assistant' | 'user' }>
|
|
221
|
+
}>
|
|
222
|
+
title: string
|
|
465
223
|
}
|
|
466
224
|
|
|
467
|
-
export type
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
breakpoints?: Array<{
|
|
474
|
-
height: number
|
|
475
|
-
label: string
|
|
476
|
-
name: string
|
|
477
|
-
width: number
|
|
478
|
-
}>
|
|
479
|
-
}
|
|
480
|
-
logoutRoute?: string
|
|
481
|
-
meta?: {
|
|
482
|
-
favicon?: string
|
|
483
|
-
ogImage?: string
|
|
484
|
-
titleSuffix?: string
|
|
485
|
-
}
|
|
486
|
-
user?: string
|
|
225
|
+
export type ResourceHandlerArgs = {
|
|
226
|
+
/** Variables extracted from a `ResourceTemplate` URI. Empty for static-URI resources. */
|
|
227
|
+
params: Record<string, string>
|
|
228
|
+
req: PayloadRequest
|
|
229
|
+
serverContext: ServerContext
|
|
230
|
+
uri: URL
|
|
487
231
|
}
|
|
488
232
|
|
|
489
|
-
export type
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
233
|
+
export type Resource = {
|
|
234
|
+
/**
|
|
235
|
+
* Runs while authorizing each MCP request, before the resource is advertised or read. Return
|
|
236
|
+
* `false` to make the resource unavailable for that request. This is skipped when
|
|
237
|
+
* `overrideAccess` is enabled.
|
|
238
|
+
*/
|
|
239
|
+
access?: (args: MCPAccessArgs) => MaybePromise<boolean>
|
|
240
|
+
description: string
|
|
241
|
+
handler: (args: ResourceHandlerArgs) => MaybePromise<{
|
|
242
|
+
contents: Array<{ text: string; uri: string }>
|
|
243
|
+
}>
|
|
244
|
+
mimeType: string
|
|
245
|
+
title: string
|
|
246
|
+
uri: ResourceTemplate | string
|
|
493
247
|
}
|
|
494
248
|
|
|
495
|
-
export type
|
|
496
|
-
|
|
497
|
-
|
|
249
|
+
export type MCPPluginCollectionConfig<TSlug extends CollectionSlug> = {
|
|
250
|
+
description?: string
|
|
251
|
+
/** Fallback for built-in tools that don't set their own `overrideResponse`. */
|
|
252
|
+
overrideResponse?: MCPResponseOverride
|
|
253
|
+
tools?: MCPToolsMapForCollection<TSlug>
|
|
498
254
|
}
|
|
499
255
|
|
|
500
|
-
export type
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
256
|
+
export type MCPPluginGlobalConfig = {
|
|
257
|
+
description?: string
|
|
258
|
+
overrideResponse?: MCPResponseOverride
|
|
259
|
+
tools?: MCPGlobalToolsMap
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* The user-facing config shape passed to `mcpPlugin({ ... })`. Tools, prompts,
|
|
264
|
+
* resources, and per-collection/global tool maps live in their own nested
|
|
265
|
+
* fields. `sanitizeMCPConfig` flattens those into `items` and applies defaults
|
|
266
|
+
* to produce a `SanitizedMCPPluginConfig` — the form every internal consumer
|
|
267
|
+
* actually works with.
|
|
268
|
+
*/
|
|
269
|
+
export type MCPPluginConfig = {
|
|
270
|
+
collections?: {
|
|
271
|
+
[Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>
|
|
507
272
|
}
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
273
|
+
/** Skip MCP endpoint registration. */
|
|
274
|
+
disabled?: boolean
|
|
275
|
+
globals?: {
|
|
276
|
+
[Slug in GlobalSlug]?: MCPPluginGlobalConfig
|
|
512
277
|
}
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
278
|
+
hooks?: {
|
|
279
|
+
/** Transform a tool response after its handler returns */
|
|
280
|
+
afterToolCall?: MCPAfterToolCallHook[]
|
|
281
|
+
}
|
|
282
|
+
mcp?: {
|
|
283
|
+
/**
|
|
284
|
+
* Largest HTTP request body, in bytes, that the MCP endpoint accepts. Larger requests
|
|
285
|
+
* are answered with `413`. Base64 file uploads count toward this limit.
|
|
286
|
+
*
|
|
287
|
+
* @default 4194304 (4 MiB, the MCP SDK default)
|
|
288
|
+
*/
|
|
289
|
+
maxRequestBodySize?: number
|
|
290
|
+
serverOptions?: MCPServerOptions
|
|
291
|
+
verboseLogs?: boolean
|
|
518
292
|
}
|
|
293
|
+
/**
|
|
294
|
+
* Replace the default MCP authorization resolver.
|
|
295
|
+
*
|
|
296
|
+
* This hook replaces the default authentication flow. It must set `req.user` to the
|
|
297
|
+
* authenticated Payload user, or to `null` for an anonymous caller, before returning.
|
|
298
|
+
*/
|
|
299
|
+
overrideGetAuthorizedMCP?: (
|
|
300
|
+
args: {
|
|
301
|
+
pluginConfig: SanitizedMCPPluginConfig
|
|
302
|
+
} & GetAuthorizedMCPArgs,
|
|
303
|
+
) => MaybePromise<AuthorizedMCP>
|
|
304
|
+
prompts?: Record<string, Prompt>
|
|
305
|
+
resources?: Record<string, Resource>
|
|
306
|
+
/** Cross-cutting tools (not scoped to any collection or global). */
|
|
307
|
+
tools?: MCPTopLevelToolsMap
|
|
519
308
|
}
|
|
520
309
|
|
|
521
|
-
export
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
310
|
+
export type SanitizedMCPPluginConfig = {
|
|
311
|
+
items: MCPItem[]
|
|
312
|
+
} & Pick<MCPPluginConfig, 'disabled' | 'hooks' | 'mcp' | 'overrideGetAuthorizedMCP'>
|
|
313
|
+
|
|
314
|
+
export type MCPServerOptions = {
|
|
315
|
+
options?: McpServerOptions
|
|
316
|
+
serverInfo?: Partial<Implementation>
|
|
527
317
|
}
|
|
528
318
|
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
319
|
+
/**
|
|
320
|
+
* One MCP primitive plus the metadata needed for config-driven filtering and
|
|
321
|
+
* registration.
|
|
322
|
+
*
|
|
323
|
+
* - `configKey`: the config identifier, e.g. `find` or `echo`.
|
|
324
|
+
* - `mcpName`: the MCP wire name, e.g. `findDocuments` or `echo`.
|
|
325
|
+
* - `label`: human-readable display text.
|
|
326
|
+
*/
|
|
327
|
+
export type MCPItemBase = {
|
|
328
|
+
configKey: string
|
|
329
|
+
label: string
|
|
330
|
+
mcpName: string
|
|
535
331
|
}
|
|
536
332
|
|
|
537
|
-
export
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
333
|
+
export type CollectionMCPItem = {
|
|
334
|
+
collectionSlug: CollectionSlug
|
|
335
|
+
tool: CollectionTool
|
|
336
|
+
type: 'collectionTool'
|
|
337
|
+
} & MCPItemBase
|
|
338
|
+
|
|
339
|
+
export type GlobalMCPItem = {
|
|
340
|
+
globalSlug: GlobalSlug
|
|
341
|
+
tool: GlobalTool
|
|
342
|
+
type: 'globalTool'
|
|
343
|
+
} & MCPItemBase
|
|
344
|
+
|
|
345
|
+
export type MCPItem =
|
|
346
|
+
| ({
|
|
347
|
+
prompt: Prompt
|
|
348
|
+
type: 'prompt'
|
|
349
|
+
} & MCPItemBase)
|
|
350
|
+
| ({
|
|
351
|
+
resource: Resource
|
|
352
|
+
type: 'resource'
|
|
353
|
+
} & MCPItemBase)
|
|
354
|
+
| ({
|
|
355
|
+
tool: Tool
|
|
356
|
+
type: 'tool'
|
|
357
|
+
} & MCPItemBase)
|
|
358
|
+
| CollectionMCPItem
|
|
359
|
+
| GlobalMCPItem
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* The MCP items and access mode authorized for this request. The authenticated user is available
|
|
363
|
+
* as `req.user`.
|
|
364
|
+
*/
|
|
365
|
+
export type AuthorizedMCP = {
|
|
366
|
+
items: MCPItem[]
|
|
367
|
+
overrideAccess: boolean
|
|
542
368
|
}
|