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

package/dist/stdio.js

@@ -0,0 +1,127 @@
+/* eslint-disable no-console */ import { serveStdio } from '@modelcontextprotocol/server/stdio';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import { createLocalReq, getPayload } from 'payload';
+import { findConfig } from 'payload/node';
+import { getAuthorizedMCP } from './endpoint/access.js';
+import { buildMcpServer } from './mcp/buildMcpServer.js';
+import { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js';
+import { getPluginConfig } from './utils/getPluginConfig.js';
+import { resolveProjectRoot } from './utils/resolveProjectRoot.js';
+/**
+ * Starts Payload's MCP server over stdin and stdout.
+ *
+ * Set `PAYLOAD_MCP_AUTHORIZATION` to authenticate. In development,
+ * `PAYLOAD_MCP_OVERRIDE_ACCESS=true` skips access checks.
+ */ export const runMcpStdio = async (configOverride)=>{
+    // MCP clients may start this command from another folder. Move to the Payload
+    // project so findConfig() can find the config.
+    const projectRoot = resolveProjectRoot(fileURLToPath(import.meta.url));
+    if (projectRoot) {
+        process.chdir(projectRoot);
+    }
+    const configPath = findConfig();
+    const configURL = pathToFileURL(configPath).href;
+    const configModule = configOverride ? undefined : await import(configURL);
+    const config = configOverride ?? await (configModule?.default ?? configModule);
+    /**
+   * stdout is only for MCP messages. The spec says the server must not write
+   * logs there and may write them to stderr instead.
+   *
+   * The 2.0 client library recovers from stray stdout logs, but that behavior is not
+   * guaranteed. Move Payload logs to stderr so Payload does not add invalid data
+   * to stdout. Keep options from configurable loggers. Replace pre-built loggers
+   * because their output cannot be redirected.
+   *
+   * @see https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#stdio
+   */ const loggerConfig = config;
+    if (loggerConfig.logger && typeof loggerConfig.logger === 'object' && 'options' in loggerConfig.logger) {
+        loggerConfig.logger.destination = process.stderr;
+    } else {
+        loggerConfig.logger = {
+            destination: process.stderr,
+            options: {}
+        };
+    }
+    const payload = await getPayload({
+        config,
+        cron: false,
+        disableOnInit: true
+    });
+    let pluginConfig;
+    try {
+        pluginConfig = getPluginConfig({
+            config: payload.config
+        });
+    } catch  {
+        // The command also works when mcpPlugin() is not in the Payload config.
+        pluginConfig = sanitizeMCPConfig({
+            config: payload.config,
+            pluginConfig: {}
+        });
+        const fallbackPlugin = (config)=>config;
+        Object.assign(fallbackPlugin, {
+            slug: '@payloadcms/plugin-mcp',
+            sanitizedOptions: pluginConfig
+        });
+        payload.config.plugins ??= [];
+        payload.config.plugins.push(fallbackPlugin);
+    }
+    const overrideAccessEnv = process.env.PAYLOAD_MCP_OVERRIDE_ACCESS;
+    let overrideAccess = false;
+    if (overrideAccessEnv === 'true') {
+        overrideAccess = true;
+    } else if (overrideAccessEnv && overrideAccessEnv !== 'false') {
+        throw new Error('PAYLOAD_MCP_OVERRIDE_ACCESS must be "true" or "false".');
+    }
+    if (overrideAccess && process.env.NODE_ENV !== 'development') {
+        throw new Error('PAYLOAD_MCP_OVERRIDE_ACCESS is only available in development.');
+    }
+    const headers = new Headers();
+    if (process.env.PAYLOAD_MCP_AUTHORIZATION) {
+        headers.set('Authorization', process.env.PAYLOAD_MCP_AUTHORIZATION);
+    }
+    const req = await createLocalReq({
+        req: {
+            headers
+        }
+    }, payload);
+    req.payloadAPI = 'MCP';
+    const authorizedMCP = await getAuthorizedMCP({
+        overrideAccess,
+        req
+    });
+    const stdioServer = serveStdio(()=>buildMcpServer({
+            authorizedMCP,
+            pluginConfig,
+            req
+        }), {
+        onerror: (err)=>{
+            // MCP messages use stdout, so write SDK errors to stderr.
+            console.error('[payload-mcp] error serving MCP over stdio:', err);
+        }
+    });
+    // Close the MCP server and Payload when the client disconnects or the process stops.
+    let isShuttingDown = false;
+    const shutdown = async ()=>{
+        if (isShuttingDown) {
+            return;
+        }
+        isShuttingDown = true;
+        try {
+            await stdioServer.close();
+        } catch (err) {
+            console.error('[payload-mcp] error closing server:', err);
+        }
+        try {
+            await payload.destroy();
+        } catch (err) {
+            console.error('[payload-mcp] error destroying payload:', err);
+        }
+        process.exit(0);
+    };
+    process.once('SIGINT', ()=>void shutdown());
+    process.once('SIGTERM', ()=>void shutdown());
+    process.stdin.once('close', ()=>void shutdown());
+};
+
+//# sourceMappingURL=stdio.js.map

package/dist/stdio.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stdio.ts"],"sourcesContent":["import type { Config, Plugin, SanitizedConfig } from 'payload'\n\n/* eslint-disable no-console */\nimport { serveStdio } from '@modelcontextprotocol/server/stdio'\nimport { fileURLToPath, pathToFileURL } from 'node:url'\nimport { createLocalReq, getPayload } from 'payload'\nimport { findConfig } from 'payload/node'\n\nimport type { SanitizedMCPPluginConfig } from './types.js'\n\nimport { getAuthorizedMCP } from './endpoint/access.js'\nimport { buildMcpServer } from './mcp/buildMcpServer.js'\nimport { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js'\nimport { getPluginConfig } from './utils/getPluginConfig.js'\nimport { resolveProjectRoot } from './utils/resolveProjectRoot.js'\n\n/**\n * Starts Payload's MCP server over stdin and stdout.\n *\n * Set `PAYLOAD_MCP_AUTHORIZATION` to authenticate. In development,\n * `PAYLOAD_MCP_OVERRIDE_ACCESS=true` skips access checks.\n */\nexport const runMcpStdio = async (configOverride?: SanitizedConfig): Promise<void> => {\n  // MCP clients may start this command from another folder. Move to the Payload\n  // project so findConfig() can find the config.\n  const projectRoot = resolveProjectRoot(fileURLToPath(import.meta.url))\n  if (projectRoot) {\n    process.chdir(projectRoot)\n  }\n\n  const configPath = findConfig()\n  const configURL = pathToFileURL(configPath).href\n  const configModule = configOverride ? undefined : await import(configURL)\n  const config: SanitizedConfig = configOverride ?? (await (configModule?.default ?? configModule))\n\n  /**\n   * stdout is only for MCP messages. The spec says the server must not write\n   * logs there and may write them to stderr instead.\n   *\n   * The 2.0 client library recovers from stray stdout logs, but that behavior is not\n   * guaranteed. Move Payload logs to stderr so Payload does not add invalid data\n   * to stdout. Keep options from configurable loggers. Replace pre-built loggers\n   * because their output cannot be redirected.\n   *\n   * @see https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#stdio\n   */\n  const loggerConfig: { logger?: Config['logger'] } = config\n  if (\n    loggerConfig.logger &&\n    typeof loggerConfig.logger === 'object' &&\n    'options' in loggerConfig.logger\n  ) {\n    loggerConfig.logger.destination = process.stderr\n  } else {\n    loggerConfig.logger = { destination: process.stderr, options: {} }\n  }\n\n  const payload = await getPayload({ config, cron: false, disableOnInit: true })\n\n  let pluginConfig: SanitizedMCPPluginConfig\n  try {\n    pluginConfig = getPluginConfig({ config: payload.config })\n  } catch {\n    // The command also works when mcpPlugin() is not in the Payload config.\n    pluginConfig = sanitizeMCPConfig({ config: payload.config, pluginConfig: {} })\n\n    const fallbackPlugin: Plugin = (config) => config\n    Object.assign(fallbackPlugin, {\n      slug: '@payloadcms/plugin-mcp',\n      sanitizedOptions: pluginConfig,\n    })\n    payload.config.plugins ??= []\n    payload.config.plugins.push(fallbackPlugin)\n  }\n\n  const overrideAccessEnv = process.env.PAYLOAD_MCP_OVERRIDE_ACCESS\n  let overrideAccess = false\n\n  if (overrideAccessEnv === 'true') {\n    overrideAccess = true\n  } else if (overrideAccessEnv && overrideAccessEnv !== 'false') {\n    throw new Error('PAYLOAD_MCP_OVERRIDE_ACCESS must be \"true\" or \"false\".')\n  }\n\n  if (overrideAccess && process.env.NODE_ENV !== 'development') {\n    throw new Error('PAYLOAD_MCP_OVERRIDE_ACCESS is only available in development.')\n  }\n\n  const headers = new Headers()\n  if (process.env.PAYLOAD_MCP_AUTHORIZATION) {\n    headers.set('Authorization', process.env.PAYLOAD_MCP_AUTHORIZATION)\n  }\n\n  const req = await createLocalReq({ req: { headers } }, payload)\n  req.payloadAPI = 'MCP' as const\n  const authorizedMCP = await getAuthorizedMCP({ overrideAccess, req })\n\n  const stdioServer = serveStdio(() => buildMcpServer({ authorizedMCP, pluginConfig, req }), {\n    onerror: (err) => {\n      // MCP messages use stdout, so write SDK errors to stderr.\n      console.error('[payload-mcp] error serving MCP over stdio:', err)\n    },\n  })\n\n  // Close the MCP server and Payload when the client disconnects or the process stops.\n  let isShuttingDown = false\n  const shutdown = async () => {\n    if (isShuttingDown) {\n      return\n    }\n    isShuttingDown = true\n\n    try {\n      await stdioServer.close()\n    } catch (err) {\n      console.error('[payload-mcp] error closing server:', err)\n    }\n\n    try {\n      await payload.destroy()\n    } catch (err) {\n      console.error('[payload-mcp] error destroying payload:', err)\n    }\n\n    process.exit(0)\n  }\n\n  process.once('SIGINT', () => void shutdown())\n  process.once('SIGTERM', () => void shutdown())\n  process.stdin.once('close', () => void shutdown())\n}\n"],"names":["serveStdio","fileURLToPath","pathToFileURL","createLocalReq","getPayload","findConfig","getAuthorizedMCP","buildMcpServer","sanitizeMCPConfig","getPluginConfig","resolveProjectRoot","runMcpStdio","configOverride","projectRoot","url","process","chdir","configPath","configURL","href","configModule","undefined","config","default","loggerConfig","logger","destination","stderr","options","payload","cron","disableOnInit","pluginConfig","fallbackPlugin","Object","assign","slug","sanitizedOptions","plugins","push","overrideAccessEnv","env","PAYLOAD_MCP_OVERRIDE_ACCESS","overrideAccess","Error","NODE_ENV","headers","Headers","PAYLOAD_MCP_AUTHORIZATION","set","req","payloadAPI","authorizedMCP","stdioServer","onerror","err","console","error","isShuttingDown","shutdown","close","destroy","exit","once","stdin"],"mappings":"AAEA,6BAA6B,GAC7B,SAASA,UAAU,QAAQ,qCAAoC;AAC/D,SAASC,aAAa,EAAEC,aAAa,QAAQ,WAAU;AACvD,SAASC,cAAc,EAAEC,UAAU,QAAQ,UAAS;AACpD,SAASC,UAAU,QAAQ,eAAc;AAIzC,SAASC,gBAAgB,QAAQ,uBAAsB;AACvD,SAASC,cAAc,QAAQ,0BAAyB;AACxD,SAASC,iBAAiB,QAAQ,6BAA4B;AAC9D,SAASC,eAAe,QAAQ,6BAA4B;AAC5D,SAASC,kBAAkB,QAAQ,gCAA+B;AAElE;;;;;CAKC,GACD,OAAO,MAAMC,cAAc,OAAOC;IAChC,8EAA8E;IAC9E,+CAA+C;IAC/C,MAAMC,cAAcH,mBAAmBT,cAAc,YAAYa,GAAG;IACpE,IAAID,aAAa;QACfE,QAAQC,KAAK,CAACH;IAChB;IAEA,MAAMI,aAAaZ;IACnB,MAAMa,YAAYhB,cAAce,YAAYE,IAAI;IAChD,MAAMC,eAAeR,iBAAiBS,YAAY,MAAM,MAAM,CAACH;IAC/D,MAAMI,SAA0BV,kBAAmB,MAAOQ,CAAAA,cAAcG,WAAWH,YAAW;IAE9F;;;;;;;;;;GAUC,GACD,MAAMI,eAA8CF;IACpD,IACEE,aAAaC,MAAM,IACnB,OAAOD,aAAaC,MAAM,KAAK,YAC/B,aAAaD,aAAaC,MAAM,EAChC;QACAD,aAAaC,MAAM,CAACC,WAAW,GAAGX,QAAQY,MAAM;IAClD,OAAO;QACLH,aAAaC,MAAM,GAAG;YAAEC,aAAaX,QAAQY,MAAM;YAAEC,SAAS,CAAC;QAAE;IACnE;IAEA,MAAMC,UAAU,MAAMzB,WAAW;QAAEkB;QAAQQ,MAAM;QAAOC,eAAe;IAAK;IAE5E,IAAIC;IACJ,IAAI;QACFA,eAAevB,gBAAgB;YAAEa,QAAQO,QAAQP,MAAM;QAAC;IAC1D,EAAE,OAAM;QACN,wEAAwE;QACxEU,eAAexB,kBAAkB;YAAEc,QAAQO,QAAQP,MAAM;YAAEU,cAAc,CAAC;QAAE;QAE5E,MAAMC,iBAAyB,CAACX,SAAWA;QAC3CY,OAAOC,MAAM,CAACF,gBAAgB;YAC5BG,MAAM;YACNC,kBAAkBL;QACpB;QACAH,QAAQP,MAAM,CAACgB,OAAO,KAAK,EAAE;QAC7BT,QAAQP,MAAM,CAACgB,OAAO,CAACC,IAAI,CAACN;IAC9B;IAEA,MAAMO,oBAAoBzB,QAAQ0B,GAAG,CAACC,2BAA2B;IACjE,IAAIC,iBAAiB;IAErB,IAAIH,sBAAsB,QAAQ;QAChCG,iBAAiB;IACnB,OAAO,IAAIH,qBAAqBA,sBAAsB,SAAS;QAC7D,MAAM,IAAII,MAAM;IAClB;IAEA,IAAID,kBAAkB5B,QAAQ0B,GAAG,CAACI,QAAQ,KAAK,eAAe;QAC5D,MAAM,IAAID,MAAM;IAClB;IAEA,MAAME,UAAU,IAAIC;IACpB,IAAIhC,QAAQ0B,GAAG,CAACO,yBAAyB,EAAE;QACzCF,QAAQG,GAAG,CAAC,iBAAiBlC,QAAQ0B,GAAG,CAACO,yBAAyB;IACpE;IAEA,MAAME,MAAM,MAAM/C,eAAe;QAAE+C,KAAK;YAAEJ;QAAQ;IAAE,GAAGjB;IACvDqB,IAAIC,UAAU,GAAG;IACjB,MAAMC,gBAAgB,MAAM9C,iBAAiB;QAAEqC;QAAgBO;IAAI;IAEnE,MAAMG,cAAcrD,WAAW,IAAMO,eAAe;YAAE6C;YAAepB;YAAckB;QAAI,IAAI;QACzFI,SAAS,CAACC;YACR,0DAA0D;YAC1DC,QAAQC,KAAK,CAAC,+CAA+CF;QAC/D;IACF;IAEA,qFAAqF;IACrF,IAAIG,iBAAiB;IACrB,MAAMC,WAAW;QACf,IAAID,gBAAgB;YAClB;QACF;QACAA,iBAAiB;QAEjB,IAAI;YACF,MAAML,YAAYO,KAAK;QACzB,EAAE,OAAOL,KAAK;YACZC,QAAQC,KAAK,CAAC,uCAAuCF;QACvD;QAEA,IAAI;YACF,MAAM1B,QAAQgC,OAAO;QACvB,EAAE,OAAON,KAAK;YACZC,QAAQC,KAAK,CAAC,2CAA2CF;QAC3D;QAEAxC,QAAQ+C,IAAI,CAAC;IACf;IAEA/C,QAAQgD,IAAI,CAAC,UAAU,IAAM,KAAKJ;IAClC5C,QAAQgD,IAAI,CAAC,WAAW,IAAM,KAAKJ;IACnC5C,QAAQiD,KAAK,CAACD,IAAI,CAAC,SAAS,IAAM,KAAKJ;AACzC,EAAC"}