@payloadcms/plugin-mcp 4.0.0-internal.4804abd → 4.0.0-internal.4a6b4c3

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CallToolResult,\n  ContentBlock,\n  JsonSchemaType,\n  McpServer,\n  ResourceTemplate,\n  ServerContext,\n  StandardSchemaWithJSON,\n  ToolAnnotations,\n} from '@modelcontextprotocol/server'\nimport type {\n  AuthCollectionSlug,\n  CollectionSlug,\n  GlobalSlug,\n  MaybePromise,\n  PayloadRequest,\n  SanitizedPermissions,\n  TypedUser,\n} from 'payload'\n\nimport type { GetAuthorizedMCPArgs } from './endpoint/access.js'\nimport type {\n  MCPCollectionAuthToolName,\n  MCPCollectionBuiltinName,\n  MCPGlobalBuiltinName,\n} from './mcp/builtinTools.js'\n\nexport type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName }\n\n/** Re-exported from `@modelcontextprotocol/server` — common MCP types used in plugin config. */\nexport type { JsonSchemaType, StandardSchemaWithJSON, ToolAnnotations }\n\n/**\n * What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw\n * JSON Schema literal, or a Standard Schema instance (Zod, Valibot, …).\n */\nexport type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON\n\nexport type MCPToolResponse = {\n  content: ContentBlock[]\n  /**\n   * If available, return the document fetched within the\n   * mcp tool. This is threaded as an additional argument to\n   * overrideResponse functions and stripped before going on the wire.\n   */\n  doc?: Record<string, unknown>\n} & Pick<CallToolResult, '_meta' | 'isError' | 'structuredContent'>\n\nexport type MCPResponseOverride = (\n  response: MCPToolResponse,\n  doc: Record<string, unknown>,\n  req: PayloadRequest,\n) => MCPToolResponse\n\n/**\n * The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets\n * its inferred output; anything else falls back to `Record<string, unknown>`.\n */\nexport type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON\n  ? StandardSchemaWithJSON extends TSchema\n    ? Record<string, unknown>\n    : StandardSchemaWithJSON.InferOutput<TSchema>\n  : Record<string, unknown>\n\nexport type MCPAccessArgs = {\n  permissions?: SanitizedPermissions\n  req: PayloadRequest\n}\n\nexport type CollectionMCPAccessArgs = {\n  collectionSlug: CollectionSlug\n} & MCPAccessArgs\n\nexport type GlobalMCPAccessArgs = {\n  globalSlug: GlobalSlug\n} & MCPAccessArgs\n\nexport type ToolHandlerArgs<TSchema = undefined> = {\n  authorizedMCP: AuthorizedMCP\n  input: TypedInput<TSchema>\n  req: PayloadRequest\n  serverContext: ServerContext\n}\n\nexport type CollectionToolHandlerArgs<TSchema = undefined> = {\n  collectionSlug: CollectionSlug\n} & ToolHandlerArgs<TSchema>\n\nexport type GlobalToolHandlerArgs<TSchema = undefined> = {\n  globalSlug: GlobalSlug\n} & ToolHandlerArgs<TSchema>\n\nexport type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description: string\n  handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n  input?: TSchema\n  /**\n   * Override the return value of the tool handler\n   */\n  overrideResponse?: MCPResponseOverride\n}\n\nexport type CollectionTool<\n  TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,\n> = {\n  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>\n  handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n  input?: TSchema\n} & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>\n\nexport type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =\n  {\n    access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>\n    handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n    input?: TSchema\n  } & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>\n\n/**\n * Configures (or disables) a built-in tool without replacing it.\n * `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a\n * required handler) from being silently accepted at a built-in key slot.\n */\nexport type MCPBuiltInCollectionToolOverride = {\n  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description?: string\n  handler?: never\n  overrideResponse?: MCPResponseOverride\n}\n\nexport type MCPBuiltInGlobalToolOverride = {\n  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description?: string\n  handler?: never\n  overrideResponse?: MCPResponseOverride\n}\n\n/**\n * Value at a custom (non-built-in) tool key. Either the tool itself, or `false`\n * to disable it (useful when one plugin defines a custom tool and another\n * wants to opt out per-collection).\n */\nexport type MCPTopLevelToolEntry = Tool\n\nexport type MCPCollectionToolsMap = {\n  [customToolName: string]: boolean | CollectionTool | MCPBuiltInCollectionToolOverride | undefined\n} & {\n  [K in MCPCollectionBuiltinName]?: false | MCPBuiltInCollectionToolOverride\n}\n\nexport type MCPAuthCollectionToolsMap = {\n  [K in MCPCollectionAuthToolName]?: MCPBuiltInCollectionToolOverride | true\n} & MCPCollectionToolsMap\n\n/** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */\nexport type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends AuthCollectionSlug\n  ? MCPAuthCollectionToolsMap\n  : MCPCollectionToolsMap\n\nexport type MCPGlobalToolsMap = {\n  [customToolName: string]: boolean | GlobalTool | MCPBuiltInGlobalToolOverride | undefined\n} & {\n  [K in MCPGlobalBuiltinName]?: false | MCPBuiltInGlobalToolOverride\n}\n\nexport type MCPTopLevelToolsMap = Record<string, Tool>\n\nexport type PromptHandlerArgs<TSchema = undefined> = {\n  input: TypedInput<TSchema>\n  req: PayloadRequest\n  serverContext: ServerContext\n}\n\nexport type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  argsSchema: TSchema\n  description: string\n  handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{\n    messages: Array<{ content: { text: string; type: 'text' }; role: 'assistant' | 'user' }>\n  }>\n  title: string\n}\n\nexport type ResourceHandlerArgs = {\n  /** Variables extracted from a `ResourceTemplate` URI. Empty for static-URI resources. */\n  params: Record<string, string>\n  req: PayloadRequest\n  serverContext: ServerContext\n  uri: URL\n}\n\nexport type Resource = {\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  description: string\n  handler: (args: ResourceHandlerArgs) => MaybePromise<{\n    contents: Array<{ text: string; uri: string }>\n  }>\n  mimeType: string\n  title: string\n  uri: ResourceTemplate | string\n}\n\nexport type MCPPluginCollectionConfig<TSlug extends CollectionSlug> = {\n  description?: string\n  /** Fallback for built-in tools that don't set their own `overrideResponse`. */\n  overrideResponse?: MCPResponseOverride\n  tools?: MCPToolsMapForCollection<TSlug>\n}\n\nexport type MCPPluginGlobalConfig = {\n  description?: string\n  overrideResponse?: MCPResponseOverride\n  tools?: MCPGlobalToolsMap\n}\n\n/**\n * The user-facing config shape passed to `mcpPlugin({ ... })`. Tools, prompts,\n * resources, and per-collection/global tool maps live in their own nested\n * fields. `sanitizeMCPConfig` flattens those into `items` and applies defaults\n * to produce a `SanitizedMCPPluginConfig` — the form every internal consumer\n * actually works with.\n */\nexport type MCPPluginConfig = {\n  collections?: {\n    [Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>\n  }\n  /** Skip MCP endpoint registration. */\n  disabled?: boolean\n  globals?: {\n    [Slug in GlobalSlug]?: MCPPluginGlobalConfig\n  }\n  mcp?: {\n    serverOptions?: MCPServerOptions\n    verboseLogs?: boolean\n  }\n  /** Replace the default MCP authorization resolver. */\n  overrideGetAuthorizedMCP?: (\n    args: {\n      pluginConfig: SanitizedMCPPluginConfig\n    } & GetAuthorizedMCPArgs,\n  ) => MaybePromise<AuthorizedMCP>\n  prompts?: Record<string, Prompt>\n  resources?: Record<string, Resource>\n  /** Cross-cutting tools (not scoped to any collection or global). */\n  tools?: MCPTopLevelToolsMap\n}\n\nexport type SanitizedMCPPluginConfig = {\n  items: MCPItem[]\n} & Pick<MCPPluginConfig, 'disabled' | 'mcp' | 'overrideGetAuthorizedMCP'>\n\nexport type MCPServerOptions = {\n  options?: ConstructorParameters<typeof McpServer>[1]\n  serverInfo?: Partial<ConstructorParameters<typeof McpServer>[0]>\n}\n\n/**\n * One MCP primitive plus the metadata needed for config-driven filtering and\n * registration.\n *\n * - `configKey`: the config identifier, e.g. `find` or `echo`.\n * - `mcpName`: the MCP wire name, e.g. `findDocuments` or `echo`.\n * - `label`: human-readable display text.\n */\nexport type MCPItemBase = {\n  configKey: string\n  label: string\n  mcpName: string\n}\n\nexport type CollectionMCPItem = {\n  collectionSlug: CollectionSlug\n  tool: CollectionTool\n  type: 'collectionTool'\n} & MCPItemBase\n\nexport type GlobalMCPItem = {\n  globalSlug: GlobalSlug\n  tool: GlobalTool\n  type: 'globalTool'\n} & MCPItemBase\n\nexport type MCPItem =\n  | ({\n      prompt: Prompt\n      type: 'prompt'\n    } & MCPItemBase)\n  | ({\n      resource: Resource\n      type: 'resource'\n    } & MCPItemBase)\n  | ({\n      tool: Tool\n      type: 'tool'\n    } & MCPItemBase)\n  | CollectionMCPItem\n  | GlobalMCPItem\n\n/**\n * The caller's identity + the MCP items authorized for this request. Disabled\n * items and items blocked by access callbacks or Payload operation access are\n * absent from `items`. Tool handlers receive this via `args.authorizedMCP` so\n * they can spread `localAPIDefaults(authorizedMCP)` into every local API call.\n */\nexport type AuthorizedMCP = {\n  items: MCPItem[]\n  overrideAccess: boolean\n  user: null | TypedUser\n}\n"],"names":[],"mappings":"AA6SA;;;;;CAKC,GACD,WAIC"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CallToolResult,\n  ContentBlock,\n  Implementation,\n  JsonSchemaType,\n  McpServerOptions,\n  ResourceTemplate,\n  ServerContext,\n  StandardSchemaWithJSON,\n  ToolAnnotations,\n} from '@modelcontextprotocol/server'\nimport type {\n  AuthCollectionSlug,\n  CollectionSlug,\n  GlobalSlug,\n  MaybePromise,\n  PayloadRequest,\n  SanitizedPermissions,\n} from 'payload'\n\nimport type { GetAuthorizedMCPArgs } from './endpoint/access.js'\nimport type {\n  MCPCollectionAuthToolName,\n  MCPCollectionBuiltinName,\n  MCPGlobalBuiltinName,\n} from './mcp/builtinTools.js'\n\nexport type { MCPCollectionAuthToolName, MCPCollectionBuiltinName, MCPGlobalBuiltinName }\n\n/** Re-exported from `@modelcontextprotocol/server` — common MCP types used in plugin config. */\nexport type { JsonSchemaType, StandardSchemaWithJSON, ToolAnnotations }\n\n/**\n * What a tool's `input` (or a prompt's `argsSchema`) can be — either a raw\n * JSON Schema 2020-12 literal, or a Standard Schema instance (Zod, Valibot, …).\n * Raw schemas may omit `$schema`; when present it must declare the 2020-12 dialect.\n */\nexport type ToolInputSchema = JsonSchemaType | StandardSchemaWithJSON\n\nexport type MCPToolResponse = {\n  content: ContentBlock[]\n  /**\n   * If available, return the document fetched within the\n   * mcp tool. This is threaded as an additional argument to\n   * overrideResponse functions and stripped before going on the wire.\n   */\n  doc?: Record<string, unknown>\n} & Pick<CallToolResult, '_meta' | 'isError' | 'structuredContent'>\n\nexport type MCPResponseOverride = (\n  response: MCPToolResponse,\n  doc: Record<string, unknown>,\n  req: PayloadRequest,\n) => MCPToolResponse\n\nexport type MCPAfterToolCallHook = (args: {\n  input: unknown\n  req: PayloadRequest\n  response: MCPToolResponse\n  toolName: string\n}) => MaybePromise<MCPToolResponse>\n\n/**\n * The handler's `input` type. A specific Standard Schema (Zod, Valibot, …) gets\n * its inferred output; anything else falls back to `Record<string, unknown>`.\n */\nexport type TypedInput<TSchema> = TSchema extends StandardSchemaWithJSON\n  ? StandardSchemaWithJSON extends TSchema\n    ? Record<string, unknown>\n    : StandardSchemaWithJSON.InferOutput<TSchema>\n  : Record<string, unknown>\n\nexport type MCPAccessArgs = {\n  permissions?: SanitizedPermissions\n  req: PayloadRequest\n}\n\nexport type CollectionMCPAccessArgs = {\n  slug: CollectionSlug\n} & MCPAccessArgs\n\nexport type GlobalMCPAccessArgs = {\n  slug: GlobalSlug\n} & MCPAccessArgs\n\nexport type ToolHandlerArgs<TSchema = undefined> = {\n  authorizedMCP: AuthorizedMCP\n  input: TypedInput<TSchema>\n  req: PayloadRequest\n  serverContext: ServerContext\n}\n\nexport type CollectionToolHandlerArgs<TSchema = undefined> = {\n  slug: CollectionSlug\n} & ToolHandlerArgs<TSchema>\n\nexport type GlobalToolHandlerArgs<TSchema = undefined> = {\n  slug: GlobalSlug\n} & ToolHandlerArgs<TSchema>\n\nexport type Tool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> = {\n  /**\n   * Runs while authorizing each MCP request, before the tool is advertised or called. Return\n   * `false` to make the tool unavailable for that request. This is skipped when `overrideAccess`\n   * is enabled.\n   */\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description: string\n  handler: (args: ToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n  input?: TSchema\n  /**\n   * Override the return value of the tool handler\n   */\n  overrideResponse?: MCPResponseOverride\n}\n\nexport type CollectionTool<\n  TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined,\n> = {\n  /**\n   * Runs while authorizing each MCP request for this collection. Return `false` to reject calls\n   * to this tool for the collection. The shared tool is not advertised when no collections allow\n   * it, but can remain advertised when it is available for another collection. This is skipped\n   * when `overrideAccess` is enabled.\n   */\n  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>\n  handler: (args: CollectionToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n  input?: TSchema\n} & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>\n\nexport type GlobalTool<TSchema extends ToolInputSchema | undefined = ToolInputSchema | undefined> =\n  {\n    /**\n     * Runs while authorizing each MCP request for this global. Return `false` to reject calls to\n     * this tool for the global. The shared tool is not advertised when no globals allow it, but\n     * can remain advertised when it is available for another global. This is skipped when\n     * `overrideAccess` is enabled.\n     */\n    access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>\n    handler: (args: GlobalToolHandlerArgs<TSchema>) => MaybePromise<MCPToolResponse>\n    input?: TSchema\n  } & Pick<Tool, 'annotations' | 'description' | 'overrideResponse'>\n\n/**\n * Configures (or disables) a built-in tool without replacing it.\n * `handler?: never` prevents a full `CollectionTool`/`GlobalTool` (which has a\n * required handler) from being silently accepted at a built-in key slot.\n */\nexport type MCPBuiltInCollectionToolOverride = {\n  /**\n   * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for\n   * this collection. This is skipped when `overrideAccess` is enabled.\n   */\n  access?: (args: CollectionMCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description?: string\n  handler?: never\n  overrideResponse?: MCPResponseOverride\n}\n\nexport type MCPBuiltInGlobalToolOverride = {\n  /**\n   * Replaces the built-in tool's access check. Return `false` to make the tool unavailable for\n   * this global. This is skipped when `overrideAccess` is enabled.\n   */\n  access?: (args: GlobalMCPAccessArgs) => MaybePromise<boolean>\n  annotations?: ToolAnnotations\n  description?: string\n  handler?: never\n  overrideResponse?: MCPResponseOverride\n}\n\n/**\n * Value at a custom (non-built-in) tool key. Either the tool itself, or `false`\n * to disable it (useful when one plugin defines a custom tool and another\n * wants to opt out per-collection).\n */\nexport type MCPTopLevelToolEntry = Tool\n\nexport type MCPCollectionToolsMap = {\n  [customToolName: string]: boolean | CollectionTool | MCPBuiltInCollectionToolOverride | undefined\n} & {\n  [K in MCPCollectionBuiltinName]?: false | MCPBuiltInCollectionToolOverride\n}\n\nexport type MCPAuthCollectionToolsMap = {\n  [K in MCPCollectionAuthToolName]?: MCPBuiltInCollectionToolOverride | true\n} & MCPCollectionToolsMap\n\n/** Auth-enabled collections get auth-tool name autocomplete; others get CRUD-only. */\nexport type MCPToolsMapForCollection<Slug extends CollectionSlug> = Slug extends AuthCollectionSlug\n  ? MCPAuthCollectionToolsMap\n  : MCPCollectionToolsMap\n\nexport type MCPGlobalToolsMap = {\n  [customToolName: string]: boolean | GlobalTool | MCPBuiltInGlobalToolOverride | undefined\n} & {\n  [K in MCPGlobalBuiltinName]?: false | MCPBuiltInGlobalToolOverride\n}\n\nexport type MCPTopLevelToolsMap = Record<string, Tool>\n\nexport type PromptHandlerArgs<TSchema = undefined> = {\n  input: TypedInput<TSchema>\n  req: PayloadRequest\n  serverContext: ServerContext\n}\n\nexport type Prompt<TSchema extends ToolInputSchema = ToolInputSchema> = {\n  /**\n   * Runs while authorizing each MCP request, before the prompt is advertised or used. Return\n   * `false` to make the prompt unavailable for that request. This is skipped when\n   * `overrideAccess` is enabled.\n   */\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  argsSchema: TSchema\n  description: string\n  handler: (args: PromptHandlerArgs<TSchema>) => MaybePromise<{\n    messages: Array<{ content: { text: string; type: 'text' }; role: 'assistant' | 'user' }>\n  }>\n  title: string\n}\n\nexport type ResourceHandlerArgs = {\n  /** Variables extracted from a `ResourceTemplate` URI. Empty for static-URI resources. */\n  params: Record<string, string>\n  req: PayloadRequest\n  serverContext: ServerContext\n  uri: URL\n}\n\nexport type Resource = {\n  /**\n   * Runs while authorizing each MCP request, before the resource is advertised or read. Return\n   * `false` to make the resource unavailable for that request. This is skipped when\n   * `overrideAccess` is enabled.\n   */\n  access?: (args: MCPAccessArgs) => MaybePromise<boolean>\n  description: string\n  handler: (args: ResourceHandlerArgs) => MaybePromise<{\n    contents: Array<{ text: string; uri: string }>\n  }>\n  mimeType: string\n  title: string\n  uri: ResourceTemplate | string\n}\n\nexport type MCPPluginCollectionConfig<TSlug extends CollectionSlug> = {\n  description?: string\n  /** Fallback for built-in tools that don't set their own `overrideResponse`. */\n  overrideResponse?: MCPResponseOverride\n  tools?: MCPToolsMapForCollection<TSlug>\n}\n\nexport type MCPPluginGlobalConfig = {\n  description?: string\n  overrideResponse?: MCPResponseOverride\n  tools?: MCPGlobalToolsMap\n}\n\n/**\n * The user-facing config shape passed to `mcpPlugin({ ... })`. Tools, prompts,\n * resources, and per-collection/global tool maps live in their own nested\n * fields. `sanitizeMCPConfig` flattens those into `items` and applies defaults\n * to produce a `SanitizedMCPPluginConfig` — the form every internal consumer\n * actually works with.\n */\nexport type MCPPluginConfig = {\n  collections?: {\n    [Slug in CollectionSlug]?: MCPPluginCollectionConfig<Slug>\n  }\n  /** Skip MCP endpoint registration. */\n  disabled?: boolean\n  globals?: {\n    [Slug in GlobalSlug]?: MCPPluginGlobalConfig\n  }\n  hooks?: {\n    /** Transform a tool response after its handler returns */\n    afterToolCall?: MCPAfterToolCallHook[]\n  }\n  mcp?: {\n    /**\n     * Largest HTTP request body, in bytes, that the MCP endpoint accepts. Larger requests\n     * are answered with `413`. Base64 file uploads count toward this limit.\n     *\n     * @default 4194304 (4 MiB, the MCP SDK default)\n     */\n    maxRequestBodySize?: number\n    serverOptions?: MCPServerOptions\n    verboseLogs?: boolean\n  }\n  /**\n   * Lets MCP clients sign in through an OAuth authorization server. MCP requests without an\n   * authenticated user get a `401` that points to the protected resource metadata (RFC 9728),\n   * served by `oauthProtectedResourceHandler`. Payload's auth strategies must accept the\n   * issued access tokens.\n   */\n  oauth?: {\n    /**\n     * Called on MCP requests with a bearer token that Payload's auth strategies didn't accept.\n     *  Return the Payload user, including its `collection`, or `null` to answer with the OAuth challenge.\n     */\n    authenticate?: (args: {\n      req: PayloadRequest\n      token: string\n    }) => MaybePromise<PayloadRequest['user']>\n    /**\n     * The authorization servers that issue access tokens for MCP clients. Clients require each one\n     * to exactly match the `issuer` in that server's metadata, so pass a function when the exact\n     * value is only known at runtime, e.g. from the server's OpenID configuration or per host.\n     */\n    authorizationServers: ((args: { req: PayloadRequest }) => MaybePromise<string[]>) | string[]\n    /**\n     * The URL clients call to reach the MCP endpoint.\n     *\n     * @default the absolute URL of `/api/mcp`, based on `serverURL` or the request URL\n     */\n    resource?: string\n    /**\n     * Scopes MCP clients should request, e.g. `['openid', 'email', 'profile']`. Without them,\n     * clients request none, which some authorization servers reject or answer with a token that\n     * doesn't identify the user.\n     */\n    scopes?: string[]\n  }\n  /**\n   * Replace the default MCP authorization resolver.\n   *\n   * This hook replaces the default authentication flow. It must set `req.user` to the\n   * authenticated Payload user, or to `null` for an anonymous caller, before returning.\n   */\n  overrideGetAuthorizedMCP?: (\n    args: {\n      pluginConfig: SanitizedMCPPluginConfig\n    } & GetAuthorizedMCPArgs,\n  ) => MaybePromise<AuthorizedMCP>\n  prompts?: Record<string, Prompt>\n  resources?: Record<string, Resource>\n  /** Cross-cutting tools (not scoped to any collection or global). */\n  tools?: MCPTopLevelToolsMap\n}\n\nexport type SanitizedMCPPluginConfig = {\n  items: MCPItem[]\n} & Pick<MCPPluginConfig, 'disabled' | 'hooks' | 'mcp' | 'oauth' | 'overrideGetAuthorizedMCP'>\n\nexport type MCPServerOptions = {\n  options?: McpServerOptions\n  serverInfo?: Partial<Implementation>\n}\n\n/**\n * One MCP primitive plus the metadata needed for config-driven filtering and\n * registration.\n *\n * - `configKey`: the config identifier, e.g. `find` or `echo`.\n * - `mcpName`: the MCP wire name, e.g. `findDocuments` or `echo`.\n * - `label`: human-readable display text.\n */\nexport type MCPItemBase = {\n  configKey: string\n  label: string\n  mcpName: string\n}\n\nexport type CollectionMCPItem = {\n  collectionSlug: CollectionSlug\n  tool: CollectionTool\n  type: 'collectionTool'\n} & MCPItemBase\n\nexport type GlobalMCPItem = {\n  globalSlug: GlobalSlug\n  tool: GlobalTool\n  type: 'globalTool'\n} & MCPItemBase\n\nexport type MCPItem =\n  | ({\n      prompt: Prompt\n      type: 'prompt'\n    } & MCPItemBase)\n  | ({\n      resource: Resource\n      type: 'resource'\n    } & MCPItemBase)\n  | ({\n      tool: Tool\n      type: 'tool'\n    } & MCPItemBase)\n  | CollectionMCPItem\n  | GlobalMCPItem\n\n/**\n * The MCP items and access mode authorized for this request. The authenticated user is available\n * as `req.user`.\n */\nexport type AuthorizedMCP = {\n  items: MCPItem[]\n  overrideAccess: boolean\n}\n"],"names":[],"mappings":"AA0YA;;;CAGC,GACD,WAGC"}

