@payloadcms/plugin-mcp 3.85.0 → 4.0.0-internal.1f9ae9a
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/README.md +2 -2
- package/bin.js +39 -0
- package/dist/collection/getAccessField.d.ts +12 -0
- package/dist/collection/getAccessField.d.ts.map +1 -0
- package/dist/collection/getAccessField.js +57 -0
- package/dist/collection/getAccessField.js.map +1 -0
- package/dist/collection/index.d.ts +6 -0
- package/dist/collection/index.d.ts.map +1 -0
- package/dist/collection/index.js +59 -0
- package/dist/collection/index.js.map +1 -0
- package/dist/components/AccessField/index.client.d.ts +10 -0
- package/dist/components/AccessField/index.client.d.ts.map +1 -0
- package/dist/components/AccessField/index.client.js +305 -0
- package/dist/components/AccessField/index.client.js.map +1 -0
- package/dist/components/AccessField/index.css +93 -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 +10 -0
- package/dist/endpoint/access.d.ts.map +1 -0
- package/dist/endpoint/access.js +106 -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 +36 -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/index.d.ts +4 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +44 -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 +163 -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 +250 -0
- package/dist/mcp/builtin/collections/authTools.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 +87 -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 +117 -0
- package/dist/mcp/builtin/collections/deleteTool.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 +159 -0
- package/dist/mcp/builtin/collections/findTool.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 +187 -0
- package/dist/mcp/builtin/collections/updateTool.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 +76 -0
- package/dist/mcp/builtin/globals/findTool.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 +92 -0
- package/dist/mcp/builtin/globals/updateTool.js.map +1 -0
- package/dist/mcp/builtinTools.d.ts +37 -0
- package/dist/mcp/builtinTools.d.ts.map +1 -0
- package/dist/mcp/builtinTools.js +64 -0
- package/dist/mcp/builtinTools.js.map +1 -0
- package/dist/mcp/sanitizeMCPConfig.d.ts +17 -0
- package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -0
- package/dist/mcp/sanitizeMCPConfig.js +167 -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 +89 -0
- package/dist/stdio.js.map +1 -0
- package/dist/types.d.ts +262 -455
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +6 -1
- package/dist/types.js.map +1 -1
- package/dist/utils/camelCase.d.ts.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/localAPIDefaults.d.ts +20 -0
- package/dist/utils/localAPIDefaults.d.ts.map +1 -0
- package/dist/utils/localAPIDefaults.js +19 -0
- package/dist/utils/localAPIDefaults.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/schemaConversion/prepareCollectionSchema.d.ts +7 -0
- package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts.map +1 -0
- package/dist/utils/schemaConversion/prepareCollectionSchema.js +37 -0
- package/dist/utils/schemaConversion/prepareCollectionSchema.js.map +1 -0
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts +2 -2
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.d.ts.map +1 -1
- package/dist/utils/schemaConversion/removeVirtualFieldsFromSchema.js.map +1 -1
- package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts +2 -2
- package/dist/utils/schemaConversion/sanitizeJsonSchema.d.ts.map +1 -1
- package/dist/utils/schemaConversion/sanitizeJsonSchema.js.map +1 -1
- package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts +2 -2
- package/dist/utils/schemaConversion/simplifyRelationshipFields.d.ts.map +1 -1
- package/dist/utils/schemaConversion/simplifyRelationshipFields.js +7 -4
- package/dist/utils/schemaConversion/simplifyRelationshipFields.js.map +1 -1
- package/dist/utils/schemaConversion/transformPointFields.d.ts +2 -2
- package/dist/utils/schemaConversion/transformPointFields.d.ts.map +1 -1
- package/dist/utils/schemaConversion/transformPointFields.js +7 -1
- package/dist/utils/schemaConversion/transformPointFields.js.map +1 -1
- 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 +35 -10
- package/src/collection/getAccessField.ts +64 -0
- package/src/collection/index.ts +63 -0
- package/src/components/AccessField/index.client.tsx +344 -0
- package/src/components/AccessField/index.css +93 -0
- package/src/defineTool.ts +44 -0
- package/src/endpoint/access.ts +132 -0
- package/src/endpoint/index.ts +35 -0
- package/src/exports/client.ts +2 -0
- package/src/index.ts +35 -85
- package/src/mcp/buildMcpServer.ts +224 -0
- package/src/mcp/builtin/collections/authTools.ts +233 -0
- package/src/mcp/builtin/collections/createTool.ts +116 -0
- package/src/mcp/builtin/collections/deleteTool.ts +123 -0
- package/src/mcp/builtin/collections/findTool.ts +187 -0
- package/src/mcp/builtin/collections/updateTool.ts +205 -0
- package/src/mcp/builtin/globals/findTool.ts +96 -0
- package/src/mcp/builtin/globals/updateTool.ts +118 -0
- package/src/mcp/builtinTools.ts +84 -0
- package/src/mcp/sanitizeMCPConfig.ts +239 -0
- package/src/stdio.ts +98 -0
- package/src/types.ts +295 -490
- package/src/utils/getLogger.ts +22 -0
- package/src/utils/getPluginConfig.ts +24 -0
- package/src/utils/localAPIDefaults.ts +22 -0
- package/src/utils/resolveProjectRoot.ts +17 -0
- package/src/utils/schemaConversion/prepareCollectionSchema.ts +39 -0
- package/src/utils/schemaConversion/removeVirtualFieldsFromSchema.ts +3 -3
- package/src/utils/schemaConversion/sanitizeJsonSchema.ts +4 -4
- package/src/utils/schemaConversion/simplifyRelationshipFields.ts +11 -6
- package/src/utils/schemaConversion/transformPointFields.ts +6 -5
- 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/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/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/schemaConversion/convertCollectionSchemaToZod.ts +0 -52
package/src/types.ts
CHANGED
|
@@ -1,542 +1,347 @@
|
|
|
1
1
|
import type {
|
|
2
|
+
CallToolResult,
|
|
3
|
+
ContentBlock,
|
|
4
|
+
JsonSchemaType,
|
|
5
|
+
McpServer,
|
|
6
|
+
ResourceTemplate,
|
|
7
|
+
ServerContext,
|
|
8
|
+
StandardSchemaWithJSON,
|
|
9
|
+
} from '@modelcontextprotocol/server'
|
|
10
|
+
import type {
|
|
11
|
+
AuthCollectionSlug,
|
|
2
12
|
CollectionConfig,
|
|
3
13
|
CollectionSlug,
|
|
14
|
+
DefaultDocumentIDType,
|
|
4
15
|
GlobalSlug,
|
|
16
|
+
MaybePromise,
|
|
5
17
|
PayloadRequest,
|
|
6
18
|
TypedUser,
|
|
7
19
|
} from 'payload'
|
|
8
|
-
import type { z } from 'zod'
|
|
9
20
|
|
|
10
|
-
import
|
|
21
|
+
import type {
|
|
22
|
+
MCPCollectionAuthToolName,
|
|
23
|
+
MCPCollectionBuiltinName,
|
|
24
|
+
MCPGlobalBuiltinName,
|
|
25
|
+
} from './mcp/builtinTools.js'
|
|
11
26
|
|
|
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
|
-
}[]
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Add custom MCP Resource.
|
|
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
|
-
}
|
|
27
|
+
export type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName }
|
|
310
28
|
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
29
|
+
/** Re-exported from `@modelcontextprotocol/server` — the JSON Schema shape the MCP runtime validates against. */
|
|
30
|
+
export type { JsonSchemaType, StandardSchemaWithJSON }
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw
|
|
34
|
+
* JSON Schema literal, or a Standard Schema instance (Zod, Valibot, …).
|
|
35
|
+
*/
|
|
36
|
+
export type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Serializable mirror of `SanitizedMCPPluginConfig` for client components —
|
|
40
|
+
* the full sanitized config carries functions (tool handlers, etc.) that can't
|
|
41
|
+
* cross the server→client boundary. Built by `sanitizeClientPluginConfig` and
|
|
42
|
+
* passed to the `AccessField` component via `clientProps`.
|
|
43
|
+
*
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
export type ClientMCPPluginConfig = {
|
|
47
|
+
items: Array<{
|
|
48
|
+
collectionSlug?: string
|
|
49
|
+
description: string
|
|
50
|
+
globalSlug?: string
|
|
51
|
+
key: string
|
|
52
|
+
label: string
|
|
53
|
+
type: 'collectionTool' | 'globalTool' | 'prompt' | 'resource' | 'tool'
|
|
54
|
+
}>
|
|
55
|
+
}
|
|
318
56
|
|
|
57
|
+
export type MCPToolResponse = {
|
|
58
|
+
content: ContentBlock[]
|
|
319
59
|
/**
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
* @returns The MCP access settings.
|
|
60
|
+
* If available, return the document fetched within the
|
|
61
|
+
* mcp tool. This is threaded as an additional argument to
|
|
62
|
+
* overrideResponse functions and stripped before going on the wire.
|
|
324
63
|
*/
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
getDefaultMcpAccessSettings: (overrideApiKey?: null | string) => Promise<MCPAccessSettings>,
|
|
328
|
-
) => MCPAccessSettings | Promise<MCPAccessSettings>
|
|
64
|
+
doc?: Record<string, unknown>
|
|
65
|
+
} & Pick<CallToolResult, '_meta' | 'isError' | 'structuredContent'>
|
|
329
66
|
|
|
67
|
+
export type MCPResponseOverride = (
|
|
68
|
+
response: MCPToolResponse,
|
|
69
|
+
doc: Record<string, unknown>,
|
|
70
|
+
req: PayloadRequest,
|
|
71
|
+
) => MCPToolResponse
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets
|
|
75
|
+
* its inferred output; anything else falls back to `Record<string, unknown>`.
|
|
76
|
+
*/
|
|
77
|
+
export type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON
|
|
78
|
+
? StandardSchemaWithJSON extends TSchema
|
|
79
|
+
? Record<string, unknown>
|
|
80
|
+
: StandardSchemaWithJSON.InferOutput<TSchema>
|
|
81
|
+
: Record<string, unknown>
|
|
82
|
+
|
|
83
|
+
export type ToolHandlerArgs<TSchema = undefined> = {
|
|
84
|
+
authorizedMCP: AuthorizedMCP
|
|
85
|
+
input: TypedInput<TSchema>
|
|
86
|
+
req: PayloadRequest
|
|
87
|
+
serverContext: ServerContext
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export type CollectionToolHandlerArgs<TSchema = undefined> = {
|
|
91
|
+
collectionSlug: CollectionSlug
|
|
92
|
+
} & ToolHandlerArgs<TSchema>
|
|
93
|
+
|
|
94
|
+
export type GlobalToolHandlerArgs<TSchema = undefined> = {
|
|
95
|
+
globalSlug: GlobalSlug
|
|
96
|
+
} & ToolHandlerArgs<TSchema>
|
|
97
|
+
|
|
98
|
+
export type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {
|
|
99
|
+
description: string
|
|
100
|
+
handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
101
|
+
input?: TSchema
|
|
330
102
|
/**
|
|
331
|
-
*
|
|
103
|
+
* Override the return value of the tool handler
|
|
332
104
|
*/
|
|
333
|
-
|
|
105
|
+
overrideResponse?: MCPResponseOverride
|
|
334
106
|
}
|
|
335
107
|
|
|
336
108
|
/**
|
|
337
|
-
*
|
|
109
|
+
* `TSchema` is the schema itself (Standard Schema, raw JSON Schema, or undefined).
|
|
110
|
+
* The function-form variant of `input` carries a concrete `{ collectionSchema: JsonSchemaType }`
|
|
111
|
+
* parameter type so callers can write `({ collectionSchema }) => …` without annotating it.
|
|
338
112
|
*/
|
|
339
|
-
export type
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
* Set the Redis URL for the MCP handler. This is the URL that will be used to access the Redis server.
|
|
362
|
-
* @default process.env.REDIS_URL
|
|
363
|
-
*/
|
|
364
|
-
redisUrl?: string
|
|
365
|
-
/**
|
|
366
|
-
* Set verbose logging.
|
|
367
|
-
* @default false
|
|
368
|
-
*/
|
|
369
|
-
verboseLogs?: boolean
|
|
113
|
+
export type CollectionTool<
|
|
114
|
+
TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,
|
|
115
|
+
> = {
|
|
116
|
+
handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
117
|
+
input?: ((args: { collectionSchema: JsonSchemaType }) => TSchema) | TSchema
|
|
118
|
+
} & Pick<Tool, 'description' | 'overrideResponse'>
|
|
119
|
+
|
|
120
|
+
export type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =
|
|
121
|
+
{
|
|
122
|
+
handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>
|
|
123
|
+
input?: ((args: { globalSchema: JsonSchemaType }) => TSchema) | TSchema
|
|
124
|
+
} & Pick<Tool, 'description' | 'overrideResponse'>
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Configures (or disables) a built-in tool without replacing it.
|
|
128
|
+
* `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a
|
|
129
|
+
* required handler) from being silently accepted at a built-in key slot.
|
|
130
|
+
*/
|
|
131
|
+
export type MCPBuiltInToolOverride = {
|
|
132
|
+
description?: string
|
|
133
|
+
handler?: never
|
|
134
|
+
overrideResponse?: MCPResponseOverride
|
|
370
135
|
}
|
|
371
136
|
|
|
372
137
|
/**
|
|
373
|
-
*
|
|
138
|
+
* Value at a custom (non-built-in) tool key. Either the tool itself, or `false`
|
|
139
|
+
* to disable it (useful when one plugin defines a custom tool and another
|
|
140
|
+
* wants to opt out per-collection).
|
|
374
141
|
*/
|
|
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
|
-
}
|
|
142
|
+
export type MCPTopLevelToolEntry = Tool
|
|
143
|
+
|
|
144
|
+
export type MCPCollectionToolsMap = {
|
|
145
|
+
[customToolName: string]: boolean | CollectionTool | MCPBuiltInToolOverride | undefined
|
|
146
|
+
} & {
|
|
147
|
+
[K in MCPCollectionBuiltinName]?: false | MCPBuiltInToolOverride
|
|
395
148
|
}
|
|
396
149
|
|
|
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>
|
|
150
|
+
export type MCPAuthCollectionToolsMap = {
|
|
151
|
+
[K in MCPCollectionAuthToolName]?: MCPBuiltInToolOverride | true
|
|
152
|
+
} & MCPCollectionToolsMap
|
|
431
153
|
|
|
432
|
-
|
|
154
|
+
/** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */
|
|
155
|
+
export type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends AuthCollectionSlug
|
|
156
|
+
? MCPAuthCollectionToolsMap
|
|
157
|
+
: MCPCollectionToolsMap
|
|
433
158
|
|
|
434
|
-
export type
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
position?: 'main' | 'sidebar'
|
|
439
|
-
required?: boolean
|
|
440
|
-
type: string
|
|
159
|
+
export type MCPGlobalToolsMap = {
|
|
160
|
+
[customToolName: string]: boolean | GlobalTool | MCPBuiltInToolOverride | undefined
|
|
161
|
+
} & {
|
|
162
|
+
[K in MCPGlobalBuiltinName]?: false | MCPBuiltInToolOverride
|
|
441
163
|
}
|
|
442
164
|
|
|
443
|
-
export type
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
type?: string
|
|
450
|
-
}
|
|
451
|
-
fieldName: string
|
|
165
|
+
export type MCPTopLevelToolsMap = Record<string, Tool>
|
|
166
|
+
|
|
167
|
+
export type PromptHandlerArgs<TSchema = undefined> = {
|
|
168
|
+
input: TypedInput<TSchema>
|
|
169
|
+
req: PayloadRequest
|
|
170
|
+
serverContext: ServerContext
|
|
452
171
|
}
|
|
453
172
|
|
|
454
|
-
export type
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
173
|
+
export type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {
|
|
174
|
+
argsSchema: TSchema
|
|
175
|
+
description: string
|
|
176
|
+
handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{
|
|
177
|
+
messages: Array<{ content: { text: string; type: 'text' }; role: 'assistant' | 'user' }>
|
|
178
|
+
}>
|
|
179
|
+
title: string
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export type ResourceHandlerArgs = {
|
|
183
|
+
/** Variables extracted from a `ResourceTemplate` URI. Empty for static-URI resources. */
|
|
184
|
+
params: Record<string, string>
|
|
185
|
+
req: PayloadRequest
|
|
186
|
+
serverContext: ServerContext
|
|
187
|
+
uri: URL
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
export type Resource = {
|
|
191
|
+
description: string
|
|
192
|
+
handler: (args: ResourceHandlerArgs) => MaybePromise<{
|
|
193
|
+
contents: Array<{ text: string; uri: string }>
|
|
194
|
+
}>
|
|
195
|
+
mimeType: string
|
|
196
|
+
title: string
|
|
197
|
+
uri: ResourceTemplate | string
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
export type MCPPluginCollectionConfig<TSlug extends CollectionSlug> = {
|
|
201
|
+
description?: string
|
|
202
|
+
/** Fallback for built-in tools that don't set their own `overrideResponse`. */
|
|
203
|
+
overrideResponse?: MCPResponseOverride
|
|
204
|
+
tools?: MCPToolsMapForCollection<TSlug>
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
export type MCPPluginGlobalConfig = {
|
|
461
208
|
description?: string
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
versioning?: boolean
|
|
209
|
+
overrideResponse?: MCPResponseOverride
|
|
210
|
+
tools?: MCPGlobalToolsMap
|
|
465
211
|
}
|
|
466
212
|
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
width: number
|
|
478
|
-
}>
|
|
213
|
+
/**
|
|
214
|
+
* The user-facing config shape passed to `mcpPlugin({ ... })`. Tools, prompts,
|
|
215
|
+
* resources, and per-collection/global tool maps live in their own nested
|
|
216
|
+
* fields. `sanitizeMCPConfig` flattens those into `items` and applies defaults
|
|
217
|
+
* to produce a `SanitizedMCPPluginConfig` — the form every internal consumer
|
|
218
|
+
* actually works with.
|
|
219
|
+
*/
|
|
220
|
+
export type MCPPluginConfig = {
|
|
221
|
+
collections?: {
|
|
222
|
+
[Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>
|
|
479
223
|
}
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
titleSuffix?: string
|
|
224
|
+
/** Skip MCP registration. The API key collection is still added (so DB / types stay stable). */
|
|
225
|
+
disabled?: boolean
|
|
226
|
+
globals?: {
|
|
227
|
+
[Slug in GlobalSlug]?: MCPPluginGlobalConfig
|
|
485
228
|
}
|
|
486
|
-
|
|
229
|
+
mcp?: {
|
|
230
|
+
serverOptions?: MCPServerOptions
|
|
231
|
+
verboseLogs?: boolean
|
|
232
|
+
}
|
|
233
|
+
overrideApiKeyCollection?: (collection: CollectionConfig) => CollectionConfig
|
|
234
|
+
/** Replace the default API-key auth with a custom resolver. */
|
|
235
|
+
overrideAuth?: (args: {
|
|
236
|
+
getAPIKeyDoc: (overrideApiKey?: string) => Promise<MCPAPIKeysDoc>
|
|
237
|
+
getAuthorizedMCP: (args: { apiKeyDoc: MCPAPIKeysDoc }) => AuthorizedMCP
|
|
238
|
+
pluginConfig: SanitizedMCPPluginConfig
|
|
239
|
+
req: PayloadRequest
|
|
240
|
+
}) => MaybePromise<AuthorizedMCP>
|
|
241
|
+
prompts?: Record<string, Prompt>
|
|
242
|
+
resources?: Record<string, Resource>
|
|
243
|
+
/** Cross-cutting tools (not scoped to any collection or global). */
|
|
244
|
+
tools?: MCPTopLevelToolsMap
|
|
245
|
+
userCollection?: CollectionSlug
|
|
487
246
|
}
|
|
488
247
|
|
|
489
|
-
export type
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
}
|
|
248
|
+
export type SanitizedMCPPluginConfig = {
|
|
249
|
+
items: MCPItem[]
|
|
250
|
+
userCollection: CollectionSlug
|
|
251
|
+
} & Pick<MCPPluginConfig, 'disabled' | 'mcp' | 'overrideApiKeyCollection' | 'overrideAuth'>
|
|
494
252
|
|
|
495
|
-
export type
|
|
496
|
-
|
|
497
|
-
|
|
253
|
+
export type MCPServerOptions = {
|
|
254
|
+
options?: ConstructorParameters<typeof McpServer>[1]
|
|
255
|
+
serverInfo?: Partial<ConstructorParameters<typeof McpServer>[0]>
|
|
498
256
|
}
|
|
499
257
|
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
258
|
+
/**
|
|
259
|
+
* Nested access tree as stored in the collection.
|
|
260
|
+
* A `false` leaf disables that tool; missing keys defer to
|
|
261
|
+
* defaults (built-in CRUD is on, opt-in tools are off).
|
|
262
|
+
*/
|
|
263
|
+
export type MCPAPIKeysDocAccessTree = {
|
|
264
|
+
collections?: {
|
|
265
|
+
[CollectionSlug: CollectionSlug]: {
|
|
266
|
+
[ToolKey: string]: boolean
|
|
267
|
+
}
|
|
507
268
|
}
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
269
|
+
globals?: {
|
|
270
|
+
[GlobalSlug: GlobalSlug]: {
|
|
271
|
+
[ToolKey: string]: boolean
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
prompts?: {
|
|
275
|
+
[PromptKey: string]: boolean
|
|
276
|
+
}
|
|
277
|
+
resources?: {
|
|
278
|
+
[ResourceKey: string]: boolean
|
|
512
279
|
}
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
typescript?: {
|
|
516
|
-
declare?: boolean
|
|
517
|
-
outputFile?: string
|
|
280
|
+
tools?: {
|
|
281
|
+
[ToolKey: string]: boolean
|
|
518
282
|
}
|
|
519
283
|
}
|
|
520
284
|
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
285
|
+
/**
|
|
286
|
+
* Stored on `payload-mcp-api-keys` docs
|
|
287
|
+
*/
|
|
288
|
+
export type MCPAPIKeysDoc = {
|
|
289
|
+
access: MCPAPIKeysDocAccessTree
|
|
290
|
+
id: DefaultDocumentIDType
|
|
291
|
+
overrideAccess?: boolean
|
|
292
|
+
user: null | TypedUser
|
|
527
293
|
}
|
|
528
294
|
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
295
|
+
/**
|
|
296
|
+
* One MCP primitive — tool, prompt, or resource — paired with the metadata both
|
|
297
|
+
* the endpoint and the API key collection need. Built by `sanitizeMCPConfig`,
|
|
298
|
+
* filtered by `getAuthorizedMCP`, registered by the MCP endpoint.
|
|
299
|
+
*
|
|
300
|
+
* - `key`: the config identifier (`find`, `echo`). Used for the API-key deny
|
|
301
|
+
* lookup and as the admin checkbox field name. For collection/global tools,
|
|
302
|
+
* the MCP wire name (`findPosts`) is derived from `key + slug` at
|
|
303
|
+
* registration time.
|
|
304
|
+
* - `label`: human-readable admin-UI display text for the checkbox.
|
|
305
|
+
* - `tool` / `prompt` / `resource`: the live primitive (its own
|
|
306
|
+
* `description` is what both MCP clients and the admin UI surface).
|
|
307
|
+
*/
|
|
308
|
+
export type MCPItemBase = {
|
|
309
|
+
key: string
|
|
310
|
+
label: string
|
|
535
311
|
}
|
|
536
312
|
|
|
537
|
-
export
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
313
|
+
export type MCPItem =
|
|
314
|
+
| ({
|
|
315
|
+
collectionSlug: CollectionSlug
|
|
316
|
+
tool: CollectionTool
|
|
317
|
+
type: 'collectionTool'
|
|
318
|
+
} & MCPItemBase)
|
|
319
|
+
| ({
|
|
320
|
+
globalSlug: GlobalSlug
|
|
321
|
+
tool: GlobalTool
|
|
322
|
+
type: 'globalTool'
|
|
323
|
+
} & MCPItemBase)
|
|
324
|
+
| ({
|
|
325
|
+
prompt: Prompt
|
|
326
|
+
type: 'prompt'
|
|
327
|
+
} & MCPItemBase)
|
|
328
|
+
| ({
|
|
329
|
+
resource: Resource
|
|
330
|
+
type: 'resource'
|
|
331
|
+
} & MCPItemBase)
|
|
332
|
+
| ({
|
|
333
|
+
tool: Tool
|
|
334
|
+
type: 'tool'
|
|
335
|
+
} & MCPItemBase)
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* The caller's identity + the MCP items they can use for this request. Returned
|
|
339
|
+
* by `getAuthorizedMCP`; denied items are simply absent from `items`. Handlers
|
|
340
|
+
* receive this via `args.authorizedMCP` so they can spread
|
|
341
|
+
* `localAPIDefaults(authorizedMCP)` into every local API call.
|
|
342
|
+
*/
|
|
343
|
+
export type AuthorizedMCP = {
|
|
344
|
+
items: MCPItem[]
|
|
345
|
+
overrideAccess: boolean
|
|
346
|
+
user: null | TypedUser
|
|
542
347
|
}
|