@payloadcms/plugin-mcp 4.0.0-internal.38b7f1d → 4.0.0-internal.4c792ad

package/dist/stdio.js

@@ -0,0 +1,108 @@
+/* eslint-disable no-console */ import { StdioServerTransport } from '@modelcontextprotocol/server';
+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';
+/**
+ * Stdio adapter for the Payload MCP server.
+ *
+ * Pass PAYLOAD_MCP_AUTHORIZATION when stdio should authenticate with the same
+ * Payload auth header as HTTP. In development, PAYLOAD_MCP_OVERRIDE_ACCESS=true
+ * skips access control for local setup.
+ */ export const runMcpStdio = async ()=>{
+    /**
+   * If MCP clients spawn stdio servers from an arbitrary working directory,
+   * Payload's cwd-anchored `findConfig()` can't locate the project on
+   * its own. This module always lives inside the project's `node_modules`, so
+   * we derive the project root from its own path and `chdir` into it.
+   *
+   * An absolute `PAYLOAD_CONFIG_PATH` still overrides everything; unusual
+   * layouts (e.g. a monorepo where the package is hoisted above the app) can
+   * fall back to it. See the implementation of findConfig for details.
+   */ const projectRoot = resolveProjectRoot(fileURLToPath(import.meta.url));
+    if (projectRoot) {
+        process.chdir(projectRoot);
+    }
+    const configPath = findConfig();
+    const configModule = await import(pathToFileURL(configPath).toString());
+    const config = await (configModule.default ?? configModule);
+    const payload = await getPayload({
+        config
+    });
+    /**
+   * If the user added `mcpPlugin({...})` to their `plugins` array, read the
+   * sanitized config they registered. Otherwise fall back to the defaults. That way,
+   * the mcp works on any project that has `@payloadcms/plugin-mcp` installed,
+   * even if the plugin is not added to the plugins array.
+   */ let pluginConfig;
+    try {
+        pluginConfig = getPluginConfig({
+            config: payload.config
+        });
+    } catch  {
+        pluginConfig = sanitizeMCPConfig({
+            config: payload.config,
+            pluginConfig: {}
+        });
+        const fakePluginFn = (config)=>config;
+        fakePluginFn.slug = '@payloadcms/plugin-mcp';
+        // @ts-expect-error
+        fakePluginFn.sanitizedOptions = pluginConfig;
+        (payload.config.plugins ??= []).push(fakePluginFn);
+    }
+    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 server = buildMcpServer({
+        authorizedMCP,
+        pluginConfig,
+        req
+    });
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    // Process now lives until stdin closes. Wire graceful shutdown so DB
+    // connections (and any other Payload-managed resources) get released.
+    const shutdown = async (code = 0)=>{
+        try {
+            await server.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(code);
+    };
+    process.on('SIGINT', ()=>void shutdown(0));
+    process.on('SIGTERM', ()=>void shutdown(0));
+    process.stdin.on('close', ()=>void shutdown(0));
+};
+
+//# sourceMappingURL=stdio.js.map

package/dist/stdio.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stdio.ts"],"sourcesContent":["import type { MaybePromise, Plugin, SanitizedConfig } from 'payload'\n\n/* eslint-disable no-console */\nimport { StdioServerTransport } from '@modelcontextprotocol/server'\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 * Stdio adapter for the Payload MCP server.\n *\n * Pass PAYLOAD_MCP_AUTHORIZATION when stdio should authenticate with the same\n * Payload auth header as HTTP. In development, PAYLOAD_MCP_OVERRIDE_ACCESS=true\n * skips access control for local setup.\n */\nexport const runMcpStdio = async (): Promise<void> => {\n  /**\n   * If MCP clients spawn stdio servers from an arbitrary working directory,\n   * Payload's cwd-anchored `findConfig()` can't locate the project on\n   * its own. This module always lives inside the project's `node_modules`, so\n   * we derive the project root from its own path and `chdir` into it.\n   *\n   * An absolute `PAYLOAD_CONFIG_PATH` still overrides everything; unusual\n   * layouts (e.g. a monorepo where the package is hoisted above the app) can\n   * fall back to it. See the implementation of findConfig for details.\n   */\n  const projectRoot = resolveProjectRoot(fileURLToPath(import.meta.url))\n  if (projectRoot) {\n    process.chdir(projectRoot)\n  }\n\n  const configPath = findConfig()\n  const configModule = await import(pathToFileURL(configPath).toString())\n  const config = (await (configModule.default ?? configModule)) as MaybePromise<SanitizedConfig>\n\n  const payload = await getPayload({ config })\n\n  /**\n   * If the user added `mcpPlugin({...})` to their `plugins` array, read the\n   * sanitized config they registered. Otherwise fall back to the defaults. That way,\n   * the mcp works on any project that has `@payloadcms/plugin-mcp` installed,\n   * even if the plugin is not added to the plugins array.\n   */\n  let pluginConfig: SanitizedMCPPluginConfig\n  try {\n    pluginConfig = getPluginConfig({ config: payload.config })\n  } catch {\n    pluginConfig = sanitizeMCPConfig({ config: payload.config, pluginConfig: {} })\n\n    const fakePluginFn: Plugin = (config) => config\n    fakePluginFn.slug = '@payloadcms/plugin-mcp'\n    // @ts-expect-error\n    fakePluginFn.sanitizedOptions = pluginConfig\n\n    // Push to payload config, to ensure consecutive calls to `getPluginConfig()` work\n    ;(payload.config.plugins ??= []).push(fakePluginFn)\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 server = buildMcpServer({ authorizedMCP, pluginConfig, req })\n\n  const transport = new StdioServerTransport()\n  await server.connect(transport)\n\n  // Process now lives until stdin closes. Wire graceful shutdown so DB\n  // connections (and any other Payload-managed resources) get released.\n  const shutdown = async (code = 0) => {\n    try {\n      await server.close()\n    } catch (err) {\n      console.error('[payload-mcp] error closing server:', err)\n    }\n    try {\n      await payload.destroy()\n    } catch (err) {\n      console.error('[payload-mcp] error destroying payload:', err)\n    }\n    process.exit(code)\n  }\n\n  process.on('SIGINT', () => void shutdown(0))\n  process.on('SIGTERM', () => void shutdown(0))\n  process.stdin.on('close', () => void shutdown(0))\n}\n"],"names":["StdioServerTransport","fileURLToPath","pathToFileURL","createLocalReq","getPayload","findConfig","getAuthorizedMCP","buildMcpServer","sanitizeMCPConfig","getPluginConfig","resolveProjectRoot","runMcpStdio","projectRoot","url","process","chdir","configPath","configModule","toString","config","default","payload","pluginConfig","fakePluginFn","slug","sanitizedOptions","plugins","push","overrideAccessEnv","env","PAYLOAD_MCP_OVERRIDE_ACCESS","overrideAccess","Error","NODE_ENV","headers","Headers","PAYLOAD_MCP_AUTHORIZATION","set","req","payloadAPI","authorizedMCP","server","transport","connect","shutdown","code","close","err","console","error","destroy","exit","on","stdin"],"mappings":"AAEA,6BAA6B,GAC7B,SAASA,oBAAoB,QAAQ,+BAA8B;AACnE,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;;;;;;CAMC,GACD,OAAO,MAAMC,cAAc;IACzB;;;;;;;;;GASC,GACD,MAAMC,cAAcF,mBAAmBT,cAAc,YAAYY,GAAG;IACpE,IAAID,aAAa;QACfE,QAAQC,KAAK,CAACH;IAChB;IAEA,MAAMI,aAAaX;IACnB,MAAMY,eAAe,MAAM,MAAM,CAACf,cAAcc,YAAYE,QAAQ;IACpE,MAAMC,SAAU,MAAOF,CAAAA,aAAaG,OAAO,IAAIH,YAAW;IAE1D,MAAMI,UAAU,MAAMjB,WAAW;QAAEe;IAAO;IAE1C;;;;;GAKC,GACD,IAAIG;IACJ,IAAI;QACFA,eAAeb,gBAAgB;YAAEU,QAAQE,QAAQF,MAAM;QAAC;IAC1D,EAAE,OAAM;QACNG,eAAed,kBAAkB;YAAEW,QAAQE,QAAQF,MAAM;YAAEG,cAAc,CAAC;QAAE;QAE5E,MAAMC,eAAuB,CAACJ,SAAWA;QACzCI,aAAaC,IAAI,GAAG;QACpB,mBAAmB;QACnBD,aAAaE,gBAAgB,GAAGH;QAG9BD,CAAAA,QAAQF,MAAM,CAACO,OAAO,KAAK,EAAE,AAAD,EAAGC,IAAI,CAACJ;IACxC;IAEA,MAAMK,oBAAoBd,QAAQe,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,kBAAkBjB,QAAQe,GAAG,CAACI,QAAQ,KAAK,eAAe;QAC5D,MAAM,IAAID,MAAM;IAClB;IAEA,MAAME,UAAU,IAAIC;IACpB,IAAIrB,QAAQe,GAAG,CAACO,yBAAyB,EAAE;QACzCF,QAAQG,GAAG,CAAC,iBAAiBvB,QAAQe,GAAG,CAACO,yBAAyB;IACpE;IAEA,MAAME,MAAM,MAAMnC,eAAe;QAAEmC,KAAK;YAAEJ;QAAQ;IAAE,GAAGb;IACvDiB,IAAIC,UAAU,GAAG;IACjB,MAAMC,gBAAgB,MAAMlC,iBAAiB;QAAEyB;QAAgBO;IAAI;IAEnE,MAAMG,SAASlC,eAAe;QAAEiC;QAAelB;QAAcgB;IAAI;IAEjE,MAAMI,YAAY,IAAI1C;IACtB,MAAMyC,OAAOE,OAAO,CAACD;IAErB,qEAAqE;IACrE,sEAAsE;IACtE,MAAME,WAAW,OAAOC,OAAO,CAAC;QAC9B,IAAI;YACF,MAAMJ,OAAOK,KAAK;QACpB,EAAE,OAAOC,KAAK;YACZC,QAAQC,KAAK,CAAC,uCAAuCF;QACvD;QACA,IAAI;YACF,MAAM1B,QAAQ6B,OAAO;QACvB,EAAE,OAAOH,KAAK;YACZC,QAAQC,KAAK,CAAC,2CAA2CF;QAC3D;QACAjC,QAAQqC,IAAI,CAACN;IACf;IAEA/B,QAAQsC,EAAE,CAAC,UAAU,IAAM,KAAKR,SAAS;IACzC9B,QAAQsC,EAAE,CAAC,WAAW,IAAM,KAAKR,SAAS;IAC1C9B,QAAQuC,KAAK,CAACD,EAAE,CAAC,SAAS,IAAM,KAAKR,SAAS;AAChD,EAAC"}