package/dist/utils/camelCase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"camelCase.d.ts","sourceRoot":"","sources":["../../src/utils/camelCase.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,KAAK,MAAM,KAAG,MAIzC,CAAA"}
+{"version":3,"file":"camelCase.d.ts","sourceRoot":"","sources":["../../src/utils/camelCase.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,QAAS,MAAM,KAAG,MAIzC,CAAA"}

package/dist/utils/resolveProjectRoot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveProjectRoot.d.ts","sourceRoot":"","sources":["../../src/utils/resolveProjectRoot.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,MAAM,KAAG,IAAI,GAAG,MAS5D,CAAA"}
+{"version":3,"file":"resolveProjectRoot.d.ts","sourceRoot":"","sources":["../../src/utils/resolveProjectRoot.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,KAAG,IAAI,GAAG,MAS5D,CAAA"}

package/dist/utils/toStandardSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toStandardSchema.d.ts","sourceRoot":"","sources":["../../src/utils/toStandardSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AAE1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,gIAAgI;AAChI,eAAO,MAAM,gBAAgB,GAAI,QAAQ,eAAe,KAAG,sBAG/B,CAAA"}
+{"version":3,"file":"toStandardSchema.d.ts","sourceRoot":"","sources":["../../src/utils/toStandardSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AAE1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,gIAAgI;AAChI,eAAO,MAAM,gBAAgB,WAAY,eAAe,KAAG,sBAG/B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-mcp",
-  "version": "4.0.0-internal.4804abd",
+  "version": "4.0.0-internal.4a6b4c3",
   "description": "MCP (Model Context Protocol) capabilities with Payload",
   "keywords": [
     "plugin",
@@ -39,9 +39,9 @@
       "default": "./dist/stdio.js"
     },
     "./internal": {
-      "import": "./dist/internal.js",
-      "types": "./dist/internal.d.ts",
-      "default": "./dist/internal.js"
+      "import": "./dist/exports/internal.js",
+      "types": "./dist/exports/internal.d.ts",
+      "default": "./dist/exports/internal.js"
     }
   },
   "main": "./dist/index.js",
@@ -55,21 +55,17 @@
     "bin.js"
   ],
   "dependencies": {
-    "@cfworker/json-schema": "^4.1.1",
-    "@modelcontextprotocol/server": "2.0.0-alpha.2",
-    "tsx": "4.22.4",
-    "zod": "^4.0.0"
+    "@modelcontextprotocol/server": "2.3.1",
+    "tsx": "4.23.15"
   },
   "devDependencies": {
     "@payloadcms/eslint-config": "3.28.0",
-    "payload": "4.0.0-internal.4804abd"
+    "payload": "4.0.0-internal.4a6b4c3"
   },
   "peerDependencies": {
-    "payload": "4.0.0-internal.4804abd"
+    "payload": "4.0.0-internal.4a6b4c3"
   },
   "//deps_notes": {
-    "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.",
-    "@cfworker/json-schema": "Should be able to remove in next @modelcontextprotocol/server alpha release. Marked as an optional peer of @modelcontextprotocol/server, but its bundle does an eager top-level `import { Validator } from '@cfworker/json-schema'`, so it must be installed even when only zod-registered tools are used. Drop once upstream lazy-loads the validator. See: https://github.com/modelcontextprotocol/typescript-sdk",
     "tsx": "Required by the `bin.js` stdio mcp. Keep the version pinned to whatever `payload` ships to avoid duplicate installs."
   },
   "homepage:": "https://payloadcms.com",
@@ -79,7 +75,7 @@
     "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
     "build:types": "tsc --emitDeclarationOnly --outDir dist",
     "clean": "rimraf {dist,*.tsbuildinfo}",
-    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
+    "copyfiles": "copyfiles -u 1 -e \"**/*.spec.*\" \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "pack:plugin": "pnpm build && pnpm pack"

package/src/endpoint/access.ts

@@ -1,6 +1,6 @@
 import type { PayloadRequest, SanitizedPermissions } from 'payload'
 
-import { getAccessResults, UnauthorizedError } from 'payload'
+import { executeAuthStrategies, getAccessResults, UnauthorizedError } from 'payload'
 
 import type { AuthorizedMCP, MCPItem } from '../types.js'
 
@@ -12,13 +12,8 @@ export type GetAuthorizedMCPArgs = {
 }
 
 /**
- * Resolves the MCP caller and returns the MCP surface authorized for that request.
- *
- * Authorization has two layers:
- * 1. Payload collection/global permissions determine whether built-in operation tools are shown.
- * 2. MCP `access` callbacks can further hide any configured tool, prompt, or resource.
- *
- * Like Payload core operations, `overrideAccess` skips both layers.
+ * Authenticates an MCP request and removes items the user cannot access.
+ * `overrideAccess` skips Payload and MCP item access checks.
  */
 export const getAuthorizedMCP: (args: GetAuthorizedMCPArgs) => Promise<AuthorizedMCP> = async ({
   overrideAccess,
@@ -39,9 +34,18 @@ export const getAuthorizedMCP: (args: GetAuthorizedMCPArgs) => Promise<Authorize
     const hasAuthorization = headers.has('Authorization')
 
     headers.set('DisableAutologin', 'true')
-    req.user = (await req.payload.auth({ headers, req })).user
+    // Not `payload.auth()`, which also computes permissions that filterMCPItems computes anyway
+    req.user = (await executeAuthStrategies({ headers, payload: req.payload, req })).user
+
+    // Only bearer tokens that no auth strategy accepted reach the hook, e.g. an OAuth access token.
+    // API keys use the `<collection> API-Key <key>` scheme instead of `Bearer`, so they never do.
+    const bearerToken = headers.get('Authorization')?.match(/^Bearer (.+)$/)?.[1]
+    if (!req.user && bearerToken && pluginConfig.oauth?.authenticate) {
+      req.user = await pluginConfig.oauth.authenticate({ req, token: bearerToken })
+    }
 
-    if (hasAuthorization && !req.user) {
+    // With OAuth, the endpoint answers with a challenge that starts the client's sign-in
+    if (hasAuthorization && !req.user && !pluginConfig.oauth) {
       throw new UnauthorizedError(req.t)
     }
   }
@@ -53,7 +57,6 @@ export const getAuthorizedMCP: (args: GetAuthorizedMCPArgs) => Promise<Authorize
       req,
     }),
     overrideAccess,
-    user: req.user,
   }
 }
 
