@payloadcms/plugin-mcp 4.0.0-internal.d28e9fb → 4.0.0-internal.d927017

package/dist/index.js

@@ -1,76 +1,48 @@
 import { definePlugin } from 'payload';
-import { createAPIKeysCollection } from './collections/createApiKeysCollection.js';
-import { initializeMCPHandler } from './endpoints/mcp.js';
-import { defaults } from './defaults.js';
-/**
- * The MCP Plugin for Payload. This plugin allows you to add MCP capabilities to your Payload project.
- *
- * @param pluginOptions - The options for the MCP plugin.
- */ export const mcpPlugin = definePlugin({
+import { mcpEndpoint } from './endpoint/index.js';
+import { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js';
+export { defineCollectionTool, defineGlobalTool, definePrompt, defineTool } from './defineTool.js';
+export const mcpPlugin = definePlugin({
     slug: '@payloadcms/plugin-mcp',
     order: 10,
-    plugin: ({ config, plugins: _plugins, ...pluginOptions })=>{
-        if (!config.collections) {
-            config.collections = [];
-        }
-        // Collections
-        const collections = pluginOptions.collections || {};
-        // Globals
-        const globals = pluginOptions.globals || {};
-        // Extract custom tools for the global config
-        const customTools = pluginOptions.mcp?.tools?.map((tool)=>({
-                name: tool.name,
-                description: tool.description
-            })) || [];
-        // User Collection
-        pluginOptions.userCollection = pluginOptions.userCollection ?? config?.admin?.user ?? defaults.userCollection;
-        const experimentalTools = pluginOptions?.experimental?.tools || {};
-        /**
-     * API Keys
-     * --------
-     * High resolution control over MCP capabilities is crucial when using Payload with LLMs.
-     *
-     * This API Keys collection has ways for admins to create API keys and allow or disallow the MCP capabilities.
-     * This is useful when Admins want to allow or disallow the use of the MCP capabilities in real time.
-     * For example:
-     *  - If a collection has all of its capabilities enabled, admins can allow or disallow the create, update, delete, and find capabilities on that collection.
-     *  - If a collection only has the find capability enabled, admins can only allow or disallow the find capability on that collection.
-     *  - If a global has all of its capabilities enabled, admins can allow or disallow the find and update capabilities on that global.
-     *  - If a custom tool has gone haywire, admins can disallow that tool.
-     *
-     */ const apiKeyCollection = createAPIKeysCollection(collections, globals, customTools, experimentalTools, pluginOptions);
-        if (pluginOptions.overrideApiKeyCollection) {
-            config.collections.push(pluginOptions.overrideApiKeyCollection(apiKeyCollection));
-        } else {
-            config.collections.push(apiKeyCollection);
+    plugin: ({ config, options, plugins })=>{
+        const pluginConfig = sanitizeMCPConfig({
+            config,
+            pluginConfig: options
+        });
+        // Stash the sanitized config on plugin options so `getPluginConfig()` reads it.
+        const registered = plugins['@payloadcms/plugin-mcp'];
+        if (registered) {
+            // @ts-expect-error
+            registered.sanitizedOptions = pluginConfig;
         }
-        /**
-     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.
-     * If your plugin heavily modifies the database schema, you may want to remove this property.
-     */ if (pluginOptions.disabled) {
+        if (pluginConfig.disabled) {
             return config;
         }
-        if (!config.endpoints) {
-            config.endpoints = [];
-        }
-        /**
-     * This is the primary MCP Server Endpoint.
-     * Payload will automatically add the /api prefix to the path, so the full path is `/api/mcp`
-     * NOTE: This is only transport method until we add full support for SSE which will be another endpoint at `/api/sse`
-     */ config.endpoints.push({
-            handler: initializeMCPHandler(pluginOptions),
-            method: 'post',
-            path: '/mcp'
-        });
-        /**
-     * The GET response is always: {"jsonrpc":"2.0","error":{"code":-32000,"message":"Method not allowed."},"id":null} -- even with an API key
-     * This is expected behavior and MCP clients should always use the POST endpoint.
-     */ config.endpoints.push({
-            handler: initializeMCPHandler(pluginOptions),
-            method: 'get',
-            path: '/mcp'
-        });
-        return config;
+        return {
+            ...config,
+            endpoints: [
+                ...config.endpoints ?? [],
+                // Payload prefixes /api, so the full path is /api/mcp.
+                {
+                    handler: mcpEndpoint,
+                    method: 'post',
+                    path: '/mcp'
+                },
+                // Streamable HTTP's optional server=>client GET stream. We don't offer
+                // one, so answer 405 per spec-— clients then skip it cleanly
+                {
+                    handler: ()=>new Response(null, {
+                            headers: {
+                                Allow: 'POST'
+                            },
+                            status: 405
+                        }),
+                    method: 'get',
+                    path: '/mcp'
+                }
+            ]
+        };
     }
 });
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { definePlugin } from 'payload'\n\nimport type { MCPAccessSettings, MCPPluginConfig } from './types.js'\n\nimport { createAPIKeysCollection } from './collections/createApiKeysCollection.js'\nimport { initializeMCPHandler } from './endpoints/mcp.js'\n\ndeclare module 'payload' {\n  export interface PayloadRequest {\n    payloadAPI: 'GraphQL' | 'local' | 'MCP' | 'REST'\n  }\n  interface RegisteredPlugins {\n    '@payloadcms/plugin-mcp': MCPPluginConfig\n  }\n}\n\nimport { defaults } from './defaults.js'\n\nexport type { MCPAccessSettings, MCPPluginConfig }\n\n/**\n * The MCP Plugin for Payload. This plugin allows you to add MCP capabilities to your Payload project.\n *\n * @param pluginOptions - The options for the MCP plugin.\n */\nexport const mcpPlugin = definePlugin<MCPPluginConfig>({\n  slug: '@payloadcms/plugin-mcp',\n  order: 10,\n  plugin: ({ config, plugins: _plugins, ...pluginOptions }) => {\n    if (!config.collections) {\n      config.collections = []\n    }\n\n    // Collections\n    const collections = pluginOptions.collections || {}\n    // Globals\n    const globals = pluginOptions.globals || {}\n    // Extract custom tools for the global config\n    const customTools =\n      pluginOptions.mcp?.tools?.map((tool) => ({\n        name: tool.name,\n        description: tool.description,\n      })) || []\n\n    // User Collection\n    pluginOptions.userCollection =\n      pluginOptions.userCollection ?? config?.admin?.user ?? defaults.userCollection\n\n    const experimentalTools = pluginOptions?.experimental?.tools || {}\n\n    /**\n     * API Keys\n     * --------\n     * High resolution control over MCP capabilities is crucial when using Payload with LLMs.\n     *\n     * This API Keys collection has ways for admins to create API keys and allow or disallow the MCP capabilities.\n     * This is useful when Admins want to allow or disallow the use of the MCP capabilities in real time.\n     * For example:\n     *  - If a collection has all of its capabilities enabled, admins can allow or disallow the create, update, delete, and find capabilities on that collection.\n     *  - If a collection only has the find capability enabled, admins can only allow or disallow the find capability on that collection.\n     *  - If a global has all of its capabilities enabled, admins can allow or disallow the find and update capabilities on that global.\n     *  - If a custom tool has gone haywire, admins can disallow that tool.\n     *\n     */\n    const apiKeyCollection = createAPIKeysCollection(\n      collections,\n      globals,\n      customTools,\n      experimentalTools,\n      pluginOptions,\n    )\n    if (pluginOptions.overrideApiKeyCollection) {\n      config.collections.push(pluginOptions.overrideApiKeyCollection(apiKeyCollection))\n    } else {\n      config.collections.push(apiKeyCollection)\n    }\n\n    /**\n     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.\n     * If your plugin heavily modifies the database schema, you may want to remove this property.\n     */\n    if (pluginOptions.disabled) {\n      return config\n    }\n\n    if (!config.endpoints) {\n      config.endpoints = []\n    }\n\n    /**\n     * This is the primary MCP Server Endpoint.\n     * Payload will automatically add the /api prefix to the path, so the full path is `/api/mcp`\n     * NOTE: This is only transport method until we add full support for SSE which will be another endpoint at `/api/sse`\n     */\n    config.endpoints.push({\n      handler: initializeMCPHandler(pluginOptions),\n      method: 'post',\n      path: '/mcp',\n    })\n\n    /**\n     * The GET response is always: {\"jsonrpc\":\"2.0\",\"error\":{\"code\":-32000,\"message\":\"Method not allowed.\"},\"id\":null} -- even with an API key\n     * This is expected behavior and MCP clients should always use the POST endpoint.\n     */\n    config.endpoints.push({\n      handler: initializeMCPHandler(pluginOptions),\n      method: 'get',\n      path: '/mcp',\n    })\n\n    return config\n  },\n})\n"],"names":["definePlugin","createAPIKeysCollection","initializeMCPHandler","defaults","mcpPlugin","slug","order","plugin","config","plugins","_plugins","pluginOptions","collections","globals","customTools","mcp","tools","map","tool","name","description","userCollection","admin","user","experimentalTools","experimental","apiKeyCollection","overrideApiKeyCollection","push","disabled","endpoints","handler","method","path"],"mappings":"AAAA,SAASA,YAAY,QAAQ,UAAS;AAItC,SAASC,uBAAuB,QAAQ,2CAA0C;AAClF,SAASC,oBAAoB,QAAQ,qBAAoB;AAWzD,SAASC,QAAQ,QAAQ,gBAAe;AAIxC;;;;CAIC,GACD,OAAO,MAAMC,YAAYJ,aAA8B;IACrDK,MAAM;IACNC,OAAO;IACPC,QAAQ,CAAC,EAAEC,MAAM,EAAEC,SAASC,QAAQ,EAAE,GAAGC,eAAe;QACtD,IAAI,CAACH,OAAOI,WAAW,EAAE;YACvBJ,OAAOI,WAAW,GAAG,EAAE;QACzB;QAEA,cAAc;QACd,MAAMA,cAAcD,cAAcC,WAAW,IAAI,CAAC;QAClD,UAAU;QACV,MAAMC,UAAUF,cAAcE,OAAO,IAAI,CAAC;QAC1C,6CAA6C;QAC7C,MAAMC,cACJH,cAAcI,GAAG,EAAEC,OAAOC,IAAI,CAACC,OAAU,CAAA;gBACvCC,MAAMD,KAAKC,IAAI;gBACfC,aAAaF,KAAKE,WAAW;YAC/B,CAAA,MAAO,EAAE;QAEX,kBAAkB;QAClBT,cAAcU,cAAc,GAC1BV,cAAcU,cAAc,IAAIb,QAAQc,OAAOC,QAAQpB,SAASkB,cAAc;QAEhF,MAAMG,oBAAoBb,eAAec,cAAcT,SAAS,CAAC;QAEjE;;;;;;;;;;;;;KAaC,GACD,MAAMU,mBAAmBzB,wBACvBW,aACAC,SACAC,aACAU,mBACAb;QAEF,IAAIA,cAAcgB,wBAAwB,EAAE;YAC1CnB,OAAOI,WAAW,CAACgB,IAAI,CAACjB,cAAcgB,wBAAwB,CAACD;QACjE,OAAO;YACLlB,OAAOI,WAAW,CAACgB,IAAI,CAACF;QAC1B;QAEA;;;KAGC,GACD,IAAIf,cAAckB,QAAQ,EAAE;YAC1B,OAAOrB;QACT;QAEA,IAAI,CAACA,OAAOsB,SAAS,EAAE;YACrBtB,OAAOsB,SAAS,GAAG,EAAE;QACvB;QAEA;;;;KAIC,GACDtB,OAAOsB,SAAS,CAACF,IAAI,CAAC;YACpBG,SAAS7B,qBAAqBS;YAC9BqB,QAAQ;YACRC,MAAM;QACR;QAEA;;;KAGC,GACDzB,OAAOsB,SAAS,CAACF,IAAI,CAAC;YACpBG,SAAS7B,qBAAqBS;YAC9BqB,QAAQ;YACRC,MAAM;QACR;QAEA,OAAOzB;IACT;AACF,GAAE"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { definePlugin } from 'payload'\n\nimport type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig } from './types.js'\n\nimport { mcpEndpoint } from './endpoint/index.js'\nimport { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js'\n\ndeclare module 'payload' {\n  export interface PayloadRequestAPI {\n    MCP: true\n  }\n  interface RegisteredPlugins {\n    /** After the plugin's `plugin` callback runs, `options` holds the sanitized config. */\n    '@payloadcms/plugin-mcp': MCPPluginConfig\n  }\n}\n\nexport type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig }\n\nexport { defineCollectionTool, defineGlobalTool, definePrompt, defineTool } from './defineTool.js'\n\nexport const mcpPlugin = definePlugin<MCPPluginConfig>({\n  slug: '@payloadcms/plugin-mcp',\n  order: 10,\n  plugin: ({ config, options, plugins }) => {\n    const pluginConfig = sanitizeMCPConfig({ config, pluginConfig: options })\n\n    // Stash the sanitized config on plugin options so `getPluginConfig()` reads it.\n    const registered = plugins['@payloadcms/plugin-mcp']\n    if (registered) {\n      // @ts-expect-error\n      registered.sanitizedOptions = pluginConfig as unknown as typeof registered.options\n    }\n\n    if (pluginConfig.disabled) {\n      return config\n    }\n\n    return {\n      ...config,\n      endpoints: [\n        ...(config.endpoints ?? []),\n        // Payload prefixes /api, so the full path is /api/mcp.\n        { handler: mcpEndpoint, method: 'post', path: '/mcp' },\n        // Streamable HTTP's optional server=>client GET stream. We don't offer\n        // one, so answer 405 per spec-— clients then skip it cleanly\n        {\n          handler: () => new Response(null, { headers: { Allow: 'POST' }, status: 405 }),\n          method: 'get',\n          path: '/mcp',\n        },\n      ],\n    }\n  },\n})\n"],"names":["definePlugin","mcpEndpoint","sanitizeMCPConfig","defineCollectionTool","defineGlobalTool","definePrompt","defineTool","mcpPlugin","slug","order","plugin","config","options","plugins","pluginConfig","registered","sanitizedOptions","disabled","endpoints","handler","method","path","Response","headers","Allow","status"],"mappings":"AAAA,SAASA,YAAY,QAAQ,UAAS;AAItC,SAASC,WAAW,QAAQ,sBAAqB;AACjD,SAASC,iBAAiB,QAAQ,6BAA4B;AAc9D,SAASC,oBAAoB,EAAEC,gBAAgB,EAAEC,YAAY,EAAEC,UAAU,QAAQ,kBAAiB;AAElG,OAAO,MAAMC,YAAYP,aAA8B;IACrDQ,MAAM;IACNC,OAAO;IACPC,QAAQ,CAAC,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAE;QACnC,MAAMC,eAAeZ,kBAAkB;YAAES;YAAQG,cAAcF;QAAQ;QAEvE,gFAAgF;QAChF,MAAMG,aAAaF,OAAO,CAAC,yBAAyB;QACpD,IAAIE,YAAY;YACd,mBAAmB;YACnBA,WAAWC,gBAAgB,GAAGF;QAChC;QAEA,IAAIA,aAAaG,QAAQ,EAAE;YACzB,OAAON;QACT;QAEA,OAAO;YACL,GAAGA,MAAM;YACTO,WAAW;mBACLP,OAAOO,SAAS,IAAI,EAAE;gBAC1B,uDAAuD;gBACvD;oBAAEC,SAASlB;oBAAamB,QAAQ;oBAAQC,MAAM;gBAAO;gBACrD,uEAAuE;gBACvE,6DAA6D;gBAC7D;oBACEF,SAAS,IAAM,IAAIG,SAAS,MAAM;4BAAEC,SAAS;gCAAEC,OAAO;4BAAO;4BAAGC,QAAQ;wBAAI;oBAC5EL,QAAQ;oBACRC,MAAM;gBACR;aACD;QACH;IACF;AACF,GAAE"}

package/dist/mcp/buildMcpServer.d.ts

@@ -0,0 +1,19 @@
+import { McpServer } from '@modelcontextprotocol/server';
+import { type PayloadRequest } from 'payload';
+import type { AuthorizedMCP, SanitizedMCPPluginConfig } from '../types.js';
+/**
+ * Serving-entry-agnostic core: registers every authorized MCP item onto a fresh
+ * `McpServer` and returns it. The HTTP and stdio entry point callers provide fresh
+ * instances from this builder while they own the transport and protocol-era
+ * decision.
+ *
+ * `req` is the request context handlers see. For HTTP it's the live
+ * `PayloadRequest` derived from the incoming HTTP request; for stdio it's a
+ * synthesized one built via `createLocalReq`.
+ */
+export declare const buildMcpServer: ({ authorizedMCP, pluginConfig, req, }: {
+    authorizedMCP: AuthorizedMCP;
+    pluginConfig: SanitizedMCPPluginConfig;
+    req: PayloadRequest;
+}) => McpServer;
+//# sourceMappingURL=buildMcpServer.d.ts.map

package/dist/mcp/buildMcpServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildMcpServer.d.ts","sourceRoot":"","sources":["../../src/mcp/buildMcpServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAsB,MAAM,8BAA8B,CAAA;AAC5E,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,SAAS,CAAA;AAGvD,OAAO,KAAK,EACV,aAAa,EAMb,wBAAwB,EAEzB,MAAM,aAAa,CAAA;AAKpB;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GAAI,uCAI5B;IACD,aAAa,EAAE,aAAa,CAAA;IAC5B,YAAY,EAAE,wBAAwB,CAAA;IACtC,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,SAkNH,CAAA"}

package/dist/mcp/buildMcpServer.js

@@ -0,0 +1,223 @@
+import { McpServer } from '@modelcontextprotocol/server';
+import { APIError } from 'payload';
+import { z } from 'zod';
+import { getLogger } from '../utils/getLogger.js';
+import { toStandardSchema } from '../utils/toStandardSchema.js';
+/**
+ * Serving-entry-agnostic core: registers every authorized MCP item onto a fresh
+ * `McpServer` and returns it. The HTTP and stdio entry point callers provide fresh
+ * instances from this builder while they own the transport and protocol-era
+ * decision.
+ *
+ * `req` is the request context handlers see. For HTTP it's the live
+ * `PayloadRequest` derived from the incoming HTTP request; for stdio it's a
+ * synthesized one built via `createLocalReq`.
+ */ export const buildMcpServer = ({ authorizedMCP, pluginConfig, req })=>{
+    const serverOptions = pluginConfig.mcp?.serverOptions || {};
+    const server = new McpServer({
+        name: 'Payload MCP Server',
+        version: '1.0.0',
+        ...serverOptions.serverInfo
+    }, serverOptions.options);
+    const logger = getLogger({
+        payload: req.payload
+    });
+    /**
+   * Wrap a tool handler's response with the tool's `overrideResponse`, then
+   * strip the internal `doc` field so it doesn't leak onto the wire.
+   */ const finalizeToolResponse = async ({ input, overrideResponse, response, toolName })=>{
+        let overridden = overrideResponse?.(response, response.doc ?? {}, req) ?? response;
+        for (const hook of pluginConfig.hooks?.afterToolCall ?? []){
+            overridden = await hook({
+                input,
+                req,
+                response: overridden,
+                toolName
+            });
+        }
+        const { doc: _doc, ...rest } = overridden;
+        return rest;
+    };
+    /**
+   * Runs a collection/global tool call:
+   * - reads `collectionSlug` / `globalSlug` from the input
+   * - runs access control: errors if `authorizedMCP.items` has no entry for this tool + slug
+   * - runs the tool handler and finalizes its response
+   */ const callEntityTool = async ({ input, item, serverContext })=>{
+        const entity = item.type === 'collectionTool' ? 'collection' : 'global';
+        const slugKey = item.type === 'collectionTool' ? 'collectionSlug' : 'globalSlug';
+        const toolInput = input ?? {};
+        const slug = toolInput[slugKey];
+        if (!slug) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error: "${item.mcpName}" requires ${slugKey}. Use getConfigInfo to inspect ${entity} slugs.`
+                    }
+                ],
+                isError: true
+            };
+        }
+        const match = authorizedMCP.items.find((candidate)=>candidate.type === item.type && candidate.mcpName === item.mcpName && (candidate.type === 'collectionTool' ? candidate.collectionSlug === slug : candidate.type === 'globalTool' && candidate.globalSlug === slug));
+        if (!match) {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: `Error: MCP access to "${item.mcpName}" is not enabled for ${entity} "${slug}"`
+                    }
+                ],
+                isError: true
+            };
+        }
+        const handlerArgs = {
+            authorizedMCP,
+            input: toolInput,
+            req,
+            serverContext
+        };
+        const response = await (match.type === 'collectionTool' ? match.tool.handler({
+            ...handlerArgs,
+            collectionSlug: slug
+        }) : match.tool.handler({
+            ...handlerArgs,
+            globalSlug: slug
+        }));
+        return finalizeToolResponse({
+            input: toolInput,
+            overrideResponse: match.tool.overrideResponse,
+            response,
+            toolName: match.mcpName
+        });
+    };
+    try {
+        const registeredEntityTools = new Set();
+        for (const item of authorizedMCP.items){
+            switch(item.type){
+                case 'collectionTool':
+                case 'globalTool':
+                    {
+                        if (registeredEntityTools.has(item.mcpName)) {
+                            break;
+                        }
+                        registeredEntityTools.add(item.mcpName);
+                        const inputSchema = withSlugInput({
+                            name: item.type === 'collectionTool' ? 'collectionSlug' : 'globalSlug',
+                            input: item.tool.input
+                        });
+                        server.registerTool(item.mcpName, {
+                            annotations: item.tool.annotations,
+                            description: item.tool.description,
+                            inputSchema: toStandardSchema(inputSchema)
+                        }, async (input, ctx)=>callEntityTool({
+                                input,
+                                item,
+                                serverContext: ctx
+                            }));
+                        logger.info(`✅ Tool: ${item.mcpName} Registered.`);
+                        break;
+                    }
+                case 'prompt':
+                    {
+                        const prompt = item.prompt;
+                        server.registerPrompt(item.mcpName, {
+                            argsSchema: prompt.argsSchema ? toStandardSchema(prompt.argsSchema) : undefined,
+                            description: prompt.description,
+                            title: prompt.title
+                        }, async (input, ctx)=>prompt.handler({
+                                input: input ?? {},
+                                req,
+                                serverContext: ctx
+                            }));
+                        logger.info(`✅ Prompt: ${prompt.title} Registered.`);
+                        break;
+                    }
+                case 'resource':
+                    {
+                        const resource = item.resource;
+                        server.registerResource(item.mcpName, // @ts-expect-error - Overload type ambiguity (string OR ResourceTemplate is valid)
+                        resource.uri, {
+                            description: resource.description,
+                            mimeType: resource.mimeType,
+                            title: resource.title
+                        }, // Static URIs call (uri, ctx); ResourceTemplates call (uri, params, ctx).
+                        // The rest-params shape lets us collect either signature uniformly.
+                        async (...sdkArgs)=>{
+                            const ctx = sdkArgs[sdkArgs.length - 1];
+                            const uri = sdkArgs[0];
+                            const params = sdkArgs.length > 2 ? sdkArgs[1] : {};
+                            return resource.handler({
+                                params,
+                                req,
+                                serverContext: ctx,
+                                uri
+                            });
+                        });
+                        logger.info(`✅ Resource: ${resource.title} Registered.`);
+                        break;
+                    }
+                case 'tool':
+                    {
+                        const tool = item.tool;
+                        server.registerTool(item.mcpName, {
+                            annotations: tool.annotations,
+                            description: tool.description,
+                            inputSchema: tool.input ? toStandardSchema(tool.input) : undefined
+                        }, async (input, ctx)=>{
+                            const toolInput = input ?? {};
+                            const response = await tool.handler({
+                                authorizedMCP,
+                                input: toolInput,
+                                req,
+                                serverContext: ctx
+                            });
+                            return finalizeToolResponse({
+                                input: toolInput,
+                                overrideResponse: tool.overrideResponse,
+                                response,
+                                toolName: item.mcpName
+                            });
+                        });
+                        logger.info(`✅ Tool: ${item.mcpName} Registered.`);
+                        break;
+                    }
+            }
+        }
+    } catch (error) {
+        throw new APIError(`Error initializing MCP handler: ${String(error)}`, 500);
+    }
+    return server;
+};
+const withSlugInput = ({ name, input })=>{
+    const description = name === 'collectionSlug' ? 'The collection slug' : 'The global slug';
+    const slugSchema = z.string().describe(description);
+    if (!input) {
+        return z.object({
+            [name]: slugSchema
+        });
+    }
+    if (input instanceof z.ZodObject) {
+        return input.extend({
+            [name]: slugSchema
+        });
+    }
+    const schema = input;
+    return {
+        ...schema,
+        type: 'object',
+        properties: {
+            ...schema.properties,
+            [name]: {
+                type: 'string',
+                description
+            }
+        },
+        required: Array.from(new Set([
+            name,
+            ...schema.required ?? []
+        ]))
+    };
+};
+
+//# sourceMappingURL=buildMcpServer.js.map

package/dist/mcp/buildMcpServer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/mcp/buildMcpServer.ts"],"sourcesContent":["import { McpServer, type ServerContext } from '@modelcontextprotocol/server'\nimport { APIError, type PayloadRequest } from 'payload'\nimport { z } from 'zod'\n\nimport type {\n  AuthorizedMCP,\n  CollectionMCPItem,\n  GlobalMCPItem,\n  JsonSchemaType,\n  MCPResponseOverride,\n  MCPToolResponse,\n  SanitizedMCPPluginConfig,\n  ToolInputSchema,\n} from '../types.js'\n\nimport { getLogger } from '../utils/getLogger.js'\nimport { toStandardSchema } from '../utils/toStandardSchema.js'\n\n/**\n * Serving-entry-agnostic core: registers every authorized MCP item onto a fresh\n * `McpServer` and returns it. The HTTP and stdio entry point callers provide fresh\n * instances from this builder while they own the transport and protocol-era\n * decision.\n *\n * `req` is the request context handlers see. For HTTP it's the live\n * `PayloadRequest` derived from the incoming HTTP request; for stdio it's a\n * synthesized one built via `createLocalReq`.\n */\nexport const buildMcpServer = ({\n  authorizedMCP,\n  pluginConfig,\n  req,\n}: {\n  authorizedMCP: AuthorizedMCP\n  pluginConfig: SanitizedMCPPluginConfig\n  req: PayloadRequest\n}): McpServer => {\n  const serverOptions = pluginConfig.mcp?.serverOptions || {}\n  const server = new McpServer(\n    { name: 'Payload MCP Server', version: '1.0.0', ...serverOptions.serverInfo },\n    serverOptions.options,\n  )\n\n  const logger = getLogger({ payload: req.payload })\n\n  /**\n   * Wrap a tool handler's response with the tool's `overrideResponse`, then\n   * strip the internal `doc` field so it doesn't leak onto the wire.\n   */\n  const finalizeToolResponse = async ({\n    input,\n    overrideResponse,\n    response,\n    toolName,\n  }: {\n    input: unknown\n    overrideResponse?: MCPResponseOverride\n    response: MCPToolResponse\n    toolName: string\n  }): Promise<MCPToolResponse> => {\n    let overridden = overrideResponse?.(response, response.doc ?? {}, req) ?? response\n    for (const hook of pluginConfig.hooks?.afterToolCall ?? []) {\n      overridden = await hook({ input, req, response: overridden, toolName })\n    }\n    const { doc: _doc, ...rest } = overridden\n    return rest\n  }\n\n  /**\n   * Runs a collection/global tool call:\n   * - reads `collectionSlug` / `globalSlug` from the input\n   * - runs access control: errors if `authorizedMCP.items` has no entry for this tool + slug\n   * - runs the tool handler and finalizes its response\n   */\n  const callEntityTool = async ({\n    input,\n    item,\n    serverContext,\n  }: {\n    input: unknown\n    item: CollectionMCPItem | GlobalMCPItem\n    serverContext: ServerContext\n  }): Promise<MCPToolResponse> => {\n    const entity = item.type === 'collectionTool' ? 'collection' : 'global'\n    const slugKey = item.type === 'collectionTool' ? 'collectionSlug' : 'globalSlug'\n    const toolInput = (input ?? {}) as Record<string, unknown>\n    const slug = toolInput[slugKey] as string | undefined\n\n    if (!slug) {\n      return {\n        content: [\n          {\n            type: 'text',\n            text: `Error: \"${item.mcpName}\" requires ${slugKey}. Use getConfigInfo to inspect ${entity} slugs.`,\n          },\n        ],\n        isError: true,\n      }\n    }\n\n    const match = authorizedMCP.items.find(\n      (candidate): candidate is CollectionMCPItem | GlobalMCPItem =>\n        candidate.type === item.type &&\n        candidate.mcpName === item.mcpName &&\n        (candidate.type === 'collectionTool'\n          ? candidate.collectionSlug === slug\n          : candidate.type === 'globalTool' && candidate.globalSlug === slug),\n    )\n\n    if (!match) {\n      return {\n        content: [\n          {\n            type: 'text',\n            text: `Error: MCP access to \"${item.mcpName}\" is not enabled for ${entity} \"${slug}\"`,\n          },\n        ],\n        isError: true,\n      }\n    }\n\n    const handlerArgs = {\n      authorizedMCP,\n      input: toolInput,\n      req,\n      serverContext,\n    }\n    const response = await (match.type === 'collectionTool'\n      ? match.tool.handler({ ...handlerArgs, collectionSlug: slug })\n      : match.tool.handler({ ...handlerArgs, globalSlug: slug }))\n\n    return finalizeToolResponse({\n      input: toolInput,\n      overrideResponse: match.tool.overrideResponse,\n      response,\n      toolName: match.mcpName,\n    })\n  }\n\n  try {\n    const registeredEntityTools = new Set<string>()\n\n    for (const item of authorizedMCP.items) {\n      switch (item.type) {\n        case 'collectionTool':\n        case 'globalTool': {\n          if (registeredEntityTools.has(item.mcpName)) {\n            break\n          }\n          registeredEntityTools.add(item.mcpName)\n\n          const inputSchema = withSlugInput({\n            name: item.type === 'collectionTool' ? 'collectionSlug' : 'globalSlug',\n            input: item.tool.input,\n          })\n\n          server.registerTool(\n            item.mcpName,\n            {\n              annotations: item.tool.annotations,\n              description: item.tool.description,\n              inputSchema: toStandardSchema(inputSchema),\n            },\n            async (input: unknown, ctx: ServerContext) =>\n              callEntityTool({ input, item, serverContext: ctx }),\n          )\n          logger.info(`✅ Tool: ${item.mcpName} Registered.`)\n          break\n        }\n        case 'prompt': {\n          const prompt = item.prompt\n          server.registerPrompt(\n            item.mcpName,\n            {\n              argsSchema: prompt.argsSchema ? toStandardSchema(prompt.argsSchema) : undefined,\n              description: prompt.description,\n              title: prompt.title,\n            },\n            async (input: unknown, ctx: ServerContext) =>\n              prompt.handler({\n                input: (input ?? {}) as Record<string, unknown>,\n                req,\n                serverContext: ctx,\n              }),\n          )\n          logger.info(`✅ Prompt: ${prompt.title} Registered.`)\n          break\n        }\n        case 'resource': {\n          const resource = item.resource\n          server.registerResource(\n            item.mcpName,\n            // @ts-expect-error - Overload type ambiguity (string OR ResourceTemplate is valid)\n            resource.uri,\n            {\n              description: resource.description,\n              mimeType: resource.mimeType,\n              title: resource.title,\n            },\n            // Static URIs call (uri, ctx); ResourceTemplates call (uri, params, ctx).\n            // The rest-params shape lets us collect either signature uniformly.\n            async (...sdkArgs: unknown[]) => {\n              const ctx = sdkArgs[sdkArgs.length - 1] as ServerContext\n              const uri = sdkArgs[0] as URL\n              const params = (sdkArgs.length > 2 ? sdkArgs[1] : {}) as Record<string, string>\n              return resource.handler({ params, req, serverContext: ctx, uri })\n            },\n          )\n          logger.info(`✅ Resource: ${resource.title} Registered.`)\n          break\n        }\n        case 'tool': {\n          const tool = item.tool\n          server.registerTool(\n            item.mcpName,\n            {\n              annotations: tool.annotations,\n              description: tool.description,\n              inputSchema: tool.input ? toStandardSchema(tool.input) : undefined,\n            },\n            async (input: unknown, ctx: ServerContext) => {\n              const toolInput = (input ?? {}) as Record<string, unknown>\n              const response = await tool.handler({\n                authorizedMCP,\n                input: toolInput,\n                req,\n                serverContext: ctx,\n              })\n              return finalizeToolResponse({\n                input: toolInput,\n                overrideResponse: tool.overrideResponse,\n                response,\n                toolName: item.mcpName,\n              })\n            },\n          )\n          logger.info(`✅ Tool: ${item.mcpName} Registered.`)\n          break\n        }\n      }\n    }\n  } catch (error) {\n    throw new APIError(`Error initializing MCP handler: ${String(error)}`, 500)\n  }\n\n  return server\n}\n\nconst withSlugInput = ({\n  name,\n  input,\n}: {\n  input?: ToolInputSchema\n  name: 'collectionSlug' | 'globalSlug'\n}): ToolInputSchema => {\n  const description = name === 'collectionSlug' ? 'The collection slug' : 'The global slug'\n  const slugSchema = z.string().describe(description)\n\n  if (!input) {\n    return z.object({ [name]: slugSchema })\n  }\n\n  if (input instanceof z.ZodObject) {\n    return input.extend({ [name]: slugSchema })\n  }\n\n  const schema = input as {\n    properties?: Record<string, JsonSchemaType>\n    required?: string[]\n  } & JsonSchemaType\n\n  return {\n    ...schema,\n    type: 'object',\n    properties: {\n      ...schema.properties,\n      [name]: {\n        type: 'string',\n        description,\n      },\n    },\n    required: Array.from(new Set([name, ...(schema.required ?? [])])),\n  }\n}\n"],"names":["McpServer","APIError","z","getLogger","toStandardSchema","buildMcpServer","authorizedMCP","pluginConfig","req","serverOptions","mcp","server","name","version","serverInfo","options","logger","payload","finalizeToolResponse","input","overrideResponse","response","toolName","overridden","doc","hook","hooks","afterToolCall","_doc","rest","callEntityTool","item","serverContext","entity","type","slugKey","toolInput","slug","content","text","mcpName","isError","match","items","find","candidate","collectionSlug","globalSlug","handlerArgs","tool","handler","registeredEntityTools","Set","has","add","inputSchema","withSlugInput","registerTool","annotations","description","ctx","info","prompt","registerPrompt","argsSchema","undefined","title","resource","registerResource","uri","mimeType","sdkArgs","length","params","error","String","slugSchema","string","describe","object","ZodObject","extend","schema","properties","required","Array","from"],"mappings":"AAAA,SAASA,SAAS,QAA4B,+BAA8B;AAC5E,SAASC,QAAQ,QAA6B,UAAS;AACvD,SAASC,CAAC,QAAQ,MAAK;AAavB,SAASC,SAAS,QAAQ,wBAAuB;AACjD,SAASC,gBAAgB,QAAQ,+BAA8B;AAE/D;;;;;;;;;CASC,GACD,OAAO,MAAMC,iBAAiB,CAAC,EAC7BC,aAAa,EACbC,YAAY,EACZC,GAAG,EAKJ;IACC,MAAMC,gBAAgBF,aAAaG,GAAG,EAAED,iBAAiB,CAAC;IAC1D,MAAME,SAAS,IAAIX,UACjB;QAAEY,MAAM;QAAsBC,SAAS;QAAS,GAAGJ,cAAcK,UAAU;IAAC,GAC5EL,cAAcM,OAAO;IAGvB,MAAMC,SAASb,UAAU;QAAEc,SAAST,IAAIS,OAAO;IAAC;IAEhD;;;GAGC,GACD,MAAMC,uBAAuB,OAAO,EAClCC,KAAK,EACLC,gBAAgB,EAChBC,QAAQ,EACRC,QAAQ,EAMT;QACC,IAAIC,aAAaH,mBAAmBC,UAAUA,SAASG,GAAG,IAAI,CAAC,GAAGhB,QAAQa;QAC1E,KAAK,MAAMI,QAAQlB,aAAamB,KAAK,EAAEC,iBAAiB,EAAE,CAAE;YAC1DJ,aAAa,MAAME,KAAK;gBAAEN;gBAAOX;gBAAKa,UAAUE;gBAAYD;YAAS;QACvE;QACA,MAAM,EAAEE,KAAKI,IAAI,EAAE,GAAGC,MAAM,GAAGN;QAC/B,OAAOM;IACT;IAEA;;;;;GAKC,GACD,MAAMC,iBAAiB,OAAO,EAC5BX,KAAK,EACLY,IAAI,EACJC,aAAa,EAKd;QACC,MAAMC,SAASF,KAAKG,IAAI,KAAK,mBAAmB,eAAe;QAC/D,MAAMC,UAAUJ,KAAKG,IAAI,KAAK,mBAAmB,mBAAmB;QACpE,MAAME,YAAajB,SAAS,CAAC;QAC7B,MAAMkB,OAAOD,SAAS,CAACD,QAAQ;QAE/B,IAAI,CAACE,MAAM;YACT,OAAO;gBACLC,SAAS;oBACP;wBACEJ,MAAM;wBACNK,MAAM,CAAC,QAAQ,EAAER,KAAKS,OAAO,CAAC,WAAW,EAAEL,QAAQ,+BAA+B,EAAEF,OAAO,OAAO,CAAC;oBACrG;iBACD;gBACDQ,SAAS;YACX;QACF;QAEA,MAAMC,QAAQpC,cAAcqC,KAAK,CAACC,IAAI,CACpC,CAACC,YACCA,UAAUX,IAAI,KAAKH,KAAKG,IAAI,IAC5BW,UAAUL,OAAO,KAAKT,KAAKS,OAAO,IACjCK,CAAAA,UAAUX,IAAI,KAAK,mBAChBW,UAAUC,cAAc,KAAKT,OAC7BQ,UAAUX,IAAI,KAAK,gBAAgBW,UAAUE,UAAU,KAAKV,IAAG;QAGvE,IAAI,CAACK,OAAO;YACV,OAAO;gBACLJ,SAAS;oBACP;wBACEJ,MAAM;wBACNK,MAAM,CAAC,sBAAsB,EAAER,KAAKS,OAAO,CAAC,qBAAqB,EAAEP,OAAO,EAAE,EAAEI,KAAK,CAAC,CAAC;oBACvF;iBACD;gBACDI,SAAS;YACX;QACF;QAEA,MAAMO,cAAc;YAClB1C;YACAa,OAAOiB;YACP5B;YACAwB;QACF;QACA,MAAMX,WAAW,MAAOqB,CAAAA,MAAMR,IAAI,KAAK,mBACnCQ,MAAMO,IAAI,CAACC,OAAO,CAAC;YAAE,GAAGF,WAAW;YAAEF,gBAAgBT;QAAK,KAC1DK,MAAMO,IAAI,CAACC,OAAO,CAAC;YAAE,GAAGF,WAAW;YAAED,YAAYV;QAAK,EAAC;QAE3D,OAAOnB,qBAAqB;YAC1BC,OAAOiB;YACPhB,kBAAkBsB,MAAMO,IAAI,CAAC7B,gBAAgB;YAC7CC;YACAC,UAAUoB,MAAMF,OAAO;QACzB;IACF;IAEA,IAAI;QACF,MAAMW,wBAAwB,IAAIC;QAElC,KAAK,MAAMrB,QAAQzB,cAAcqC,KAAK,CAAE;YACtC,OAAQZ,KAAKG,IAAI;gBACf,KAAK;gBACL,KAAK;oBAAc;wBACjB,IAAIiB,sBAAsBE,GAAG,CAACtB,KAAKS,OAAO,GAAG;4BAC3C;wBACF;wBACAW,sBAAsBG,GAAG,CAACvB,KAAKS,OAAO;wBAEtC,MAAMe,cAAcC,cAAc;4BAChC5C,MAAMmB,KAAKG,IAAI,KAAK,mBAAmB,mBAAmB;4BAC1Df,OAAOY,KAAKkB,IAAI,CAAC9B,KAAK;wBACxB;wBAEAR,OAAO8C,YAAY,CACjB1B,KAAKS,OAAO,EACZ;4BACEkB,aAAa3B,KAAKkB,IAAI,CAACS,WAAW;4BAClCC,aAAa5B,KAAKkB,IAAI,CAACU,WAAW;4BAClCJ,aAAanD,iBAAiBmD;wBAChC,GACA,OAAOpC,OAAgByC,MACrB9B,eAAe;gCAAEX;gCAAOY;gCAAMC,eAAe4B;4BAAI;wBAErD5C,OAAO6C,IAAI,CAAC,CAAC,QAAQ,EAAE9B,KAAKS,OAAO,CAAC,YAAY,CAAC;wBACjD;oBACF;gBACA,KAAK;oBAAU;wBACb,MAAMsB,SAAS/B,KAAK+B,MAAM;wBAC1BnD,OAAOoD,cAAc,CACnBhC,KAAKS,OAAO,EACZ;4BACEwB,YAAYF,OAAOE,UAAU,GAAG5D,iBAAiB0D,OAAOE,UAAU,IAAIC;4BACtEN,aAAaG,OAAOH,WAAW;4BAC/BO,OAAOJ,OAAOI,KAAK;wBACrB,GACA,OAAO/C,OAAgByC,MACrBE,OAAOZ,OAAO,CAAC;gCACb/B,OAAQA,SAAS,CAAC;gCAClBX;gCACAwB,eAAe4B;4BACjB;wBAEJ5C,OAAO6C,IAAI,CAAC,CAAC,UAAU,EAAEC,OAAOI,KAAK,CAAC,YAAY,CAAC;wBACnD;oBACF;gBACA,KAAK;oBAAY;wBACf,MAAMC,WAAWpC,KAAKoC,QAAQ;wBAC9BxD,OAAOyD,gBAAgB,CACrBrC,KAAKS,OAAO,EACZ,mFAAmF;wBACnF2B,SAASE,GAAG,EACZ;4BACEV,aAAaQ,SAASR,WAAW;4BACjCW,UAAUH,SAASG,QAAQ;4BAC3BJ,OAAOC,SAASD,KAAK;wBACvB,GACA,0EAA0E;wBAC1E,oEAAoE;wBACpE,OAAO,GAAGK;4BACR,MAAMX,MAAMW,OAAO,CAACA,QAAQC,MAAM,GAAG,EAAE;4BACvC,MAAMH,MAAME,OAAO,CAAC,EAAE;4BACtB,MAAME,SAAUF,QAAQC,MAAM,GAAG,IAAID,OAAO,CAAC,EAAE,GAAG,CAAC;4BACnD,OAAOJ,SAASjB,OAAO,CAAC;gCAAEuB;gCAAQjE;gCAAKwB,eAAe4B;gCAAKS;4BAAI;wBACjE;wBAEFrD,OAAO6C,IAAI,CAAC,CAAC,YAAY,EAAEM,SAASD,KAAK,CAAC,YAAY,CAAC;wBACvD;oBACF;gBACA,KAAK;oBAAQ;wBACX,MAAMjB,OAAOlB,KAAKkB,IAAI;wBACtBtC,OAAO8C,YAAY,CACjB1B,KAAKS,OAAO,EACZ;4BACEkB,aAAaT,KAAKS,WAAW;4BAC7BC,aAAaV,KAAKU,WAAW;4BAC7BJ,aAAaN,KAAK9B,KAAK,GAAGf,iBAAiB6C,KAAK9B,KAAK,IAAI8C;wBAC3D,GACA,OAAO9C,OAAgByC;4BACrB,MAAMxB,YAAajB,SAAS,CAAC;4BAC7B,MAAME,WAAW,MAAM4B,KAAKC,OAAO,CAAC;gCAClC5C;gCACAa,OAAOiB;gCACP5B;gCACAwB,eAAe4B;4BACjB;4BACA,OAAO1C,qBAAqB;gCAC1BC,OAAOiB;gCACPhB,kBAAkB6B,KAAK7B,gBAAgB;gCACvCC;gCACAC,UAAUS,KAAKS,OAAO;4BACxB;wBACF;wBAEFxB,OAAO6C,IAAI,CAAC,CAAC,QAAQ,EAAE9B,KAAKS,OAAO,CAAC,YAAY,CAAC;wBACjD;oBACF;YACF;QACF;IACF,EAAE,OAAOkC,OAAO;QACd,MAAM,IAAIzE,SAAS,CAAC,gCAAgC,EAAE0E,OAAOD,QAAQ,EAAE;IACzE;IAEA,OAAO/D;AACT,EAAC;AAED,MAAM6C,gBAAgB,CAAC,EACrB5C,IAAI,EACJO,KAAK,EAIN;IACC,MAAMwC,cAAc/C,SAAS,mBAAmB,wBAAwB;IACxE,MAAMgE,aAAa1E,EAAE2E,MAAM,GAAGC,QAAQ,CAACnB;IAEvC,IAAI,CAACxC,OAAO;QACV,OAAOjB,EAAE6E,MAAM,CAAC;YAAE,CAACnE,KAAK,EAAEgE;QAAW;IACvC;IAEA,IAAIzD,iBAAiBjB,EAAE8E,SAAS,EAAE;QAChC,OAAO7D,MAAM8D,MAAM,CAAC;YAAE,CAACrE,KAAK,EAAEgE;QAAW;IAC3C;IAEA,MAAMM,SAAS/D;IAKf,OAAO;QACL,GAAG+D,MAAM;QACThD,MAAM;QACNiD,YAAY;YACV,GAAGD,OAAOC,UAAU;YACpB,CAACvE,KAAK,EAAE;gBACNsB,MAAM;gBACNyB;YACF;QACF;QACAyB,UAAUC,MAAMC,IAAI,CAAC,IAAIlC,IAAI;YAACxC;eAAUsE,OAAOE,QAAQ,IAAI,EAAE;SAAE;IACjE;AACF"}

package/dist/mcp/builtin/collections/authTools.d.ts

@@ -0,0 +1,7 @@
+export declare const authCollectionTool: import("../../../types.js").CollectionTool;
+export declare const forgotPasswordCollectionTool: import("../../../types.js").CollectionTool;
+export declare const loginCollectionTool: import("../../../types.js").CollectionTool;
+export declare const resetPasswordCollectionTool: import("../../../types.js").CollectionTool;
+export declare const unlockCollectionTool: import("../../../types.js").CollectionTool;
+export declare const verifyCollectionTool: import("../../../types.js").CollectionTool;
+//# sourceMappingURL=authTools.d.ts.map

package/dist/mcp/builtin/collections/authTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authTools.d.ts","sourceRoot":"","sources":["../../../../src/mcp/builtin/collections/authTools.ts"],"names":[],"mappings":"AAiCA,eAAO,MAAM,kBAAkB,4CAqC7B,CAAA;AAEF,eAAO,MAAM,4BAA4B,4CAuCvC,CAAA;AAEF,eAAO,MAAM,mBAAmB,4CAiD9B,CAAA;AAEF,eAAO,MAAM,2BAA2B,4CAmCtC,CAAA;AAEF,eAAO,MAAM,oBAAoB,4CAgC/B,CAAA;AAEF,eAAO,MAAM,oBAAoB,4CAiC/B,CAAA"}