@payloadcms/plugin-mcp 4.0.0-canary.0 → 4.0.0-canary.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/collection/getAccessField.d.ts.map +1 -1
- package/dist/collection/getAccessField.js +25 -10
- package/dist/collection/getAccessField.js.map +1 -1
- package/dist/collection/index.d.ts.map +1 -1
- package/dist/collection/index.js +73 -27
- package/dist/collection/index.js.map +1 -1
- package/dist/components/APIKeyField/index.client.d.ts +9 -0
- package/dist/components/APIKeyField/index.client.d.ts.map +1 -0
- package/dist/components/APIKeyField/index.client.js +85 -0
- package/dist/components/APIKeyField/index.client.js.map +1 -0
- package/dist/components/APIKeyField/index.css +105 -0
- package/dist/components/APIKeysEmptyState/index.client.d.ts +4 -0
- package/dist/components/APIKeysEmptyState/index.client.d.ts.map +1 -0
- package/dist/components/APIKeysEmptyState/index.client.js +21 -0
- package/dist/components/APIKeysEmptyState/index.client.js.map +1 -0
- package/dist/components/AccessField/index.client.d.ts.map +1 -1
- package/dist/components/AccessField/index.client.js +149 -207
- package/dist/components/AccessField/index.client.js.map +1 -1
- package/dist/components/AccessField/index.css +50 -44
- package/dist/components/SettingsMenu/index.client.d.ts +8 -0
- package/dist/components/SettingsMenu/index.client.d.ts.map +1 -0
- package/dist/components/SettingsMenu/index.client.js +29 -0
- package/dist/components/SettingsMenu/index.client.js.map +1 -0
- package/dist/endpoint/access.js +21 -5
- package/dist/endpoint/access.js.map +1 -1
- package/dist/exports/client.d.ts +3 -0
- package/dist/exports/client.d.ts.map +1 -1
- package/dist/exports/client.js +3 -0
- package/dist/exports/client.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +46 -3
- package/dist/index.js.map +1 -1
- package/dist/mcp/buildMcpServer.d.ts.map +1 -1
- package/dist/mcp/buildMcpServer.js +100 -64
- package/dist/mcp/buildMcpServer.js.map +1 -1
- package/dist/mcp/builtin/collections/createTool.d.ts +1 -1
- package/dist/mcp/builtin/collections/createTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/createTool.js +28 -21
- package/dist/mcp/builtin/collections/createTool.js.map +1 -1
- package/dist/mcp/builtin/collections/deleteTool.d.ts +1 -1
- package/dist/mcp/builtin/collections/deleteTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/deleteTool.js +5 -20
- package/dist/mcp/builtin/collections/deleteTool.js.map +1 -1
- package/dist/mcp/builtin/collections/findTool.d.ts +1 -1
- package/dist/mcp/builtin/collections/findTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/findTool.js +6 -21
- package/dist/mcp/builtin/collections/findTool.js.map +1 -1
- package/dist/mcp/builtin/collections/formatCollectionError.d.ts +9 -0
- package/dist/mcp/builtin/collections/formatCollectionError.d.ts.map +1 -0
- package/dist/mcp/builtin/collections/formatCollectionError.js +60 -0
- package/dist/mcp/builtin/collections/formatCollectionError.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 +35 -0
- package/dist/mcp/builtin/collections/getCollectionSchemaTool.js.map +1 -0
- package/dist/mcp/builtin/collections/updateTool.d.ts +1 -1
- package/dist/mcp/builtin/collections/updateTool.d.ts.map +1 -1
- package/dist/mcp/builtin/collections/updateTool.js +74 -62
- package/dist/mcp/builtin/collections/updateTool.js.map +1 -1
- 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 +49 -0
- package/dist/mcp/builtin/getConfigInfoTool.js.map +1 -0
- package/dist/mcp/builtin/globals/findTool.js +1 -1
- package/dist/mcp/builtin/globals/findTool.js.map +1 -1
- 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 +35 -0
- package/dist/mcp/builtin/globals/getGlobalSchemaTool.js.map +1 -0
- package/dist/mcp/builtin/globals/updateTool.d.ts.map +1 -1
- package/dist/mcp/builtin/globals/updateTool.js +21 -19
- package/dist/mcp/builtin/globals/updateTool.js.map +1 -1
- package/dist/mcp/builtin/validateEntityData.d.ts +14 -0
- package/dist/mcp/builtin/validateEntityData.d.ts.map +1 -0
- package/dist/mcp/builtin/validateEntityData.js +82 -0
- package/dist/mcp/builtin/validateEntityData.js.map +1 -0
- package/dist/mcp/builtinTools.d.ts +84 -16
- package/dist/mcp/builtinTools.d.ts.map +1 -1
- package/dist/mcp/builtinTools.js +54 -11
- package/dist/mcp/builtinTools.js.map +1 -1
- package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
- package/dist/mcp/sanitizeMCPConfig.js +61 -40
- package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
- package/dist/translations/index.d.ts +11 -0
- package/dist/translations/index.d.ts.map +1 -0
- package/dist/translations/index.js +92 -0
- package/dist/translations/index.js.map +1 -0
- package/dist/translations/languages/ar.d.ts +31 -0
- package/dist/translations/languages/ar.d.ts.map +1 -0
- package/dist/translations/languages/ar.js +34 -0
- package/dist/translations/languages/ar.js.map +1 -0
- package/dist/translations/languages/az.d.ts +31 -0
- package/dist/translations/languages/az.d.ts.map +1 -0
- package/dist/translations/languages/az.js +34 -0
- package/dist/translations/languages/az.js.map +1 -0
- package/dist/translations/languages/bg.d.ts +31 -0
- package/dist/translations/languages/bg.d.ts.map +1 -0
- package/dist/translations/languages/bg.js +34 -0
- package/dist/translations/languages/bg.js.map +1 -0
- package/dist/translations/languages/bnBd.d.ts +31 -0
- package/dist/translations/languages/bnBd.d.ts.map +1 -0
- package/dist/translations/languages/bnBd.js +34 -0
- package/dist/translations/languages/bnBd.js.map +1 -0
- package/dist/translations/languages/bnIn.d.ts +31 -0
- package/dist/translations/languages/bnIn.d.ts.map +1 -0
- package/dist/translations/languages/bnIn.js +34 -0
- package/dist/translations/languages/bnIn.js.map +1 -0
- package/dist/translations/languages/ca.d.ts +31 -0
- package/dist/translations/languages/ca.d.ts.map +1 -0
- package/dist/translations/languages/ca.js +34 -0
- package/dist/translations/languages/ca.js.map +1 -0
- package/dist/translations/languages/cs.d.ts +31 -0
- package/dist/translations/languages/cs.d.ts.map +1 -0
- package/dist/translations/languages/cs.js +34 -0
- package/dist/translations/languages/cs.js.map +1 -0
- package/dist/translations/languages/da.d.ts +31 -0
- package/dist/translations/languages/da.d.ts.map +1 -0
- package/dist/translations/languages/da.js +34 -0
- package/dist/translations/languages/da.js.map +1 -0
- package/dist/translations/languages/de.d.ts +31 -0
- package/dist/translations/languages/de.d.ts.map +1 -0
- package/dist/translations/languages/de.js +34 -0
- package/dist/translations/languages/de.js.map +1 -0
- package/dist/translations/languages/en.d.ts +31 -0
- package/dist/translations/languages/en.d.ts.map +1 -0
- package/dist/translations/languages/en.js +34 -0
- package/dist/translations/languages/en.js.map +1 -0
- package/dist/translations/languages/es.d.ts +31 -0
- package/dist/translations/languages/es.d.ts.map +1 -0
- package/dist/translations/languages/es.js +34 -0
- package/dist/translations/languages/es.js.map +1 -0
- package/dist/translations/languages/et.d.ts +31 -0
- package/dist/translations/languages/et.d.ts.map +1 -0
- package/dist/translations/languages/et.js +34 -0
- package/dist/translations/languages/et.js.map +1 -0
- package/dist/translations/languages/fa.d.ts +31 -0
- package/dist/translations/languages/fa.d.ts.map +1 -0
- package/dist/translations/languages/fa.js +34 -0
- package/dist/translations/languages/fa.js.map +1 -0
- package/dist/translations/languages/fr.d.ts +31 -0
- package/dist/translations/languages/fr.d.ts.map +1 -0
- package/dist/translations/languages/fr.js +34 -0
- package/dist/translations/languages/fr.js.map +1 -0
- package/dist/translations/languages/he.d.ts +31 -0
- package/dist/translations/languages/he.d.ts.map +1 -0
- package/dist/translations/languages/he.js +34 -0
- package/dist/translations/languages/he.js.map +1 -0
- package/dist/translations/languages/hr.d.ts +31 -0
- package/dist/translations/languages/hr.d.ts.map +1 -0
- package/dist/translations/languages/hr.js +34 -0
- package/dist/translations/languages/hr.js.map +1 -0
- package/dist/translations/languages/hu.d.ts +31 -0
- package/dist/translations/languages/hu.d.ts.map +1 -0
- package/dist/translations/languages/hu.js +34 -0
- package/dist/translations/languages/hu.js.map +1 -0
- package/dist/translations/languages/hy.d.ts +31 -0
- package/dist/translations/languages/hy.d.ts.map +1 -0
- package/dist/translations/languages/hy.js +34 -0
- package/dist/translations/languages/hy.js.map +1 -0
- package/dist/translations/languages/id.d.ts +31 -0
- package/dist/translations/languages/id.d.ts.map +1 -0
- package/dist/translations/languages/id.js +34 -0
- package/dist/translations/languages/id.js.map +1 -0
- package/dist/translations/languages/is.d.ts +31 -0
- package/dist/translations/languages/is.d.ts.map +1 -0
- package/dist/translations/languages/is.js +34 -0
- package/dist/translations/languages/is.js.map +1 -0
- package/dist/translations/languages/it.d.ts +31 -0
- package/dist/translations/languages/it.d.ts.map +1 -0
- package/dist/translations/languages/it.js +34 -0
- package/dist/translations/languages/it.js.map +1 -0
- package/dist/translations/languages/ja.d.ts +31 -0
- package/dist/translations/languages/ja.d.ts.map +1 -0
- package/dist/translations/languages/ja.js +34 -0
- package/dist/translations/languages/ja.js.map +1 -0
- package/dist/translations/languages/ko.d.ts +31 -0
- package/dist/translations/languages/ko.d.ts.map +1 -0
- package/dist/translations/languages/ko.js +34 -0
- package/dist/translations/languages/ko.js.map +1 -0
- package/dist/translations/languages/lt.d.ts +31 -0
- package/dist/translations/languages/lt.d.ts.map +1 -0
- package/dist/translations/languages/lt.js +34 -0
- package/dist/translations/languages/lt.js.map +1 -0
- package/dist/translations/languages/lv.d.ts +31 -0
- package/dist/translations/languages/lv.d.ts.map +1 -0
- package/dist/translations/languages/lv.js +34 -0
- package/dist/translations/languages/lv.js.map +1 -0
- package/dist/translations/languages/my.d.ts +31 -0
- package/dist/translations/languages/my.d.ts.map +1 -0
- package/dist/translations/languages/my.js +34 -0
- package/dist/translations/languages/my.js.map +1 -0
- package/dist/translations/languages/nb.d.ts +31 -0
- package/dist/translations/languages/nb.d.ts.map +1 -0
- package/dist/translations/languages/nb.js +34 -0
- package/dist/translations/languages/nb.js.map +1 -0
- package/dist/translations/languages/nl.d.ts +31 -0
- package/dist/translations/languages/nl.d.ts.map +1 -0
- package/dist/translations/languages/nl.js +34 -0
- package/dist/translations/languages/nl.js.map +1 -0
- package/dist/translations/languages/pl.d.ts +31 -0
- package/dist/translations/languages/pl.d.ts.map +1 -0
- package/dist/translations/languages/pl.js +34 -0
- package/dist/translations/languages/pl.js.map +1 -0
- package/dist/translations/languages/pt.d.ts +31 -0
- package/dist/translations/languages/pt.d.ts.map +1 -0
- package/dist/translations/languages/pt.js +34 -0
- package/dist/translations/languages/pt.js.map +1 -0
- package/dist/translations/languages/ro.d.ts +31 -0
- package/dist/translations/languages/ro.d.ts.map +1 -0
- package/dist/translations/languages/ro.js +34 -0
- package/dist/translations/languages/ro.js.map +1 -0
- package/dist/translations/languages/rs.d.ts +31 -0
- package/dist/translations/languages/rs.d.ts.map +1 -0
- package/dist/translations/languages/rs.js +34 -0
- package/dist/translations/languages/rs.js.map +1 -0
- package/dist/translations/languages/rsLatin.d.ts +31 -0
- package/dist/translations/languages/rsLatin.d.ts.map +1 -0
- package/dist/translations/languages/rsLatin.js +34 -0
- package/dist/translations/languages/rsLatin.js.map +1 -0
- package/dist/translations/languages/ru.d.ts +31 -0
- package/dist/translations/languages/ru.d.ts.map +1 -0
- package/dist/translations/languages/ru.js +34 -0
- package/dist/translations/languages/ru.js.map +1 -0
- package/dist/translations/languages/sk.d.ts +31 -0
- package/dist/translations/languages/sk.d.ts.map +1 -0
- package/dist/translations/languages/sk.js +34 -0
- package/dist/translations/languages/sk.js.map +1 -0
- package/dist/translations/languages/sl.d.ts +31 -0
- package/dist/translations/languages/sl.d.ts.map +1 -0
- package/dist/translations/languages/sl.js +34 -0
- package/dist/translations/languages/sl.js.map +1 -0
- package/dist/translations/languages/sv.d.ts +31 -0
- package/dist/translations/languages/sv.d.ts.map +1 -0
- package/dist/translations/languages/sv.js +34 -0
- package/dist/translations/languages/sv.js.map +1 -0
- package/dist/translations/languages/ta.d.ts +31 -0
- package/dist/translations/languages/ta.d.ts.map +1 -0
- package/dist/translations/languages/ta.js +34 -0
- package/dist/translations/languages/ta.js.map +1 -0
- package/dist/translations/languages/th.d.ts +31 -0
- package/dist/translations/languages/th.d.ts.map +1 -0
- package/dist/translations/languages/th.js +34 -0
- package/dist/translations/languages/th.js.map +1 -0
- package/dist/translations/languages/tr.d.ts +31 -0
- package/dist/translations/languages/tr.d.ts.map +1 -0
- package/dist/translations/languages/tr.js +34 -0
- package/dist/translations/languages/tr.js.map +1 -0
- package/dist/translations/languages/uk.d.ts +31 -0
- package/dist/translations/languages/uk.d.ts.map +1 -0
- package/dist/translations/languages/uk.js +34 -0
- package/dist/translations/languages/uk.js.map +1 -0
- package/dist/translations/languages/vi.d.ts +31 -0
- package/dist/translations/languages/vi.d.ts.map +1 -0
- package/dist/translations/languages/vi.js +34 -0
- package/dist/translations/languages/vi.js.map +1 -0
- package/dist/translations/languages/zh.d.ts +31 -0
- package/dist/translations/languages/zh.d.ts.map +1 -0
- package/dist/translations/languages/zh.js +34 -0
- package/dist/translations/languages/zh.js.map +1 -0
- package/dist/translations/languages/zhTw.d.ts +31 -0
- package/dist/translations/languages/zhTw.d.ts.map +1 -0
- package/dist/translations/languages/zhTw.js +34 -0
- package/dist/translations/languages/zhTw.js.map +1 -0
- package/dist/translations/types.d.ts +32 -0
- package/dist/translations/types.d.ts.map +1 -0
- package/dist/translations/types.js +3 -0
- package/dist/translations/types.js.map +1 -0
- package/dist/types.d.ts +22 -28
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/utils/schemaConversion/getEntityInputSchema.d.ts +11 -0
- package/dist/utils/schemaConversion/getEntityInputSchema.d.ts.map +1 -0
- package/dist/utils/schemaConversion/getEntityInputSchema.js +34 -0
- package/dist/utils/schemaConversion/getEntityInputSchema.js.map +1 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts +15 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.d.ts.map +1 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.js +464 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.js.map +1 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js +158 -0
- package/dist/utils/schemaConversion/sanitizeEntitySchema.spec.js.map +1 -0
- package/dist/utils/whereSchema.d.ts +9 -0
- package/dist/utils/whereSchema.d.ts.map +1 -0
- package/dist/utils/whereSchema.js +13 -0
- package/dist/utils/whereSchema.js.map +1 -0
- package/package.json +7 -6
- package/src/collection/getAccessField.ts +33 -13
- package/src/collection/index.ts +64 -22
- package/src/components/APIKeyField/index.client.tsx +73 -0
- package/src/components/APIKeyField/index.css +105 -0
- package/src/components/APIKeysEmptyState/index.client.tsx +36 -0
- package/src/components/AccessField/index.client.tsx +175 -220
- package/src/components/AccessField/index.css +50 -44
- package/src/components/SettingsMenu/index.client.tsx +34 -0
- package/src/endpoint/access.ts +17 -5
- package/src/exports/client.ts +3 -0
- package/src/index.ts +49 -3
- package/src/mcp/buildMcpServer.ts +123 -90
- package/src/mcp/builtin/collections/createTool.ts +46 -50
- package/src/mcp/builtin/collections/deleteTool.ts +9 -16
- package/src/mcp/builtin/collections/findTool.ts +7 -17
- package/src/mcp/builtin/collections/formatCollectionError.ts +84 -0
- package/src/mcp/builtin/collections/getCollectionSchemaTool.ts +28 -0
- package/src/mcp/builtin/collections/updateTool.ts +97 -91
- package/src/mcp/builtin/getConfigInfoTool.ts +44 -0
- package/src/mcp/builtin/globals/findTool.ts +1 -1
- package/src/mcp/builtin/globals/getGlobalSchemaTool.ts +28 -0
- package/src/mcp/builtin/globals/updateTool.ts +40 -43
- package/src/mcp/builtin/validateEntityData.ts +132 -0
- package/src/mcp/builtinTools.ts +52 -38
- package/src/mcp/sanitizeMCPConfig.ts +78 -57
- package/src/translations/index.ts +108 -0
- package/src/translations/languages/ar.ts +35 -0
- package/src/translations/languages/az.ts +35 -0
- package/src/translations/languages/bg.ts +35 -0
- package/src/translations/languages/bnBd.ts +35 -0
- package/src/translations/languages/bnIn.ts +35 -0
- package/src/translations/languages/ca.ts +35 -0
- package/src/translations/languages/cs.ts +35 -0
- package/src/translations/languages/da.ts +35 -0
- package/src/translations/languages/de.ts +35 -0
- package/src/translations/languages/en.ts +35 -0
- package/src/translations/languages/es.ts +35 -0
- package/src/translations/languages/et.ts +35 -0
- package/src/translations/languages/fa.ts +35 -0
- package/src/translations/languages/fr.ts +35 -0
- package/src/translations/languages/he.ts +35 -0
- package/src/translations/languages/hr.ts +35 -0
- package/src/translations/languages/hu.ts +35 -0
- package/src/translations/languages/hy.ts +35 -0
- package/src/translations/languages/id.ts +35 -0
- package/src/translations/languages/is.ts +35 -0
- package/src/translations/languages/it.ts +35 -0
- package/src/translations/languages/ja.ts +35 -0
- package/src/translations/languages/ko.ts +35 -0
- package/src/translations/languages/lt.ts +35 -0
- package/src/translations/languages/lv.ts +35 -0
- package/src/translations/languages/my.ts +35 -0
- package/src/translations/languages/nb.ts +35 -0
- package/src/translations/languages/nl.ts +35 -0
- package/src/translations/languages/pl.ts +35 -0
- package/src/translations/languages/pt.ts +35 -0
- package/src/translations/languages/ro.ts +35 -0
- package/src/translations/languages/rs.ts +35 -0
- package/src/translations/languages/rsLatin.ts +35 -0
- package/src/translations/languages/ru.ts +35 -0
- package/src/translations/languages/sk.ts +35 -0
- package/src/translations/languages/sl.ts +35 -0
- package/src/translations/languages/sv.ts +35 -0
- package/src/translations/languages/ta.ts +35 -0
- package/src/translations/languages/th.ts +35 -0
- package/src/translations/languages/tr.ts +35 -0
- package/src/translations/languages/uk.ts +35 -0
- package/src/translations/languages/vi.ts +35 -0
- package/src/translations/languages/zh.ts +35 -0
- package/src/translations/languages/zhTw.ts +35 -0
- package/src/translations/types.ts +34 -0
- package/src/types.ts +30 -30
- package/src/utils/schemaConversion/getEntityInputSchema.ts +78 -0
- package/src/utils/schemaConversion/sanitizeEntitySchema.spec.ts +103 -0
- package/src/utils/schemaConversion/sanitizeEntitySchema.ts +529 -0
- package/src/utils/whereSchema.ts +24 -0
- package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts +0 -7
- package/dist/utils/schemaConversion/prepareCollectionSchema.d.ts.map +0 -1
- package/dist/utils/schemaConversion/prepareCollectionSchema.js +0 -37
- package/dist/utils/schemaConversion/prepareCollectionSchema.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 -56
- 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 -57
- package/dist/utils/schemaConversion/transformPointFields.js.map +0 -1
- package/src/utils/schemaConversion/prepareCollectionSchema.ts +0 -39
- package/src/utils/schemaConversion/sanitizeJsonSchema.ts +0 -62
- package/src/utils/schemaConversion/simplifyRelationshipFields.ts +0 -70
- package/src/utils/schemaConversion/transformPointFields.ts +0 -56
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
import { sanitizeEntitySchema } from './sanitizeEntitySchema.js';
|
|
3
|
+
describe('sanitizeEntitySchema', ()=>{
|
|
4
|
+
it('keeps a Lexical node union strict (oneOf) while simplifying relationship values to IDs', ()=>{
|
|
5
|
+
// Shaped like the schema the MCP server prepares for a collection with a Lexical richText field:
|
|
6
|
+
// a `$defs` node union (a `oneOf` of node shapes) where a relationship node's `value` is either
|
|
7
|
+
// an ID or a `$ref` to the populated related collection.
|
|
8
|
+
const standalone = {
|
|
9
|
+
type: 'object',
|
|
10
|
+
$defs: {
|
|
11
|
+
LexicalNodes_ABCDEF12: {
|
|
12
|
+
oneOf: [
|
|
13
|
+
{
|
|
14
|
+
type: 'object',
|
|
15
|
+
additionalProperties: false,
|
|
16
|
+
properties: {
|
|
17
|
+
type: {
|
|
18
|
+
const: 'paragraph'
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
required: [
|
|
22
|
+
'type'
|
|
23
|
+
]
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
type: 'object',
|
|
27
|
+
additionalProperties: false,
|
|
28
|
+
properties: {
|
|
29
|
+
type: {
|
|
30
|
+
const: 'relationship'
|
|
31
|
+
},
|
|
32
|
+
value: {
|
|
33
|
+
oneOf: [
|
|
34
|
+
{
|
|
35
|
+
type: 'string'
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
$ref: '#/$defs/posts'
|
|
39
|
+
}
|
|
40
|
+
]
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
required: [
|
|
44
|
+
'type'
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
posts: {
|
|
50
|
+
type: 'object',
|
|
51
|
+
additionalProperties: false,
|
|
52
|
+
properties: {
|
|
53
|
+
id: {
|
|
54
|
+
type: 'string'
|
|
55
|
+
},
|
|
56
|
+
title: {
|
|
57
|
+
type: 'string'
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
properties: {
|
|
63
|
+
id: {
|
|
64
|
+
type: 'string'
|
|
65
|
+
},
|
|
66
|
+
content: {
|
|
67
|
+
type: 'object',
|
|
68
|
+
properties: {
|
|
69
|
+
root: {
|
|
70
|
+
type: 'object',
|
|
71
|
+
properties: {
|
|
72
|
+
children: {
|
|
73
|
+
type: 'array',
|
|
74
|
+
items: {
|
|
75
|
+
$ref: '#/$defs/LexicalNodes_ABCDEF12'
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
};
|
|
84
|
+
expect(sanitizeEntitySchema(standalone)).toStrictEqual({
|
|
85
|
+
type: 'object',
|
|
86
|
+
$defs: {
|
|
87
|
+
// The node union is renamed to a short, readable `node`, and stays a strict discriminated
|
|
88
|
+
// `oneOf` - not loosened to `anyOf`...
|
|
89
|
+
node: {
|
|
90
|
+
oneOf: [
|
|
91
|
+
{
|
|
92
|
+
type: 'object',
|
|
93
|
+
additionalProperties: false,
|
|
94
|
+
properties: {
|
|
95
|
+
type: {
|
|
96
|
+
const: 'paragraph'
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
required: [
|
|
100
|
+
'type'
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
type: 'object',
|
|
105
|
+
additionalProperties: false,
|
|
106
|
+
properties: {
|
|
107
|
+
type: {
|
|
108
|
+
const: 'relationship'
|
|
109
|
+
},
|
|
110
|
+
// ...while the relationship `value` is simplified to a bare ID (the populated-doc `$ref` is dropped).
|
|
111
|
+
value: {
|
|
112
|
+
type: 'string',
|
|
113
|
+
description: 'The ID of the related "posts" document.'
|
|
114
|
+
}
|
|
115
|
+
},
|
|
116
|
+
required: [
|
|
117
|
+
'type'
|
|
118
|
+
]
|
|
119
|
+
}
|
|
120
|
+
]
|
|
121
|
+
},
|
|
122
|
+
posts: {
|
|
123
|
+
type: 'object',
|
|
124
|
+
additionalProperties: false,
|
|
125
|
+
properties: {
|
|
126
|
+
id: {
|
|
127
|
+
type: 'string'
|
|
128
|
+
},
|
|
129
|
+
title: {
|
|
130
|
+
type: 'string'
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
properties: {
|
|
136
|
+
// `id` is dropped - it's a Payload-managed field MCP clients never set.
|
|
137
|
+
content: {
|
|
138
|
+
type: 'object',
|
|
139
|
+
properties: {
|
|
140
|
+
root: {
|
|
141
|
+
type: 'object',
|
|
142
|
+
properties: {
|
|
143
|
+
children: {
|
|
144
|
+
type: 'array',
|
|
145
|
+
items: {
|
|
146
|
+
$ref: '#/$defs/node'
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
});
|
|
155
|
+
});
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
//# sourceMappingURL=sanitizeEntitySchema.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/utils/schemaConversion/sanitizeEntitySchema.spec.ts"],"sourcesContent":["import { describe, expect, it } from 'vitest'\n\nimport type { JsonSchemaType } from '../../types.js'\n\nimport { sanitizeEntitySchema } from './sanitizeEntitySchema.js'\n\ndescribe('sanitizeEntitySchema', () => {\n it('keeps a Lexical node union strict (oneOf) while simplifying relationship values to IDs', () => {\n // Shaped like the schema the MCP server prepares for a collection with a Lexical richText field:\n // a `$defs` node union (a `oneOf` of node shapes) where a relationship node's `value` is either\n // an ID or a `$ref` to the populated related collection.\n const standalone: JsonSchemaType = {\n type: 'object',\n $defs: {\n LexicalNodes_ABCDEF12: {\n oneOf: [\n {\n type: 'object',\n additionalProperties: false,\n properties: { type: { const: 'paragraph' } },\n required: ['type'],\n },\n {\n type: 'object',\n additionalProperties: false,\n properties: {\n type: { const: 'relationship' },\n value: { oneOf: [{ type: 'string' }, { $ref: '#/$defs/posts' }] },\n },\n required: ['type'],\n },\n ],\n },\n posts: {\n type: 'object',\n additionalProperties: false,\n properties: { id: { type: 'string' }, title: { type: 'string' } },\n },\n },\n properties: {\n id: { type: 'string' },\n content: {\n type: 'object',\n properties: {\n root: {\n type: 'object',\n properties: {\n children: { type: 'array', items: { $ref: '#/$defs/LexicalNodes_ABCDEF12' } },\n },\n },\n },\n },\n },\n }\n\n expect(sanitizeEntitySchema(standalone)).toStrictEqual({\n type: 'object',\n $defs: {\n // The node union is renamed to a short, readable `node`, and stays a strict discriminated\n // `oneOf` - not loosened to `anyOf`...\n node: {\n oneOf: [\n {\n type: 'object',\n additionalProperties: false,\n properties: { type: { const: 'paragraph' } },\n required: ['type'],\n },\n {\n type: 'object',\n additionalProperties: false,\n properties: {\n type: { const: 'relationship' },\n // ...while the relationship `value` is simplified to a bare ID (the populated-doc `$ref` is dropped).\n value: { type: 'string', description: 'The ID of the related \"posts\" document.' },\n },\n required: ['type'],\n },\n ],\n },\n posts: {\n type: 'object',\n additionalProperties: false,\n properties: { id: { type: 'string' }, title: { type: 'string' } },\n },\n },\n properties: {\n // `id` is dropped - it's a Payload-managed field MCP clients never set.\n content: {\n type: 'object',\n properties: {\n root: {\n type: 'object',\n properties: {\n children: { type: 'array', items: { $ref: '#/$defs/node' } },\n },\n },\n },\n },\n },\n })\n })\n})\n"],"names":["describe","expect","it","sanitizeEntitySchema","standalone","type","$defs","LexicalNodes_ABCDEF12","oneOf","additionalProperties","properties","const","required","value","$ref","posts","id","title","content","root","children","items","toStrictEqual","node","description"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAI7C,SAASC,oBAAoB,QAAQ,4BAA2B;AAEhEH,SAAS,wBAAwB;IAC/BE,GAAG,0FAA0F;QAC3F,iGAAiG;QACjG,gGAAgG;QAChG,yDAAyD;QACzD,MAAME,aAA6B;YACjCC,MAAM;YACNC,OAAO;gBACLC,uBAAuB;oBACrBC,OAAO;wBACL;4BACEH,MAAM;4BACNI,sBAAsB;4BACtBC,YAAY;gCAAEL,MAAM;oCAAEM,OAAO;gCAAY;4BAAE;4BAC3CC,UAAU;gCAAC;6BAAO;wBACpB;wBACA;4BACEP,MAAM;4BACNI,sBAAsB;4BACtBC,YAAY;gCACVL,MAAM;oCAAEM,OAAO;gCAAe;gCAC9BE,OAAO;oCAAEL,OAAO;wCAAC;4CAAEH,MAAM;wCAAS;wCAAG;4CAAES,MAAM;wCAAgB;qCAAE;gCAAC;4BAClE;4BACAF,UAAU;gCAAC;6BAAO;wBACpB;qBACD;gBACH;gBACAG,OAAO;oBACLV,MAAM;oBACNI,sBAAsB;oBACtBC,YAAY;wBAAEM,IAAI;4BAAEX,MAAM;wBAAS;wBAAGY,OAAO;4BAAEZ,MAAM;wBAAS;oBAAE;gBAClE;YACF;YACAK,YAAY;gBACVM,IAAI;oBAAEX,MAAM;gBAAS;gBACrBa,SAAS;oBACPb,MAAM;oBACNK,YAAY;wBACVS,MAAM;4BACJd,MAAM;4BACNK,YAAY;gCACVU,UAAU;oCAAEf,MAAM;oCAASgB,OAAO;wCAAEP,MAAM;oCAAgC;gCAAE;4BAC9E;wBACF;oBACF;gBACF;YACF;QACF;QAEAb,OAAOE,qBAAqBC,aAAakB,aAAa,CAAC;YACrDjB,MAAM;YACNC,OAAO;gBACL,0FAA0F;gBAC1F,uCAAuC;gBACvCiB,MAAM;oBACJf,OAAO;wBACL;4BACEH,MAAM;4BACNI,sBAAsB;4BACtBC,YAAY;gCAAEL,MAAM;oCAAEM,OAAO;gCAAY;4BAAE;4BAC3CC,UAAU;gCAAC;6BAAO;wBACpB;wBACA;4BACEP,MAAM;4BACNI,sBAAsB;4BACtBC,YAAY;gCACVL,MAAM;oCAAEM,OAAO;gCAAe;gCAC9B,sGAAsG;gCACtGE,OAAO;oCAAER,MAAM;oCAAUmB,aAAa;gCAA0C;4BAClF;4BACAZ,UAAU;gCAAC;6BAAO;wBACpB;qBACD;gBACH;gBACAG,OAAO;oBACLV,MAAM;oBACNI,sBAAsB;oBACtBC,YAAY;wBAAEM,IAAI;4BAAEX,MAAM;wBAAS;wBAAGY,OAAO;4BAAEZ,MAAM;wBAAS;oBAAE;gBAClE;YACF;YACAK,YAAY;gBACV,wEAAwE;gBACxEQ,SAAS;oBACPb,MAAM;oBACNK,YAAY;wBACVS,MAAM;4BACJd,MAAM;4BACNK,YAAY;gCACVU,UAAU;oCAAEf,MAAM;oCAASgB,OAAO;wCAAEP,MAAM;oCAAe;gCAAE;4BAC7D;wBACF;oBACF;gBACF;YACF;QACF;IACF;AACF"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { Where } from 'payload';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
/**
|
|
4
|
+
* - Validates the `where` input of collection tools against Payload's `Where` shape
|
|
5
|
+
* - Field keys map to operator objects restricted to `validOperators`
|
|
6
|
+
* - `and` / `or` nest recursively
|
|
7
|
+
*/
|
|
8
|
+
export declare const whereSchema: z.ZodType<Where>;
|
|
9
|
+
//# sourceMappingURL=whereSchema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"whereSchema.d.ts","sourceRoot":"","sources":["../../src/utils/whereSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAGpC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CASqD,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { validOperators } from 'payload/shared';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
const whereFieldSchema = z.partialRecord(z.enum(validOperators), z.unknown()).describe('Field query operators');
|
|
4
|
+
/**
|
|
5
|
+
* - Validates the `where` input of collection tools against Payload's `Where` shape
|
|
6
|
+
* - Field keys map to operator objects restricted to `validOperators`
|
|
7
|
+
* - `and` / `or` nest recursively
|
|
8
|
+
*/ export const whereSchema = z.lazy(()=>z.object({
|
|
9
|
+
and: z.array(whereSchema).optional(),
|
|
10
|
+
or: z.array(whereSchema).optional()
|
|
11
|
+
}).catchall(whereFieldSchema)).describe('Where clause using field names with Payload query operators, plus and/or groups');
|
|
12
|
+
|
|
13
|
+
//# sourceMappingURL=whereSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/utils/whereSchema.ts"],"sourcesContent":["import type { Where } from 'payload'\n\nimport { validOperators } from 'payload/shared'\nimport { z } from 'zod'\n\nconst whereFieldSchema = z\n .partialRecord(z.enum(validOperators), z.unknown())\n .describe('Field query operators')\n\n/**\n * - Validates the `where` input of collection tools against Payload's `Where` shape\n * - Field keys map to operator objects restricted to `validOperators`\n * - `and` / `or` nest recursively\n */\nexport const whereSchema: z.ZodType<Where> = z\n .lazy(() =>\n z\n .object({\n and: z.array(whereSchema).optional(),\n or: z.array(whereSchema).optional(),\n })\n .catchall(whereFieldSchema),\n )\n .describe('Where clause using field names with Payload query operators, plus and/or groups')\n"],"names":["validOperators","z","whereFieldSchema","partialRecord","enum","unknown","describe","whereSchema","lazy","object","and","array","optional","or","catchall"],"mappings":"AAEA,SAASA,cAAc,QAAQ,iBAAgB;AAC/C,SAASC,CAAC,QAAQ,MAAK;AAEvB,MAAMC,mBAAmBD,EACtBE,aAAa,CAACF,EAAEG,IAAI,CAACJ,iBAAiBC,EAAEI,OAAO,IAC/CC,QAAQ,CAAC;AAEZ;;;;CAIC,GACD,OAAO,MAAMC,cAAgCN,EAC1CO,IAAI,CAAC,IACJP,EACGQ,MAAM,CAAC;QACNC,KAAKT,EAAEU,KAAK,CAACJ,aAAaK,QAAQ;QAClCC,IAAIZ,EAAEU,KAAK,CAACJ,aAAaK,QAAQ;IACnC,GACCE,QAAQ,CAACZ,mBAEbI,QAAQ,CAAC,mFAAkF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/plugin-mcp",
|
|
3
|
-
"version": "4.0.0-canary.
|
|
3
|
+
"version": "4.0.0-canary.2",
|
|
4
4
|
"description": "MCP (Model Context Protocol) capabilities with Payload",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"plugin",
|
|
@@ -56,19 +56,20 @@
|
|
|
56
56
|
"@cfworker/json-schema": "^4.1.1",
|
|
57
57
|
"@modelcontextprotocol/server": "2.0.0-alpha.2",
|
|
58
58
|
"tsx": "4.22.4",
|
|
59
|
-
"zod": "^4.0.0"
|
|
59
|
+
"zod": "^4.0.0",
|
|
60
|
+
"@payloadcms/translations": "4.0.0-canary.2"
|
|
60
61
|
},
|
|
61
62
|
"devDependencies": {
|
|
62
63
|
"@types/react": "19.2.14",
|
|
63
64
|
"react": "^19.0.1 || ^19.1.2 || ^19.2.1",
|
|
64
65
|
"@payloadcms/eslint-config": "3.28.0",
|
|
65
|
-
"payload": "4.0.0-canary.
|
|
66
|
-
"@payloadcms/ui": "4.0.0-canary.
|
|
66
|
+
"payload": "4.0.0-canary.2",
|
|
67
|
+
"@payloadcms/ui": "4.0.0-canary.2"
|
|
67
68
|
},
|
|
68
69
|
"peerDependencies": {
|
|
69
70
|
"react": "^19.0.1 || ^19.1.2 || ^19.2.1",
|
|
70
|
-
"@payloadcms/ui": "4.0.0-canary.
|
|
71
|
-
"payload": "4.0.0-canary.
|
|
71
|
+
"@payloadcms/ui": "4.0.0-canary.2",
|
|
72
|
+
"payload": "4.0.0-canary.2"
|
|
72
73
|
},
|
|
73
74
|
"//deps_notes": {
|
|
74
75
|
"zod": "zod is a hard dependency of @modelcontextprotocol/server, thus we can safely use it without it impacting bundle size. Make extra sure the zod version here matches exactly what's defined in the dependencies of @modelcontextprotocol/server to avoid duplicate versions being installed.",
|
|
@@ -2,6 +2,12 @@ import type { JSONField } from 'payload'
|
|
|
2
2
|
|
|
3
3
|
import type { ClientMCPPluginConfig, MCPItem, SanitizedMCPPluginConfig } from '../types.js'
|
|
4
4
|
|
|
5
|
+
import {
|
|
6
|
+
COLLECTION_AUTH_BUILTINS,
|
|
7
|
+
COLLECTION_BUILTINS,
|
|
8
|
+
GLOBAL_BUILTINS,
|
|
9
|
+
} from '../mcp/builtinTools.js'
|
|
10
|
+
|
|
5
11
|
/**
|
|
6
12
|
* Returns the API key collection's `access` field — a JSON field whose value
|
|
7
13
|
* is the `MCPAPIKeysDocAccessTree` the endpoint consults. The actual UI is
|
|
@@ -25,13 +31,9 @@ export const getAccessField = ({
|
|
|
25
31
|
path: '@payloadcms/plugin-mcp/client#AccessField',
|
|
26
32
|
},
|
|
27
33
|
},
|
|
28
|
-
// TODO: needs i18n once design is finalized
|
|
29
|
-
description: 'Access for this API key — uncheck to revoke individual tools.',
|
|
30
|
-
position: 'sidebar',
|
|
31
34
|
},
|
|
32
35
|
defaultValue: {},
|
|
33
|
-
|
|
34
|
-
label: 'Access',
|
|
36
|
+
label: false,
|
|
35
37
|
}
|
|
36
38
|
}
|
|
37
39
|
|
|
@@ -43,14 +45,19 @@ export const getAccessField = ({
|
|
|
43
45
|
const sanitizeClientPluginConfig = (
|
|
44
46
|
pluginConfig: SanitizedMCPPluginConfig,
|
|
45
47
|
): ClientMCPPluginConfig => ({
|
|
46
|
-
items: pluginConfig.items.map((item) =>
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
48
|
+
items: pluginConfig.items.map((item) => {
|
|
49
|
+
const group = itemGroup(item)
|
|
50
|
+
|
|
51
|
+
return {
|
|
52
|
+
...(item.type === 'collectionTool' ? { collectionSlug: item.collectionSlug } : {}),
|
|
53
|
+
...(item.type === 'globalTool' ? { globalSlug: item.globalSlug } : {}),
|
|
54
|
+
type: item.type,
|
|
55
|
+
configKey: item.configKey,
|
|
56
|
+
...(group === 'operations' ? {} : { description: itemDescription(item) }),
|
|
57
|
+
group,
|
|
58
|
+
label: item.label,
|
|
59
|
+
}
|
|
60
|
+
}),
|
|
54
61
|
})
|
|
55
62
|
|
|
56
63
|
const itemDescription = (item: MCPItem): string => {
|
|
@@ -62,3 +69,16 @@ const itemDescription = (item: MCPItem): string => {
|
|
|
62
69
|
}
|
|
63
70
|
return item.tool.description
|
|
64
71
|
}
|
|
72
|
+
|
|
73
|
+
const itemGroup = (item: MCPItem): 'auth' | 'custom' | 'operations' | undefined => {
|
|
74
|
+
if (item.type === 'collectionTool') {
|
|
75
|
+
if (item.configKey in COLLECTION_BUILTINS) {
|
|
76
|
+
return 'operations'
|
|
77
|
+
}
|
|
78
|
+
return item.configKey in COLLECTION_AUTH_BUILTINS ? 'auth' : 'custom'
|
|
79
|
+
}
|
|
80
|
+
if (item.type === 'globalTool') {
|
|
81
|
+
return item.configKey in GLOBAL_BUILTINS ? 'operations' : 'custom'
|
|
82
|
+
}
|
|
83
|
+
return undefined
|
|
84
|
+
}
|
package/src/collection/index.ts
CHANGED
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
import type { CollectionConfig } from 'payload'
|
|
2
2
|
|
|
3
|
+
import { createAPIKeyFields } from 'payload'
|
|
4
|
+
|
|
3
5
|
import type { SanitizedMCPPluginConfig } from '../types.js'
|
|
4
6
|
|
|
5
7
|
import { getAccessField } from './getAccessField.js'
|
|
6
8
|
|
|
9
|
+
const apiKeyStorageFields = createAPIKeyFields({
|
|
10
|
+
apiKeyField: {
|
|
11
|
+
admin: {
|
|
12
|
+
components: { Field: '@payloadcms/plugin-mcp/client#APIKeyField' },
|
|
13
|
+
},
|
|
14
|
+
required: true,
|
|
15
|
+
},
|
|
16
|
+
apiKeyIndexField: {
|
|
17
|
+
index: true,
|
|
18
|
+
required: true,
|
|
19
|
+
},
|
|
20
|
+
includeEnableAPIKey: false,
|
|
21
|
+
})
|
|
22
|
+
|
|
7
23
|
export const getAPIKeysCollection = ({
|
|
8
24
|
pluginConfig,
|
|
9
25
|
}: {
|
|
@@ -12,49 +28,75 @@ export const getAPIKeysCollection = ({
|
|
|
12
28
|
const collection: CollectionConfig = {
|
|
13
29
|
slug: 'payload-mcp-api-keys',
|
|
14
30
|
admin: {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
31
|
+
components: {
|
|
32
|
+
views: {
|
|
33
|
+
list: {
|
|
34
|
+
NoResults: '@payloadcms/plugin-mcp/client#APIKeysEmptyState',
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
defaultColumns: ['label', 'lastUsed', 'user'],
|
|
39
|
+
// Kept out of the main nav — reachable through the user menu's settings instead.
|
|
40
|
+
group: false,
|
|
18
41
|
useAsTitle: 'label',
|
|
19
42
|
},
|
|
20
|
-
auth: {
|
|
21
|
-
disableLocalStrategy: true,
|
|
22
|
-
useAPIKey: true,
|
|
23
|
-
},
|
|
24
43
|
fields: [
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
type: 'relationship',
|
|
28
|
-
admin: { description: 'The user that the API key is associated with.' },
|
|
29
|
-
relationTo: pluginConfig.userCollection,
|
|
30
|
-
required: true,
|
|
31
|
-
},
|
|
44
|
+
...apiKeyStorageFields,
|
|
45
|
+
getAccessField({ pluginConfig }),
|
|
32
46
|
{
|
|
33
47
|
name: 'label',
|
|
34
48
|
type: 'text',
|
|
35
|
-
admin: {
|
|
49
|
+
admin: {
|
|
50
|
+
description: ({ t }) => t('plugin-mcp:titleDescription'),
|
|
51
|
+
position: 'sidebar',
|
|
52
|
+
},
|
|
53
|
+
label: ({ t }) => t('plugin-mcp:title'),
|
|
36
54
|
},
|
|
37
55
|
{
|
|
38
56
|
name: 'description',
|
|
39
57
|
type: 'text',
|
|
40
|
-
admin: {
|
|
58
|
+
admin: {
|
|
59
|
+
description: ({ t }) => t('plugin-mcp:descriptionDescription'),
|
|
60
|
+
position: 'sidebar',
|
|
61
|
+
},
|
|
62
|
+
label: ({ t }) => t('plugin-mcp:description'),
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
name: 'lastUsed',
|
|
66
|
+
type: 'date',
|
|
67
|
+
admin: {
|
|
68
|
+
date: { pickerAppearance: 'dayAndTime' },
|
|
69
|
+
disabled: { field: true },
|
|
70
|
+
},
|
|
71
|
+
label: ({ t }) => t('plugin-mcp:lastUsed'),
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
name: 'user',
|
|
75
|
+
type: 'relationship',
|
|
76
|
+
admin: {
|
|
77
|
+
description: ({ t }) => t('plugin-mcp:userDescription'),
|
|
78
|
+
position: 'sidebar',
|
|
79
|
+
},
|
|
80
|
+
label: ({ t }) => t('general:user'),
|
|
81
|
+
relationTo: pluginConfig.userCollection,
|
|
82
|
+
required: true,
|
|
41
83
|
},
|
|
42
84
|
{
|
|
43
85
|
name: 'overrideAccess',
|
|
44
86
|
type: 'checkbox',
|
|
45
87
|
admin: {
|
|
46
|
-
description:
|
|
47
|
-
|
|
88
|
+
description: ({ t }) => t('plugin-mcp:overrideAccessDescription'),
|
|
89
|
+
position: 'sidebar',
|
|
48
90
|
},
|
|
49
91
|
defaultValue: false,
|
|
50
|
-
label:
|
|
92
|
+
label: ({ t }) => t('plugin-mcp:overrideAccess'),
|
|
51
93
|
},
|
|
52
|
-
getAccessField({ pluginConfig }),
|
|
53
94
|
],
|
|
54
95
|
labels: {
|
|
55
|
-
plural: '
|
|
56
|
-
singular: '
|
|
96
|
+
plural: ({ t }) => `${t('plugin-mcp:mcp')} ${t('plugin-mcp:apiKeys')}`,
|
|
97
|
+
singular: ({ t }) => `${t('plugin-mcp:mcp')} ${t('authentication:apiKey')}`,
|
|
57
98
|
},
|
|
99
|
+
versions: false,
|
|
58
100
|
}
|
|
59
101
|
|
|
60
102
|
return pluginConfig.overrideApiKeyCollection
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
'use client'
|
|
2
|
+
|
|
3
|
+
import { APIKeyInput, Button, useField, useTranslation, WarningTriangleIcon } from '@payloadcms/ui'
|
|
4
|
+
import React, { useState } from 'react'
|
|
5
|
+
|
|
6
|
+
import type {
|
|
7
|
+
PluginMCPTranslationKeys,
|
|
8
|
+
PluginMCPTranslations,
|
|
9
|
+
} from '../../translations/index.js'
|
|
10
|
+
|
|
11
|
+
import './index.css'
|
|
12
|
+
|
|
13
|
+
const baseClass = 'mcp-api-key-field'
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Custom component for the MCP API-keys collection's `apiKey` field:
|
|
17
|
+
* - no key yet: a "Generate new key" button
|
|
18
|
+
* - key set: a dismissible privacy warning + the shared masked-key input
|
|
19
|
+
*/
|
|
20
|
+
export const APIKeyField: React.FC = () => {
|
|
21
|
+
const { setValue: setApiKey, value: apiKey } = useField<string>({ path: 'apiKey' })
|
|
22
|
+
const { t } = useTranslation<PluginMCPTranslations, PluginMCPTranslationKeys>()
|
|
23
|
+
const [isWarningDismissed, setIsWarningDismissed] = useState(false)
|
|
24
|
+
|
|
25
|
+
const generateKey = () => {
|
|
26
|
+
setApiKey(crypto.randomUUID())
|
|
27
|
+
setIsWarningDismissed(false)
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
return (
|
|
31
|
+
<div className={baseClass}>
|
|
32
|
+
<p className={`${baseClass}__description`}>
|
|
33
|
+
{t('plugin-mcp:apiKeyDescription')}
|
|
34
|
+
</p>
|
|
35
|
+
<div className={`${baseClass}__panel`}>
|
|
36
|
+
<div className={`${baseClass}__header`}>
|
|
37
|
+
<span className={`${baseClass}__title`}>{t('authentication:apiKey')}</span>
|
|
38
|
+
{!apiKey && (
|
|
39
|
+
<Button
|
|
40
|
+
buttonStyle="primary"
|
|
41
|
+
className={`${baseClass}__generate`}
|
|
42
|
+
onClick={generateKey}
|
|
43
|
+
>
|
|
44
|
+
{t('authentication:generateNewAPIKey')}
|
|
45
|
+
</Button>
|
|
46
|
+
)}
|
|
47
|
+
</div>
|
|
48
|
+
{Boolean(apiKey) && (
|
|
49
|
+
<div className={`${baseClass}__body`}>
|
|
50
|
+
{!isWarningDismissed && (
|
|
51
|
+
<div className={`${baseClass}__warning`}>
|
|
52
|
+
<WarningTriangleIcon className={`${baseClass}__warning-icon`} />
|
|
53
|
+
<p className={`${baseClass}__warning-text`}>
|
|
54
|
+
<strong>{t('plugin-mcp:keepKeyPrivate')}</strong>
|
|
55
|
+
{` ${t('plugin-mcp:keyPrivateDescription')}`}
|
|
56
|
+
</p>
|
|
57
|
+
<button
|
|
58
|
+
aria-label={t('plugin-mcp:dismiss')}
|
|
59
|
+
className={`${baseClass}__warning-dismiss`}
|
|
60
|
+
onClick={() => setIsWarningDismissed(true)}
|
|
61
|
+
type="button"
|
|
62
|
+
>
|
|
63
|
+
×
|
|
64
|
+
</button>
|
|
65
|
+
</div>
|
|
66
|
+
)}
|
|
67
|
+
<APIKeyInput aria-label={t('authentication:apiKey')} value={apiKey} />
|
|
68
|
+
</div>
|
|
69
|
+
)}
|
|
70
|
+
</div>
|
|
71
|
+
</div>
|
|
72
|
+
)
|
|
73
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
@layer payload-default {
|
|
2
|
+
/* Section wrapper: description + panel, closed off by a full-bleed divider
|
|
3
|
+
that spans the fields column past its horizontal gutter. */
|
|
4
|
+
.mcp-api-key-field {
|
|
5
|
+
display: flex;
|
|
6
|
+
flex-direction: column;
|
|
7
|
+
gap: var(--base);
|
|
8
|
+
margin-inline: calc(-1 * var(--gutter-h));
|
|
9
|
+
padding-inline: var(--gutter-h);
|
|
10
|
+
padding-block-end: var(--spacer-4);
|
|
11
|
+
border-block-end: var(--stroke-width-small) solid var(--color-border);
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
.mcp-api-key-field__description {
|
|
15
|
+
margin: 0;
|
|
16
|
+
color: var(--color-text);
|
|
17
|
+
font-family: var(--text-body-medium-font-family);
|
|
18
|
+
font-size: var(--text-body-medium-font-size);
|
|
19
|
+
font-weight: var(--text-body-medium-font-weight);
|
|
20
|
+
line-height: var(--text-body-medium-line-height);
|
|
21
|
+
letter-spacing: var(--text-body-medium-letter-spacing);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.mcp-api-key-field__panel {
|
|
25
|
+
overflow: hidden;
|
|
26
|
+
background: var(--color-bg);
|
|
27
|
+
border: var(--stroke-width-small) solid var(--color-border);
|
|
28
|
+
border-radius: var(--button-radius);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
.mcp-api-key-field__header {
|
|
32
|
+
display: flex;
|
|
33
|
+
align-items: center;
|
|
34
|
+
justify-content: space-between;
|
|
35
|
+
gap: var(--spacer-2);
|
|
36
|
+
min-height: var(--spacer-5);
|
|
37
|
+
padding: var(--spacer-2) var(--spacer-3);
|
|
38
|
+
background: var(--color-bg-secondary);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/* Holds the warning + key row; its top border is the full-width divider
|
|
42
|
+
under the header. Only rendered once a key exists. */
|
|
43
|
+
.mcp-api-key-field__body {
|
|
44
|
+
display: flex;
|
|
45
|
+
flex-direction: column;
|
|
46
|
+
gap: var(--spacer-2);
|
|
47
|
+
padding: var(--spacer-3);
|
|
48
|
+
border-block-start: var(--stroke-width-small) solid var(--color-border);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
.mcp-api-key-field__title {
|
|
52
|
+
color: var(--color-text);
|
|
53
|
+
font-family: var(--text-body-medium-strong-font-family);
|
|
54
|
+
font-size: var(--text-body-medium-strong-font-size);
|
|
55
|
+
font-weight: var(--text-body-medium-strong-font-weight);
|
|
56
|
+
line-height: var(--text-body-medium-strong-line-height);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
.mcp-api-key-field__generate {
|
|
60
|
+
margin: 0;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/* Matches the core Banner's warning treatment: theme-adaptive warning-tertiary
|
|
64
|
+
bg with regular --color-text (NOT --color-text-onwarning, which is only
|
|
65
|
+
defined for light mode and reads as muddy dark-on-dark in dark mode). */
|
|
66
|
+
.mcp-api-key-field__warning {
|
|
67
|
+
display: flex;
|
|
68
|
+
align-items: center;
|
|
69
|
+
gap: calc(var(--base) / 2);
|
|
70
|
+
padding: calc(var(--spacer-2) + (var(--spacer-1) / 2)) calc(var(--base) / 2);
|
|
71
|
+
background: var(--color-bg-warning-tertiary);
|
|
72
|
+
border: none;
|
|
73
|
+
border-radius: var(--radius-medium);
|
|
74
|
+
color: var(--color-text);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
.mcp-api-key-field__warning-icon {
|
|
78
|
+
flex-shrink: 0;
|
|
79
|
+
width: 15px;
|
|
80
|
+
height: 13px;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
.mcp-api-key-field__warning-text {
|
|
84
|
+
flex-grow: 1;
|
|
85
|
+
margin: 0;
|
|
86
|
+
font-family: var(--text-body-medium-font-family);
|
|
87
|
+
font-size: var(--text-body-medium-font-size);
|
|
88
|
+
line-height: var(--text-body-medium-line-height);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
.mcp-api-key-field__warning-text strong {
|
|
92
|
+
font-weight: var(--text-body-medium-strong-font-weight);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
.mcp-api-key-field__warning-dismiss {
|
|
96
|
+
appearance: none;
|
|
97
|
+
background: none;
|
|
98
|
+
border: none;
|
|
99
|
+
cursor: pointer;
|
|
100
|
+
color: inherit;
|
|
101
|
+
font-size: 1rem;
|
|
102
|
+
line-height: 1;
|
|
103
|
+
padding: 0;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
'use client'
|
|
2
|
+
|
|
3
|
+
import type { NoResultsClientProps } from 'payload'
|
|
4
|
+
|
|
5
|
+
import { Button, NoListResults, useTranslation } from '@payloadcms/ui'
|
|
6
|
+
import React from 'react'
|
|
7
|
+
|
|
8
|
+
import type {
|
|
9
|
+
PluginMCPTranslationKeys,
|
|
10
|
+
PluginMCPTranslations,
|
|
11
|
+
} from '../../translations/index.js'
|
|
12
|
+
|
|
13
|
+
export const APIKeysEmptyState: React.FC<NoResultsClientProps> = ({
|
|
14
|
+
hasCreatePermission,
|
|
15
|
+
newDocumentURL,
|
|
16
|
+
viewType,
|
|
17
|
+
}) => {
|
|
18
|
+
const { t } = useTranslation<PluginMCPTranslations, PluginMCPTranslationKeys>()
|
|
19
|
+
|
|
20
|
+
return (
|
|
21
|
+
<NoListResults
|
|
22
|
+
Actions={
|
|
23
|
+
hasCreatePermission && newDocumentURL && viewType !== 'trash'
|
|
24
|
+
? [
|
|
25
|
+
<Button el="link" key="create" to={newDocumentURL}>
|
|
26
|
+
{t('authentication:generateNewAPIKey')}
|
|
27
|
+
</Button>,
|
|
28
|
+
]
|
|
29
|
+
: []
|
|
30
|
+
}
|
|
31
|
+
description={t('plugin-mcp:apiKeyDescription')}
|
|
32
|
+
title={t('plugin-mcp:noAPIKeys')}
|
|
33
|
+
withMargin
|
|
34
|
+
/>
|
|
35
|
+
)
|
|
36
|
+
}
|