@@ -66,8 +69,7 @@ export const filterMCPItems = async ({
   overrideAccess: boolean
   req: PayloadRequest
 }): Promise<MCPItem[]> => {
-  // Match Payload core: overrideAccess bypasses access evaluation instead of
-  // forcing each access function to return true.
+  // Match Payload core: overrideAccess bypasses access evaluation
   if (overrideAccess) {
     return items
   }
@@ -102,12 +104,11 @@ const checkItemAccess = async ({
     case 'collectionTool':
       return (
         !item.tool.access ||
-        (await item.tool.access({ collectionSlug: item.collectionSlug, permissions, req }))
+        (await item.tool.access({ slug: item.collectionSlug, permissions, req }))
       )
     case 'globalTool':
       return (
-        !item.tool.access ||
-        (await item.tool.access({ globalSlug: item.globalSlug, permissions, req }))
+        !item.tool.access || (await item.tool.access({ slug: item.globalSlug, permissions, req }))
       )
     case 'prompt':
       return !item.prompt.access || (await item.prompt.access({ permissions, req }))

package/src/endpoint/index.ts

@@ -1,9 +1,17 @@
-import { WebStandardStreamableHTTPServerTransport } from '@modelcontextprotocol/server'
-import { APIError, type PayloadHandler } from 'payload'
+import type { PayloadHandler, PayloadRequest } from 'payload'
+
+import {
+  createMcpHandler,
+  isLegacyRequest,
+  readRequestBody,
+  WebStandardStreamableHTTPServerTransport,
+} from '@modelcontextprotocol/server'
+import { APIError } from 'payload'
 
 import { buildMcpServer } from '../mcp/buildMcpServer.js'
 import { getPluginConfig } from '../utils/getPluginConfig.js'
 import { getAuthorizedMCP } from './access.js'
+import { getMCPResource, oauthChallenge } from './oauth.js'
 
 export const mcpEndpoint: PayloadHandler = async (req) => {
   if (!req.url) {
@@ -11,6 +19,8 @@ export const mcpEndpoint: PayloadHandler = async (req) => {
   }
 
   req.payloadAPI = 'MCP' as const
+  // Lets auth strategies check that an OAuth access token was issued for this MCP server
+  req.context.mcp = { resource: getMCPResource({ config: req.payload.config, url: req.url }) }
 
   const pluginConfig = getPluginConfig({ config: req.payload.config })
   const overrideAccessParam = new URL(req.url).searchParams.get('overrideAccess')
@@ -28,21 +38,78 @@ export const mcpEndpoint: PayloadHandler = async (req) => {
 
   const authorizedMCP = await getAuthorizedMCP({ overrideAccess, req })
 
-  const server = buildMcpServer({ authorizedMCP, pluginConfig, req })
+  if (pluginConfig.oauth && !req.user) {
+    return oauthChallenge({ req })
+  }
+
+  const maxRequestBodySize = pluginConfig.mcp?.maxRequestBodySize
+  // Payload augments the original web-standard Request in place.
+  const mcpRequest = req as PayloadRequest & Request
+  const parsedBody = await parseRequestBody({ maxRequestBodySize, request: mcpRequest })
+
+  // Keep the old JSON-only, stateless behavior because the SDK's 2025 fallback uses SSE.
+  if (await isLegacyRequest(mcpRequest, parsedBody, { maxRequestBodySize })) {
+    const server = buildMcpServer({ authorizedMCP, pluginConfig, req })
+    const transport = new WebStandardStreamableHTTPServerTransport({
+      enableJsonResponse: true,
+      maxRequestBodySize,
+      sessionIdGenerator: undefined, // stateless mode
+    })
+    transport.onerror = (err) => {
+      req.payload.logger.error({ err, msg: 'Error serving legacy MCP request' })
+    }
+
+    try {
+      await server.connect(transport)
+      return await transport.handleRequest(mcpRequest, { parsedBody })
+    } finally {
+      await server.close().catch((err) => {
+        req.payload.logger.error({ err, msg: 'Error closing MCP server' })
+      })
+    }
+  }
 
-  const transport = new WebStandardStreamableHTTPServerTransport({
-    enableJsonResponse: true,
-    sessionIdGenerator: undefined, // stateless mode
+  const handler = createMcpHandler(() => buildMcpServer({ authorizedMCP, pluginConfig, req }), {
+    legacy: 'reject',
+    maxRequestBodySize,
+    // SDK subscriptions always use SSE, so disable them to keep every response JSON-only.
+    maxSubscriptions: 0,
+    onerror: (err) => {
+      req.payload.logger.error({ err, msg: 'Error serving modern MCP request' })
+    },
+    responseMode: 'json',
   })
 
-  await server.connect(transport)
+  try {
+    return await handler.fetch(mcpRequest, { parsedBody })
+  } finally {
+    await handler.close().catch((err) => {
+      req.payload.logger.error({ err, msg: 'Error closing modern MCP handler' })
+    })
+  }
+}
 
-  const mcpRequest = new Request(req.url, {
-    body: req.body,
-    duplex: 'half',
-    headers: req.headers,
-    method: req.method,
-  } as { duplex: 'half' } & RequestInit)
+/**
+ * Parses a POST body once so the era check and the SDK handler can share it. The SDK
+ * skips its size limit for a pre-parsed body, so this reads with the same limit. It reads
+ * a clone and returns `undefined` for any body the SDK should reject (too large, unreadable,
+ * or not JSON), leaving the original request for the SDK to read and answer.
+ */
+const parseRequestBody = async ({
+  maxRequestBodySize,
+  request,
+}: {
+  maxRequestBodySize?: number
+  request: Request
+}): Promise<unknown> => {
+  if (request.method.toUpperCase() !== 'POST') {
+    return undefined
+  }
 
-  return await transport.handleRequest(mcpRequest)
+  try {
+    const body = await readRequestBody(request.clone(), maxRequestBodySize)
+    return body.tooLarge ? undefined : JSON.parse(body.text)
+  } catch {
+    return undefined
+  }
 }

package/src/endpoint/oauth.ts

@@ -0,0 +1,84 @@
+import type { OAuthProtectedResourceMetadata } from '@modelcontextprotocol/server'
+import type { PayloadHandler, PayloadRequest, SanitizedConfig } from 'payload'
+
+import {
+  bearerAuthChallengeResponse,
+  OAuthError,
+  OAuthErrorCode,
+} from '@modelcontextprotocol/server'
+import { createPayloadRequest, getPayload } from 'payload'
+
+import { getPluginConfig } from '../utils/getPluginConfig.js'
+
+/**
+ * Serves the OAuth protected resource metadata (RFC 9728) at `/api/mcp/oauth-protected-resource`.
+ * The OAuth challenge links here, so MCP clients find the authorization server without setup.
+ */
+export const oauthProtectedResourceEndpoint: PayloadHandler = (req) => getMetadataResponse({ req })
+
+/**
+ * Serves the same metadata for clients that ignore the challenge's link and only look at
+ * `/.well-known/oauth-protected-resource`. Mount it at the site root, e.g. in Next.js at
+ * `app/.well-known/oauth-protected-resource/[[...path]]/route.ts`:
+ *
+ * ```ts
+ * import config from '@payload-config'
+ * import { oauthProtectedResourceHandler } from '@payloadcms/plugin-mcp'
+ *
+ * export const GET = oauthProtectedResourceHandler(config)
+ * ```
+ */
+export const oauthProtectedResourceHandler =
+  (config: Promise<SanitizedConfig> | SanitizedConfig) =>
+  async (request: Request): Promise<Response> =>
+    getMetadataResponse({
+      req: await createPayloadRequest({ payload: await getPayload({ config }), req: request }),
+    })
+
+/**
+ * Answers an unauthenticated MCP request with a challenge linking to the protected resource
+ * metadata, which starts the client's OAuth flow.
+ */
+export const oauthChallenge = ({ req }: { req: PayloadRequest }): Response =>
+  bearerAuthChallengeResponse(
+    new OAuthError(OAuthErrorCode.InvalidToken, req.t('error:unauthorized')),
+    {
+      requiredScopes: getPluginConfig({ config: req.payload.config }).oauth?.scopes,
+      resourceMetadataUrl: `${getMCPURL({ config: req.payload.config, url: req.url! })}/oauth-protected-resource`,
+    },
+  )
+
+/**
+ * The MCP endpoint's address, as advertised in the metadata's `resource`. Clients send it when
+ * they sign in, and authorization servers that support it put it in the access token's audience.
+ */
+export const getMCPResource = ({ config, url }: { config: SanitizedConfig; url: string }): string =>
+  getPluginConfig({ config }).oauth?.resource ?? getMCPURL({ config, url })
+
+const getMCPURL = ({ config, url }: { config: SanitizedConfig; url: string }): string =>
+  new URL(`${config.routes.api}/mcp`, config.serverURL || url).href
+
+const getMetadataResponse = async ({ req }: { req: PayloadRequest }): Promise<Response> => {
+  const { config } = req.payload
+  const pluginConfig = getPluginConfig({ config })
+
+  if (!pluginConfig.oauth) {
+    return new Response(null, { status: 404 })
+  }
+
+  const { authorizationServers, scopes } = pluginConfig.oauth
+
+  return Response.json(
+    {
+      authorization_servers:
+        typeof authorizationServers === 'function'
+          ? await authorizationServers({ req })
+          : authorizationServers,
+      bearer_methods_supported: ['header'],
+      resource: getMCPResource({ config, url: req.url! }),
+      scopes_supported: scopes,
+    } satisfies OAuthProtectedResourceMetadata,
+    // Public document, readable by browser-based MCP clients on any origin
+    { headers: { 'Access-Control-Allow-Origin': '*' } },
+  )
+}

package/src/index.ts

@@ -3,27 +3,36 @@ import { definePlugin } from 'payload'
 import type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig } from './types.js'
 
 import { mcpEndpoint } from './endpoint/index.js'
+import { oauthProtectedResourceEndpoint } from './endpoint/oauth.js'
 import { sanitizeMCPConfig } from './mcp/sanitizeMCPConfig.js'
 
 declare module 'payload' {
-  export interface PayloadRequest {
-    payloadAPI: 'GraphQL' | 'local' | 'MCP' | 'REST'
+  export interface PayloadRequestAPI {
+    MCP: true
   }
   interface RegisteredPlugins {
     /** After the plugin's `plugin` callback runs, `options` holds the sanitized config. */
     '@payloadcms/plugin-mcp': MCPPluginConfig
   }
+  export interface RequestContext {
+    /** Set on MCP requests before they're authenticated. */
+    mcp?: {
+      /** The MCP endpoint's address, which OAuth access tokens for MCP are issued for. */
+      resource: string
+    }
+  }
 }
 
 export type { AuthorizedMCP, MCPPluginConfig, SanitizedMCPPluginConfig }
 
 export { defineCollectionTool, defineGlobalTool, definePrompt, defineTool } from './defineTool.js'
+export { oauthProtectedResourceHandler } from './endpoint/oauth.js'
 
 export const mcpPlugin = definePlugin<MCPPluginConfig>({
   slug: '@payloadcms/plugin-mcp',
   order: 10,
-  plugin: ({ config, plugins, ...rawConfig }) => {
-    const pluginConfig = sanitizeMCPConfig({ config, pluginConfig: rawConfig })
+  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']
@@ -40,15 +49,23 @@ export const mcpPlugin = definePlugin<MCPPluginConfig>({
       ...config,
       endpoints: [
         ...(config.endpoints ?? []),
-        // Payload prefixes /api, so the full path is /api/mcp.
-        { handler: mcpEndpoint, method: 'post', path: '/mcp' },
+        // Payload prefixes /api, so the full path is /api/mcp. getAuthorizedMCP authenticates the
+        // request with dev auto-login turned off, so Payload doesn't authenticate it first.
+        { disableAuth: true, 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
         {
+          disableAuth: true,
           handler: () => new Response(null, { headers: { Allow: 'POST' }, status: 405 }),
           method: 'get',
           path: '/mcp',
         },
+        {
+          disableAuth: true,
+          handler: oauthProtectedResourceEndpoint,
+          method: 'get',
+          path: '/mcp/oauth-protected-resource',
+        },
       ],
     }
   },