@langchain/openai 1.1.2 → 1.2.0-dev-1765431816670

package/dist/tools/localShell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localShell.js","names":["options: LocalShellOptions"],"sources":["../../src/tools/localShell.ts"],"sourcesContent":["import { z } from \"zod/v4\";\nimport { OpenAI as OpenAIClient } from \"openai\";\nimport { tool, type DynamicStructuredTool } from \"@langchain/core/tools\";\n\n/**\n * Re-export action type from OpenAI SDK for convenience.\n * The action contains command details like argv tokens, environment variables,\n * working directory, timeout, and user.\n */\nexport type LocalShellAction =\n  OpenAIClient.Responses.ResponseOutputItem.LocalShellCall.Action;\n\n// Zod schema for local shell exec action\nexport const LocalShellExecActionSchema = z.object({\n  type: z.literal(\"exec\"),\n  command: z.array(z.string()),\n  env: z.record(z.string(), z.string()).optional(),\n  working_directory: z.string().optional(),\n  timeout_ms: z.number().optional(),\n  user: z.string().optional(),\n});\n\n// Schema for all local shell actions (currently only exec)\nexport const LocalShellActionSchema = z.discriminatedUnion(\"type\", [\n  LocalShellExecActionSchema,\n]);\n\n/**\n * Options for the Local Shell tool.\n */\nexport interface LocalShellOptions {\n  /**\n   * Optional execute function that handles shell command execution.\n   * This function receives the action input and should return the command output\n   * (stdout + stderr combined).\n   *\n   * If not provided, you'll need to handle action execution manually by\n   * checking `local_shell_call` outputs in the response.\n   *\n   * @example\n   * ```typescript\n   * execute: async (action) => {\n   *   const result = await exec(action.command.join(' '), {\n   *     cwd: action.working_directory,\n   *     env: { ...process.env, ...action.env },\n   *     timeout: action.timeout_ms,\n   *   });\n   *   return result.stdout + result.stderr;\n   * }\n   * ```\n   */\n  execute: (action: LocalShellAction) => string | Promise<string>;\n}\n\n/**\n * OpenAI Local Shell tool type for the Responses API.\n */\nexport type LocalShellTool = OpenAIClient.Responses.Tool.LocalShell;\n\nconst TOOL_NAME = \"local_shell\";\n\n/**\n * Creates a Local Shell tool that allows models to run shell commands locally\n * on a machine you provide. Commands are executed inside your own runtime—\n * the API only returns the instructions, but does not execute them on OpenAI infrastructure.\n *\n * **Important**: The local shell tool is designed to work with\n * [Codex CLI](https://github.com/openai/codex) and the `codex-mini-latest` model.\n *\n * **How it works**:\n * The tool operates in a continuous loop:\n * 1. Model sends shell commands (`local_shell_call` with `exec` action)\n * 2. Your code executes the command locally\n * 3. You return the output back to the model\n * 4. Repeat until the task is complete\n *\n * **Security Warning**: Running arbitrary shell commands can be dangerous.\n * Always sandbox execution or add strict allow/deny-lists before forwarding\n * a command to the system shell.\n *\n * @see {@link https://platform.openai.com/docs/guides/tools-local-shell | OpenAI Local Shell Documentation}\n *\n * @param options - Optional configuration for the Local Shell tool\n * @returns A Local Shell tool that can be passed to `bindTools`\n *\n * @example\n * ```typescript\n * import { ChatOpenAI, tools } from \"@langchain/openai\";\n * import { exec } from \"child_process\";\n * import { promisify } from \"util\";\n *\n * const execAsync = promisify(exec);\n * const model = new ChatOpenAI({ model: \"codex-mini-latest\" });\n *\n * // With execute callback for automatic command handling\n * const shell = tools.localShell({\n *   execute: async (action) => {\n *     const { command, env, working_directory, timeout_ms } = action;\n *     const result = await execAsync(command.join(' '), {\n *       cwd: working_directory ?? process.cwd(),\n *       env: { ...process.env, ...env },\n *       timeout: timeout_ms ?? undefined,\n *     });\n *     return result.stdout + result.stderr;\n *   },\n * });\n *\n * const llmWithShell = model.bindTools([shell]);\n * const response = await llmWithShell.invoke(\n *   \"List files in the current directory\"\n * );\n * ```\n *\n * @example\n * ```typescript\n * // Without execute callback (manual handling)\n * const shell = tools.localShell();\n *\n * const response = await model.invoke(\"List files\", {\n *   tools: [shell],\n * });\n *\n * // Access the shell call from the response\n * const shellCall = response.additional_kwargs.tool_outputs?.find(\n *   (output) => output.type === \"local_shell_call\"\n * );\n * if (shellCall) {\n *   console.log(\"Command to execute:\", shellCall.action.command);\n *   // Execute the command manually, then send back the output\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Full shell loop example\n * async function shellLoop(model, task) {\n *   let response = await model.invoke(task, {\n *     tools: [tools.localShell()],\n *   });\n *\n *   while (true) {\n *     const shellCall = response.additional_kwargs.tool_outputs?.find(\n *       (output) => output.type === \"local_shell_call\"\n *     );\n *\n *     if (!shellCall) break;\n *\n *     // Execute command (with proper sandboxing!)\n *     const output = await executeCommand(shellCall.action);\n *\n *     // Send output back to model\n *     response = await model.invoke([\n *       response,\n *       {\n *         type: \"local_shell_call_output\",\n *         id: shellCall.call_id,\n *         output: output,\n *       },\n *     ], {\n *       tools: [tools.localShell()],\n *     });\n *   }\n *\n *   return response;\n * }\n * ```\n *\n * @remarks\n * - Only available through the Responses API (not Chat Completions)\n * - Designed for use with `codex-mini-latest` model\n * - Commands are provided as argv tokens in `action.command`\n * - Action includes: `command`, `env`, `working_directory`, `timeout_ms`, `user`\n * - Always sandbox or validate commands before execution\n * - The `timeout_ms` from the model is only a hint—enforce your own limits\n */\nexport function localShell(options: LocalShellOptions) {\n  const shellTool = tool(options.execute, {\n    name: TOOL_NAME,\n    description:\n      \"Execute shell commands locally on the machine. Commands are provided as argv tokens.\",\n    schema: LocalShellActionSchema,\n  });\n\n  shellTool.extras = {\n    ...(shellTool.extras ?? {}),\n    providerToolDefinition: {\n      type: \"local_shell\",\n    } satisfies LocalShellTool,\n  };\n\n  return shellTool as DynamicStructuredTool<\n    typeof LocalShellActionSchema,\n    LocalShellAction,\n    unknown,\n    string\n  >;\n}\n"],"mappings":";;;;AAaA,MAAa,6BAA6B,EAAE,OAAO;CACjD,MAAM,EAAE,QAAQ,OAAO;CACvB,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC;CAC5B,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAC,UAAU;CAChD,mBAAmB,EAAE,QAAQ,CAAC,UAAU;CACxC,YAAY,EAAE,QAAQ,CAAC,UAAU;CACjC,MAAM,EAAE,QAAQ,CAAC,UAAU;AAC5B,EAAC;AAGF,MAAa,yBAAyB,EAAE,mBAAmB,QAAQ,CACjE,0BACD,EAAC;AAkCF,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoHlB,SAAgB,WAAWA,SAA4B;CACrD,MAAM,YAAY,KAAK,QAAQ,SAAS;EACtC,MAAM;EACN,aACE;EACF,QAAQ;CACT,EAAC;CAEF,UAAU,SAAS;EACjB,GAAI,UAAU,UAAU,CAAE;EAC1B,wBAAwB,EACtB,MAAM,cACP;CACF;AAED,QAAO;AAMR"}

package/dist/tools/mcp.cjs

@@ -0,0 +1,53 @@
+
+//#region src/tools/mcp.ts
+/**
+* Converts a McpToolFilter to the API format.
+*/
+function convertToolFilter(filter) {
+	return {
+		tool_names: filter.toolNames,
+		read_only: filter.readOnly
+	};
+}
+/**
+* Converts allowed_tools option to API format.
+*/
+function convertAllowedTools(allowedTools) {
+	if (!allowedTools) return void 0;
+	if (Array.isArray(allowedTools)) return allowedTools;
+	return convertToolFilter(allowedTools);
+}
+/**
+* Converts require_approval option to API format.
+*/
+function convertRequireApproval(requireApproval) {
+	if (!requireApproval) return void 0;
+	if (typeof requireApproval === "string") return requireApproval;
+	return {
+		always: requireApproval.always ? convertToolFilter(requireApproval.always) : void 0,
+		never: requireApproval.never ? convertToolFilter(requireApproval.never) : void 0
+	};
+}
+function mcp(options) {
+	const baseConfig = {
+		type: "mcp",
+		server_label: options.serverLabel,
+		allowed_tools: convertAllowedTools(options.allowedTools),
+		authorization: options.authorization,
+		headers: options.headers,
+		require_approval: convertRequireApproval(options.requireApproval),
+		server_description: options.serverDescription
+	};
+	if ("serverUrl" in options) return {
+		...baseConfig,
+		server_url: options.serverUrl
+	};
+	return {
+		...baseConfig,
+		connector_id: options.connectorId
+	};
+}
+
+//#endregion
+exports.mcp = mcp;
+//# sourceMappingURL=mcp.cjs.map

package/dist/tools/mcp.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.cjs","names":["filter: McpToolFilter","allowedTools: string[] | McpToolFilter | undefined","requireApproval: \"always\" | \"never\" | McpApprovalFilter | undefined","options: McpRemoteServerOptions | McpConnectorOptions","baseConfig: McpTool"],"sources":["../../src/tools/mcp.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport type { ServerTool } from \"@langchain/core/tools\";\n\n/**\n * Available connector IDs for OpenAI's built-in service connectors.\n * These are OpenAI-maintained MCP wrappers for popular services.\n */\nexport type McpConnectorId =\n  | \"connector_dropbox\"\n  | \"connector_gmail\"\n  | \"connector_googlecalendar\"\n  | \"connector_googledrive\"\n  | \"connector_microsoftteams\"\n  | \"connector_outlookcalendar\"\n  | \"connector_outlookemail\"\n  | \"connector_sharepoint\";\n\n/**\n * Filter object to specify which tools are allowed.\n */\nexport interface McpToolFilter {\n  /**\n   * List of allowed tool names.\n   */\n  toolNames?: string[];\n  /**\n   * Indicates whether or not a tool modifies data or is read-only.\n   * If an MCP server is annotated with `readOnlyHint`, it will match this filter.\n   */\n  readOnly?: boolean;\n}\n\n/**\n * Filter object for approval requirements.\n */\nexport interface McpApprovalFilter {\n  /**\n   * Tools that always require approval before execution.\n   */\n  always?: McpToolFilter;\n  /**\n   * Tools that never require approval.\n   */\n  never?: McpToolFilter;\n}\n\n/**\n * Base options shared between remote MCP servers and connectors.\n */\ninterface McpBaseOptions {\n  /**\n   * A label for this MCP server, used to identify it in tool calls.\n   */\n  serverLabel: string;\n  /**\n   * List of allowed tool names or a filter object.\n   * Use this to limit which tools from the MCP server are available to the model.\n   */\n  allowedTools?: string[] | McpToolFilter;\n  /**\n   * An OAuth access token for authentication with the MCP server.\n   * Your application must handle the OAuth authorization flow and provide the token here.\n   */\n  authorization?: string;\n  /**\n   * Optional HTTP headers to send to the MCP server.\n   * Use for authentication or other purposes.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Specify which of the MCP server's tools require approval before execution.\n   * - `\"always\"`: All tools require approval\n   * - `\"never\"`: No tools require approval\n   * - `McpApprovalFilter`: Fine-grained control over which tools require approval\n   *\n   * @default \"always\" (approval required for all tools)\n   */\n  requireApproval?: \"always\" | \"never\" | McpApprovalFilter;\n  /**\n   * Optional description of the MCP server, used to provide more context to the model.\n   */\n  serverDescription?: string;\n}\n\n/**\n * Options for connecting to a remote MCP server via URL.\n */\nexport interface McpRemoteServerOptions extends McpBaseOptions {\n  /**\n   * The URL for the MCP server.\n   * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.\n   */\n  serverUrl: string;\n}\n\n/**\n * Options for connecting to an OpenAI-maintained service connector.\n */\nexport interface McpConnectorOptions extends McpBaseOptions {\n  /**\n   * Identifier for the service connector.\n   * These are OpenAI-maintained MCP wrappers for popular services.\n   *\n   * Available connectors:\n   * - `connector_dropbox`: Dropbox file access\n   * - `connector_gmail`: Gmail email access\n   * - `connector_googlecalendar`: Google Calendar access\n   * - `connector_googledrive`: Google Drive file access\n   * - `connector_microsoftteams`: Microsoft Teams access\n   * - `connector_outlookcalendar`: Outlook Calendar access\n   * - `connector_outlookemail`: Outlook Email access\n   * - `connector_sharepoint`: SharePoint file access\n   */\n  connectorId: McpConnectorId;\n}\n\n/**\n * OpenAI MCP tool type for the Responses API.\n */\nexport type McpTool = OpenAIClient.Responses.Tool.Mcp;\n\n/**\n * Converts a McpToolFilter to the API format.\n */\nfunction convertToolFilter(\n  filter: McpToolFilter\n): OpenAIClient.Responses.Tool.Mcp.McpToolFilter {\n  return {\n    tool_names: filter.toolNames,\n    read_only: filter.readOnly,\n  };\n}\n\n/**\n * Converts allowed_tools option to API format.\n */\nfunction convertAllowedTools(\n  allowedTools: string[] | McpToolFilter | undefined\n): Array<string> | OpenAIClient.Responses.Tool.Mcp.McpToolFilter | undefined {\n  if (!allowedTools) return undefined;\n  if (Array.isArray(allowedTools)) return allowedTools;\n  return convertToolFilter(allowedTools);\n}\n\n/**\n * Converts require_approval option to API format.\n */\nfunction convertRequireApproval(\n  requireApproval: \"always\" | \"never\" | McpApprovalFilter | undefined\n):\n  | OpenAIClient.Responses.Tool.Mcp.McpToolApprovalFilter\n  | \"always\"\n  | \"never\"\n  | undefined {\n  if (!requireApproval) return undefined;\n  if (typeof requireApproval === \"string\") return requireApproval;\n  return {\n    always: requireApproval.always\n      ? convertToolFilter(requireApproval.always)\n      : undefined,\n    never: requireApproval.never\n      ? convertToolFilter(requireApproval.never)\n      : undefined,\n  };\n}\n\n/**\n * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.\n * This allows OpenAI models to access external tools and services via the Model Context Protocol.\n *\n * There are two ways to use MCP tools:\n * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements\n *    the MCP protocol using `serverUrl`.\n * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like\n *    Google Workspace or Dropbox using `connectorId`.\n *\n * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}\n *\n * @param options - Configuration options for the MCP tool\n * @returns An MCP tool definition to be passed to the OpenAI Responses API\n *\n * @example\n * ```typescript\n * import { ChatOpenAI, tools } from \"@langchain/openai\";\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n *\n * // Using a remote MCP server\n * const response = await model.invoke(\"Roll 2d4+1\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverDescription: \"A D&D MCP server for dice rolling\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // Using a connector (e.g., Google Calendar)\n * const calendarResponse = await model.invoke(\"What's on my calendar today?\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"google_calendar\",\n *     connectorId: \"connector_googlecalendar\",\n *     authorization: \"<oauth-access-token>\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With tool filtering - only allow specific tools\n * const filteredResponse = await model.invoke(\"Roll some dice\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     allowedTools: [\"roll\"],  // Only allow the \"roll\" tool\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With fine-grained approval control\n * const controlledResponse = await model.invoke(\"Search and modify files\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"deepwiki\",\n *     serverUrl: \"https://mcp.deepwiki.com/mcp\",\n *     requireApproval: {\n *       never: { toolNames: [\"ask_question\", \"read_wiki_structure\"] },\n *       // All other tools will require approval\n *     },\n *   })],\n * });\n * ```\n */\nexport function mcp(options: McpRemoteServerOptions): ServerTool;\nexport function mcp(options: McpConnectorOptions): ServerTool;\nexport function mcp(\n  options: McpRemoteServerOptions | McpConnectorOptions\n): ServerTool {\n  const baseConfig: McpTool = {\n    type: \"mcp\",\n    server_label: options.serverLabel,\n    allowed_tools: convertAllowedTools(options.allowedTools),\n    authorization: options.authorization,\n    headers: options.headers,\n    require_approval: convertRequireApproval(options.requireApproval),\n    server_description: options.serverDescription,\n  };\n\n  if (\"serverUrl\" in options) {\n    return {\n      ...baseConfig,\n      server_url: options.serverUrl,\n    } satisfies McpTool;\n  }\n\n  return {\n    ...baseConfig,\n    connector_id: options.connectorId,\n  } satisfies McpTool;\n}\n"],"mappings":";;;;;AA4HA,SAAS,kBACPA,QAC+C;AAC/C,QAAO;EACL,YAAY,OAAO;EACnB,WAAW,OAAO;CACnB;AACF;;;;AAKD,SAAS,oBACPC,cAC2E;AAC3E,KAAI,CAAC,aAAc,QAAO;AAC1B,KAAI,MAAM,QAAQ,aAAa,CAAE,QAAO;AACxC,QAAO,kBAAkB,aAAa;AACvC;;;;AAKD,SAAS,uBACPC,iBAKY;AACZ,KAAI,CAAC,gBAAiB,QAAO;AAC7B,KAAI,OAAO,oBAAoB,SAAU,QAAO;AAChD,QAAO;EACL,QAAQ,gBAAgB,SACpB,kBAAkB,gBAAgB,OAAO,GACzC;EACJ,OAAO,gBAAgB,QACnB,kBAAkB,gBAAgB,MAAM,GACxC;CACL;AACF;AAoED,SAAgB,IACdC,SACY;CACZ,MAAMC,aAAsB;EAC1B,MAAM;EACN,cAAc,QAAQ;EACtB,eAAe,oBAAoB,QAAQ,aAAa;EACxD,eAAe,QAAQ;EACvB,SAAS,QAAQ;EACjB,kBAAkB,uBAAuB,QAAQ,gBAAgB;EACjE,oBAAoB,QAAQ;CAC7B;AAED,KAAI,eAAe,QACjB,QAAO;EACL,GAAG;EACH,YAAY,QAAQ;CACrB;AAGH,QAAO;EACL,GAAG;EACH,cAAc,QAAQ;CACvB;AACF"}

package/dist/tools/mcp.d.cts

@@ -0,0 +1,177 @@
+import { OpenAI as OpenAI$1 } from "openai";
+import { ServerTool } from "@langchain/core/tools";
+
+//#region src/tools/mcp.d.ts
+
+/**
+ * Available connector IDs for OpenAI's built-in service connectors.
+ * These are OpenAI-maintained MCP wrappers for popular services.
+ */
+type McpConnectorId = "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint";
+/**
+ * Filter object to specify which tools are allowed.
+ */
+interface McpToolFilter {
+  /**
+   * List of allowed tool names.
+   */
+  toolNames?: string[];
+  /**
+   * Indicates whether or not a tool modifies data or is read-only.
+   * If an MCP server is annotated with `readOnlyHint`, it will match this filter.
+   */
+  readOnly?: boolean;
+}
+/**
+ * Filter object for approval requirements.
+ */
+interface McpApprovalFilter {
+  /**
+   * Tools that always require approval before execution.
+   */
+  always?: McpToolFilter;
+  /**
+   * Tools that never require approval.
+   */
+  never?: McpToolFilter;
+}
+/**
+ * Base options shared between remote MCP servers and connectors.
+ */
+interface McpBaseOptions {
+  /**
+   * A label for this MCP server, used to identify it in tool calls.
+   */
+  serverLabel: string;
+  /**
+   * List of allowed tool names or a filter object.
+   * Use this to limit which tools from the MCP server are available to the model.
+   */
+  allowedTools?: string[] | McpToolFilter;
+  /**
+   * An OAuth access token for authentication with the MCP server.
+   * Your application must handle the OAuth authorization flow and provide the token here.
+   */
+  authorization?: string;
+  /**
+   * Optional HTTP headers to send to the MCP server.
+   * Use for authentication or other purposes.
+   */
+  headers?: Record<string, string>;
+  /**
+   * Specify which of the MCP server's tools require approval before execution.
+   * - `"always"`: All tools require approval
+   * - `"never"`: No tools require approval
+   * - `McpApprovalFilter`: Fine-grained control over which tools require approval
+   *
+   * @default "always" (approval required for all tools)
+   */
+  requireApproval?: "always" | "never" | McpApprovalFilter;
+  /**
+   * Optional description of the MCP server, used to provide more context to the model.
+   */
+  serverDescription?: string;
+}
+/**
+ * Options for connecting to a remote MCP server via URL.
+ */
+interface McpRemoteServerOptions extends McpBaseOptions {
+  /**
+   * The URL for the MCP server.
+   * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.
+   */
+  serverUrl: string;
+}
+/**
+ * Options for connecting to an OpenAI-maintained service connector.
+ */
+interface McpConnectorOptions extends McpBaseOptions {
+  /**
+   * Identifier for the service connector.
+   * These are OpenAI-maintained MCP wrappers for popular services.
+   *
+   * Available connectors:
+   * - `connector_dropbox`: Dropbox file access
+   * - `connector_gmail`: Gmail email access
+   * - `connector_googlecalendar`: Google Calendar access
+   * - `connector_googledrive`: Google Drive file access
+   * - `connector_microsoftteams`: Microsoft Teams access
+   * - `connector_outlookcalendar`: Outlook Calendar access
+   * - `connector_outlookemail`: Outlook Email access
+   * - `connector_sharepoint`: SharePoint file access
+   */
+  connectorId: McpConnectorId;
+}
+/**
+ * OpenAI MCP tool type for the Responses API.
+ */
+type McpTool = OpenAI$1.Responses.Tool.Mcp;
+/**
+ * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.
+ * This allows OpenAI models to access external tools and services via the Model Context Protocol.
+ *
+ * There are two ways to use MCP tools:
+ * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements
+ *    the MCP protocol using `serverUrl`.
+ * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like
+ *    Google Workspace or Dropbox using `connectorId`.
+ *
+ * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}
+ *
+ * @param options - Configuration options for the MCP tool
+ * @returns An MCP tool definition to be passed to the OpenAI Responses API
+ *
+ * @example
+ * ```typescript
+ * import { ChatOpenAI, tools } from "@langchain/openai";
+ *
+ * const model = new ChatOpenAI({ model: "gpt-4o" });
+ *
+ * // Using a remote MCP server
+ * const response = await model.invoke("Roll 2d4+1", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "dmcp",
+ *     serverDescription: "A D&D MCP server for dice rolling",
+ *     serverUrl: "https://dmcp-server.deno.dev/sse",
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // Using a connector (e.g., Google Calendar)
+ * const calendarResponse = await model.invoke("What's on my calendar today?", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "google_calendar",
+ *     connectorId: "connector_googlecalendar",
+ *     authorization: "<oauth-access-token>",
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // With tool filtering - only allow specific tools
+ * const filteredResponse = await model.invoke("Roll some dice", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "dmcp",
+ *     serverUrl: "https://dmcp-server.deno.dev/sse",
+ *     allowedTools: ["roll"],  // Only allow the "roll" tool
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // With fine-grained approval control
+ * const controlledResponse = await model.invoke("Search and modify files", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "deepwiki",
+ *     serverUrl: "https://mcp.deepwiki.com/mcp",
+ *     requireApproval: {
+ *       never: { toolNames: ["ask_question", "read_wiki_structure"] },
+ *       // All other tools will require approval
+ *     },
+ *   })],
+ * });
+ * ```
+ */
+declare function mcp(options: McpRemoteServerOptions): ServerTool;
+declare function mcp(options: McpConnectorOptions): ServerTool;
+//#endregion
+export { McpApprovalFilter, McpConnectorId, McpConnectorOptions, McpRemoteServerOptions, McpTool, McpToolFilter, mcp };
+//# sourceMappingURL=mcp.d.cts.map

package/dist/tools/mcp.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.d.cts","names":["OpenAI","OpenAIClient","ServerTool","McpConnectorId","McpToolFilter","McpApprovalFilter","McpBaseOptions","Record","McpRemoteServerOptions","McpConnectorOptions","McpTool","Responses","Tool","Mcp","mcp"],"sources":["../../src/tools/mcp.d.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport type { ServerTool } from \"@langchain/core/tools\";\n/**\n * Available connector IDs for OpenAI's built-in service connectors.\n * These are OpenAI-maintained MCP wrappers for popular services.\n */\nexport type McpConnectorId = \"connector_dropbox\" | \"connector_gmail\" | \"connector_googlecalendar\" | \"connector_googledrive\" | \"connector_microsoftteams\" | \"connector_outlookcalendar\" | \"connector_outlookemail\" | \"connector_sharepoint\";\n/**\n * Filter object to specify which tools are allowed.\n */\nexport interface McpToolFilter {\n    /**\n     * List of allowed tool names.\n     */\n    toolNames?: string[];\n    /**\n     * Indicates whether or not a tool modifies data or is read-only.\n     * If an MCP server is annotated with `readOnlyHint`, it will match this filter.\n     */\n    readOnly?: boolean;\n}\n/**\n * Filter object for approval requirements.\n */\nexport interface McpApprovalFilter {\n    /**\n     * Tools that always require approval before execution.\n     */\n    always?: McpToolFilter;\n    /**\n     * Tools that never require approval.\n     */\n    never?: McpToolFilter;\n}\n/**\n * Base options shared between remote MCP servers and connectors.\n */\ninterface McpBaseOptions {\n    /**\n     * A label for this MCP server, used to identify it in tool calls.\n     */\n    serverLabel: string;\n    /**\n     * List of allowed tool names or a filter object.\n     * Use this to limit which tools from the MCP server are available to the model.\n     */\n    allowedTools?: string[] | McpToolFilter;\n    /**\n     * An OAuth access token for authentication with the MCP server.\n     * Your application must handle the OAuth authorization flow and provide the token here.\n     */\n    authorization?: string;\n    /**\n     * Optional HTTP headers to send to the MCP server.\n     * Use for authentication or other purposes.\n     */\n    headers?: Record<string, string>;\n    /**\n     * Specify which of the MCP server's tools require approval before execution.\n     * - `\"always\"`: All tools require approval\n     * - `\"never\"`: No tools require approval\n     * - `McpApprovalFilter`: Fine-grained control over which tools require approval\n     *\n     * @default \"always\" (approval required for all tools)\n     */\n    requireApproval?: \"always\" | \"never\" | McpApprovalFilter;\n    /**\n     * Optional description of the MCP server, used to provide more context to the model.\n     */\n    serverDescription?: string;\n}\n/**\n * Options for connecting to a remote MCP server via URL.\n */\nexport interface McpRemoteServerOptions extends McpBaseOptions {\n    /**\n     * The URL for the MCP server.\n     * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.\n     */\n    serverUrl: string;\n}\n/**\n * Options for connecting to an OpenAI-maintained service connector.\n */\nexport interface McpConnectorOptions extends McpBaseOptions {\n    /**\n     * Identifier for the service connector.\n     * These are OpenAI-maintained MCP wrappers for popular services.\n     *\n     * Available connectors:\n     * - `connector_dropbox`: Dropbox file access\n     * - `connector_gmail`: Gmail email access\n     * - `connector_googlecalendar`: Google Calendar access\n     * - `connector_googledrive`: Google Drive file access\n     * - `connector_microsoftteams`: Microsoft Teams access\n     * - `connector_outlookcalendar`: Outlook Calendar access\n     * - `connector_outlookemail`: Outlook Email access\n     * - `connector_sharepoint`: SharePoint file access\n     */\n    connectorId: McpConnectorId;\n}\n/**\n * OpenAI MCP tool type for the Responses API.\n */\nexport type McpTool = OpenAIClient.Responses.Tool.Mcp;\n/**\n * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.\n * This allows OpenAI models to access external tools and services via the Model Context Protocol.\n *\n * There are two ways to use MCP tools:\n * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements\n *    the MCP protocol using `serverUrl`.\n * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like\n *    Google Workspace or Dropbox using `connectorId`.\n *\n * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}\n *\n * @param options - Configuration options for the MCP tool\n * @returns An MCP tool definition to be passed to the OpenAI Responses API\n *\n * @example\n * ```typescript\n * import { ChatOpenAI, tools } from \"@langchain/openai\";\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n *\n * // Using a remote MCP server\n * const response = await model.invoke(\"Roll 2d4+1\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverDescription: \"A D&D MCP server for dice rolling\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // Using a connector (e.g., Google Calendar)\n * const calendarResponse = await model.invoke(\"What's on my calendar today?\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"google_calendar\",\n *     connectorId: \"connector_googlecalendar\",\n *     authorization: \"<oauth-access-token>\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With tool filtering - only allow specific tools\n * const filteredResponse = await model.invoke(\"Roll some dice\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     allowedTools: [\"roll\"],  // Only allow the \"roll\" tool\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With fine-grained approval control\n * const controlledResponse = await model.invoke(\"Search and modify files\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"deepwiki\",\n *     serverUrl: \"https://mcp.deepwiki.com/mcp\",\n *     requireApproval: {\n *       never: { toolNames: [\"ask_question\", \"read_wiki_structure\"] },\n *       // All other tools will require approval\n *     },\n *   })],\n * });\n * ```\n */\nexport declare function mcp(options: McpRemoteServerOptions): ServerTool;\nexport declare function mcp(options: McpConnectorOptions): ServerTool;\nexport {};\n//# sourceMappingURL=mcp.d.ts.map"],"mappings":";;;;;;;AAMA;AAIA;AAciBK,KAlBLF,cAAAA,GAkBsB,mBAIrBC,GAAAA,iBAIY,GAAA,0BAAA,GAAA,uBAAA,GAAA,0BAAA,GAAA,2BAAA,GAAA,wBAAA,GAAA,sBAAA;AACxB;;;AAgC0CC,UAvD1BD,aAAAA,CAuD0BC;EAAiB;AAS5D;AAUA;EAoBYK,SAAAA,CAAO,EAAA,MAAA,EAAA;EAiEKI;AACxB;;;;;;;;UAlJiBT,iBAAAA;;;;WAIJD;;;;UAIDA;;;;;UAKFE,cAAAA;;;;;;;;;4BASoBF;;;;;;;;;;YAUhBG;;;;;;;;;yCAS6BF;;;;;;;;;UAS1BG,sBAAAA,SAA+BF;;;;;;;;;;UAU/BG,mBAAAA,SAA4BH;;;;;;;;;;;;;;;eAe5BH;;;;;KAKLO,OAAAA,GAAUT,QAAAA,CAAaU,SAAAA,CAAUC,IAAAA,CAAKC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiE1BC,GAAAA,UAAaN,yBAAyBN;iBACtCY,GAAAA,UAAaL,sBAAsBP"}

package/dist/tools/mcp.d.ts

@@ -0,0 +1,177 @@
+import { OpenAI as OpenAI$1 } from "openai";
+import { ServerTool } from "@langchain/core/tools";
+
+//#region src/tools/mcp.d.ts
+
+/**
+ * Available connector IDs for OpenAI's built-in service connectors.
+ * These are OpenAI-maintained MCP wrappers for popular services.
+ */
+type McpConnectorId = "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint";
+/**
+ * Filter object to specify which tools are allowed.
+ */
+interface McpToolFilter {
+  /**
+   * List of allowed tool names.
+   */
+  toolNames?: string[];
+  /**
+   * Indicates whether or not a tool modifies data or is read-only.
+   * If an MCP server is annotated with `readOnlyHint`, it will match this filter.
+   */
+  readOnly?: boolean;
+}
+/**
+ * Filter object for approval requirements.
+ */
+interface McpApprovalFilter {
+  /**
+   * Tools that always require approval before execution.
+   */
+  always?: McpToolFilter;
+  /**
+   * Tools that never require approval.
+   */
+  never?: McpToolFilter;
+}
+/**
+ * Base options shared between remote MCP servers and connectors.
+ */
+interface McpBaseOptions {
+  /**
+   * A label for this MCP server, used to identify it in tool calls.
+   */
+  serverLabel: string;
+  /**
+   * List of allowed tool names or a filter object.
+   * Use this to limit which tools from the MCP server are available to the model.
+   */
+  allowedTools?: string[] | McpToolFilter;
+  /**
+   * An OAuth access token for authentication with the MCP server.
+   * Your application must handle the OAuth authorization flow and provide the token here.
+   */
+  authorization?: string;
+  /**
+   * Optional HTTP headers to send to the MCP server.
+   * Use for authentication or other purposes.
+   */
+  headers?: Record<string, string>;
+  /**
+   * Specify which of the MCP server's tools require approval before execution.
+   * - `"always"`: All tools require approval
+   * - `"never"`: No tools require approval
+   * - `McpApprovalFilter`: Fine-grained control over which tools require approval
+   *
+   * @default "always" (approval required for all tools)
+   */
+  requireApproval?: "always" | "never" | McpApprovalFilter;
+  /**
+   * Optional description of the MCP server, used to provide more context to the model.
+   */
+  serverDescription?: string;
+}
+/**
+ * Options for connecting to a remote MCP server via URL.
+ */
+interface McpRemoteServerOptions extends McpBaseOptions {
+  /**
+   * The URL for the MCP server.
+   * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.
+   */
+  serverUrl: string;
+}
+/**
+ * Options for connecting to an OpenAI-maintained service connector.
+ */
+interface McpConnectorOptions extends McpBaseOptions {
+  /**
+   * Identifier for the service connector.
+   * These are OpenAI-maintained MCP wrappers for popular services.
+   *
+   * Available connectors:
+   * - `connector_dropbox`: Dropbox file access
+   * - `connector_gmail`: Gmail email access
+   * - `connector_googlecalendar`: Google Calendar access
+   * - `connector_googledrive`: Google Drive file access
+   * - `connector_microsoftteams`: Microsoft Teams access
+   * - `connector_outlookcalendar`: Outlook Calendar access
+   * - `connector_outlookemail`: Outlook Email access
+   * - `connector_sharepoint`: SharePoint file access
+   */
+  connectorId: McpConnectorId;
+}
+/**
+ * OpenAI MCP tool type for the Responses API.
+ */
+type McpTool = OpenAI$1.Responses.Tool.Mcp;
+/**
+ * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.
+ * This allows OpenAI models to access external tools and services via the Model Context Protocol.
+ *
+ * There are two ways to use MCP tools:
+ * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements
+ *    the MCP protocol using `serverUrl`.
+ * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like
+ *    Google Workspace or Dropbox using `connectorId`.
+ *
+ * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}
+ *
+ * @param options - Configuration options for the MCP tool
+ * @returns An MCP tool definition to be passed to the OpenAI Responses API
+ *
+ * @example
+ * ```typescript
+ * import { ChatOpenAI, tools } from "@langchain/openai";
+ *
+ * const model = new ChatOpenAI({ model: "gpt-4o" });
+ *
+ * // Using a remote MCP server
+ * const response = await model.invoke("Roll 2d4+1", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "dmcp",
+ *     serverDescription: "A D&D MCP server for dice rolling",
+ *     serverUrl: "https://dmcp-server.deno.dev/sse",
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // Using a connector (e.g., Google Calendar)
+ * const calendarResponse = await model.invoke("What's on my calendar today?", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "google_calendar",
+ *     connectorId: "connector_googlecalendar",
+ *     authorization: "<oauth-access-token>",
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // With tool filtering - only allow specific tools
+ * const filteredResponse = await model.invoke("Roll some dice", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "dmcp",
+ *     serverUrl: "https://dmcp-server.deno.dev/sse",
+ *     allowedTools: ["roll"],  // Only allow the "roll" tool
+ *     requireApproval: "never",
+ *   })],
+ * });
+ *
+ * // With fine-grained approval control
+ * const controlledResponse = await model.invoke("Search and modify files", {
+ *   tools: [tools.mcp({
+ *     serverLabel: "deepwiki",
+ *     serverUrl: "https://mcp.deepwiki.com/mcp",
+ *     requireApproval: {
+ *       never: { toolNames: ["ask_question", "read_wiki_structure"] },
+ *       // All other tools will require approval
+ *     },
+ *   })],
+ * });
+ * ```
+ */
+declare function mcp(options: McpRemoteServerOptions): ServerTool;
+declare function mcp(options: McpConnectorOptions): ServerTool;
+//#endregion
+export { McpApprovalFilter, McpConnectorId, McpConnectorOptions, McpRemoteServerOptions, McpTool, McpToolFilter, mcp };
+//# sourceMappingURL=mcp.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.d.ts","names":["OpenAI","OpenAIClient","ServerTool","McpConnectorId","McpToolFilter","McpApprovalFilter","McpBaseOptions","Record","McpRemoteServerOptions","McpConnectorOptions","McpTool","Responses","Tool","Mcp","mcp"],"sources":["../../src/tools/mcp.d.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport type { ServerTool } from \"@langchain/core/tools\";\n/**\n * Available connector IDs for OpenAI's built-in service connectors.\n * These are OpenAI-maintained MCP wrappers for popular services.\n */\nexport type McpConnectorId = \"connector_dropbox\" | \"connector_gmail\" | \"connector_googlecalendar\" | \"connector_googledrive\" | \"connector_microsoftteams\" | \"connector_outlookcalendar\" | \"connector_outlookemail\" | \"connector_sharepoint\";\n/**\n * Filter object to specify which tools are allowed.\n */\nexport interface McpToolFilter {\n    /**\n     * List of allowed tool names.\n     */\n    toolNames?: string[];\n    /**\n     * Indicates whether or not a tool modifies data or is read-only.\n     * If an MCP server is annotated with `readOnlyHint`, it will match this filter.\n     */\n    readOnly?: boolean;\n}\n/**\n * Filter object for approval requirements.\n */\nexport interface McpApprovalFilter {\n    /**\n     * Tools that always require approval before execution.\n     */\n    always?: McpToolFilter;\n    /**\n     * Tools that never require approval.\n     */\n    never?: McpToolFilter;\n}\n/**\n * Base options shared between remote MCP servers and connectors.\n */\ninterface McpBaseOptions {\n    /**\n     * A label for this MCP server, used to identify it in tool calls.\n     */\n    serverLabel: string;\n    /**\n     * List of allowed tool names or a filter object.\n     * Use this to limit which tools from the MCP server are available to the model.\n     */\n    allowedTools?: string[] | McpToolFilter;\n    /**\n     * An OAuth access token for authentication with the MCP server.\n     * Your application must handle the OAuth authorization flow and provide the token here.\n     */\n    authorization?: string;\n    /**\n     * Optional HTTP headers to send to the MCP server.\n     * Use for authentication or other purposes.\n     */\n    headers?: Record<string, string>;\n    /**\n     * Specify which of the MCP server's tools require approval before execution.\n     * - `\"always\"`: All tools require approval\n     * - `\"never\"`: No tools require approval\n     * - `McpApprovalFilter`: Fine-grained control over which tools require approval\n     *\n     * @default \"always\" (approval required for all tools)\n     */\n    requireApproval?: \"always\" | \"never\" | McpApprovalFilter;\n    /**\n     * Optional description of the MCP server, used to provide more context to the model.\n     */\n    serverDescription?: string;\n}\n/**\n * Options for connecting to a remote MCP server via URL.\n */\nexport interface McpRemoteServerOptions extends McpBaseOptions {\n    /**\n     * The URL for the MCP server.\n     * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.\n     */\n    serverUrl: string;\n}\n/**\n * Options for connecting to an OpenAI-maintained service connector.\n */\nexport interface McpConnectorOptions extends McpBaseOptions {\n    /**\n     * Identifier for the service connector.\n     * These are OpenAI-maintained MCP wrappers for popular services.\n     *\n     * Available connectors:\n     * - `connector_dropbox`: Dropbox file access\n     * - `connector_gmail`: Gmail email access\n     * - `connector_googlecalendar`: Google Calendar access\n     * - `connector_googledrive`: Google Drive file access\n     * - `connector_microsoftteams`: Microsoft Teams access\n     * - `connector_outlookcalendar`: Outlook Calendar access\n     * - `connector_outlookemail`: Outlook Email access\n     * - `connector_sharepoint`: SharePoint file access\n     */\n    connectorId: McpConnectorId;\n}\n/**\n * OpenAI MCP tool type for the Responses API.\n */\nexport type McpTool = OpenAIClient.Responses.Tool.Mcp;\n/**\n * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.\n * This allows OpenAI models to access external tools and services via the Model Context Protocol.\n *\n * There are two ways to use MCP tools:\n * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements\n *    the MCP protocol using `serverUrl`.\n * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like\n *    Google Workspace or Dropbox using `connectorId`.\n *\n * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}\n *\n * @param options - Configuration options for the MCP tool\n * @returns An MCP tool definition to be passed to the OpenAI Responses API\n *\n * @example\n * ```typescript\n * import { ChatOpenAI, tools } from \"@langchain/openai\";\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n *\n * // Using a remote MCP server\n * const response = await model.invoke(\"Roll 2d4+1\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverDescription: \"A D&D MCP server for dice rolling\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // Using a connector (e.g., Google Calendar)\n * const calendarResponse = await model.invoke(\"What's on my calendar today?\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"google_calendar\",\n *     connectorId: \"connector_googlecalendar\",\n *     authorization: \"<oauth-access-token>\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With tool filtering - only allow specific tools\n * const filteredResponse = await model.invoke(\"Roll some dice\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     allowedTools: [\"roll\"],  // Only allow the \"roll\" tool\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With fine-grained approval control\n * const controlledResponse = await model.invoke(\"Search and modify files\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"deepwiki\",\n *     serverUrl: \"https://mcp.deepwiki.com/mcp\",\n *     requireApproval: {\n *       never: { toolNames: [\"ask_question\", \"read_wiki_structure\"] },\n *       // All other tools will require approval\n *     },\n *   })],\n * });\n * ```\n */\nexport declare function mcp(options: McpRemoteServerOptions): ServerTool;\nexport declare function mcp(options: McpConnectorOptions): ServerTool;\nexport {};\n//# sourceMappingURL=mcp.d.ts.map"],"mappings":";;;;;;;AAMA;AAIA;AAciBK,KAlBLF,cAAAA,GAkBsB,mBAIrBC,GAAAA,iBAIY,GAAA,0BAAA,GAAA,uBAAA,GAAA,0BAAA,GAAA,2BAAA,GAAA,wBAAA,GAAA,sBAAA;AACxB;;;AAgC0CC,UAvD1BD,aAAAA,CAuD0BC;EAAiB;AAS5D;AAUA;EAoBYK,SAAAA,CAAO,EAAA,MAAA,EAAA;EAiEKI;AACxB;;;;;;;;UAlJiBT,iBAAAA;;;;WAIJD;;;;UAIDA;;;;;UAKFE,cAAAA;;;;;;;;;4BASoBF;;;;;;;;;;YAUhBG;;;;;;;;;yCAS6BF;;;;;;;;;UAS1BG,sBAAAA,SAA+BF;;;;;;;;;;UAU/BG,mBAAAA,SAA4BH;;;;;;;;;;;;;;;eAe5BH;;;;;KAKLO,OAAAA,GAAUT,QAAAA,CAAaU,SAAAA,CAAUC,IAAAA,CAAKC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiE1BC,GAAAA,UAAaN,yBAAyBN;iBACtCY,GAAAA,UAAaL,sBAAsBP"}

package/dist/tools/mcp.js

@@ -0,0 +1,52 @@
+//#region src/tools/mcp.ts
+/**
+* Converts a McpToolFilter to the API format.
+*/
+function convertToolFilter(filter) {
+	return {
+		tool_names: filter.toolNames,
+		read_only: filter.readOnly
+	};
+}
+/**
+* Converts allowed_tools option to API format.
+*/
+function convertAllowedTools(allowedTools) {
+	if (!allowedTools) return void 0;
+	if (Array.isArray(allowedTools)) return allowedTools;
+	return convertToolFilter(allowedTools);
+}
+/**
+* Converts require_approval option to API format.
+*/
+function convertRequireApproval(requireApproval) {
+	if (!requireApproval) return void 0;
+	if (typeof requireApproval === "string") return requireApproval;
+	return {
+		always: requireApproval.always ? convertToolFilter(requireApproval.always) : void 0,
+		never: requireApproval.never ? convertToolFilter(requireApproval.never) : void 0
+	};
+}
+function mcp(options) {
+	const baseConfig = {
+		type: "mcp",
+		server_label: options.serverLabel,
+		allowed_tools: convertAllowedTools(options.allowedTools),
+		authorization: options.authorization,
+		headers: options.headers,
+		require_approval: convertRequireApproval(options.requireApproval),
+		server_description: options.serverDescription
+	};
+	if ("serverUrl" in options) return {
+		...baseConfig,
+		server_url: options.serverUrl
+	};
+	return {
+		...baseConfig,
+		connector_id: options.connectorId
+	};
+}
+
+//#endregion
+export { mcp };
+//# sourceMappingURL=mcp.js.map

package/dist/tools/mcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.js","names":["filter: McpToolFilter","allowedTools: string[] | McpToolFilter | undefined","requireApproval: \"always\" | \"never\" | McpApprovalFilter | undefined","options: McpRemoteServerOptions | McpConnectorOptions","baseConfig: McpTool"],"sources":["../../src/tools/mcp.ts"],"sourcesContent":["import { OpenAI as OpenAIClient } from \"openai\";\nimport type { ServerTool } from \"@langchain/core/tools\";\n\n/**\n * Available connector IDs for OpenAI's built-in service connectors.\n * These are OpenAI-maintained MCP wrappers for popular services.\n */\nexport type McpConnectorId =\n  | \"connector_dropbox\"\n  | \"connector_gmail\"\n  | \"connector_googlecalendar\"\n  | \"connector_googledrive\"\n  | \"connector_microsoftteams\"\n  | \"connector_outlookcalendar\"\n  | \"connector_outlookemail\"\n  | \"connector_sharepoint\";\n\n/**\n * Filter object to specify which tools are allowed.\n */\nexport interface McpToolFilter {\n  /**\n   * List of allowed tool names.\n   */\n  toolNames?: string[];\n  /**\n   * Indicates whether or not a tool modifies data or is read-only.\n   * If an MCP server is annotated with `readOnlyHint`, it will match this filter.\n   */\n  readOnly?: boolean;\n}\n\n/**\n * Filter object for approval requirements.\n */\nexport interface McpApprovalFilter {\n  /**\n   * Tools that always require approval before execution.\n   */\n  always?: McpToolFilter;\n  /**\n   * Tools that never require approval.\n   */\n  never?: McpToolFilter;\n}\n\n/**\n * Base options shared between remote MCP servers and connectors.\n */\ninterface McpBaseOptions {\n  /**\n   * A label for this MCP server, used to identify it in tool calls.\n   */\n  serverLabel: string;\n  /**\n   * List of allowed tool names or a filter object.\n   * Use this to limit which tools from the MCP server are available to the model.\n   */\n  allowedTools?: string[] | McpToolFilter;\n  /**\n   * An OAuth access token for authentication with the MCP server.\n   * Your application must handle the OAuth authorization flow and provide the token here.\n   */\n  authorization?: string;\n  /**\n   * Optional HTTP headers to send to the MCP server.\n   * Use for authentication or other purposes.\n   */\n  headers?: Record<string, string>;\n  /**\n   * Specify which of the MCP server's tools require approval before execution.\n   * - `\"always\"`: All tools require approval\n   * - `\"never\"`: No tools require approval\n   * - `McpApprovalFilter`: Fine-grained control over which tools require approval\n   *\n   * @default \"always\" (approval required for all tools)\n   */\n  requireApproval?: \"always\" | \"never\" | McpApprovalFilter;\n  /**\n   * Optional description of the MCP server, used to provide more context to the model.\n   */\n  serverDescription?: string;\n}\n\n/**\n * Options for connecting to a remote MCP server via URL.\n */\nexport interface McpRemoteServerOptions extends McpBaseOptions {\n  /**\n   * The URL for the MCP server.\n   * The server must implement the Streamable HTTP or HTTP/SSE transport protocol.\n   */\n  serverUrl: string;\n}\n\n/**\n * Options for connecting to an OpenAI-maintained service connector.\n */\nexport interface McpConnectorOptions extends McpBaseOptions {\n  /**\n   * Identifier for the service connector.\n   * These are OpenAI-maintained MCP wrappers for popular services.\n   *\n   * Available connectors:\n   * - `connector_dropbox`: Dropbox file access\n   * - `connector_gmail`: Gmail email access\n   * - `connector_googlecalendar`: Google Calendar access\n   * - `connector_googledrive`: Google Drive file access\n   * - `connector_microsoftteams`: Microsoft Teams access\n   * - `connector_outlookcalendar`: Outlook Calendar access\n   * - `connector_outlookemail`: Outlook Email access\n   * - `connector_sharepoint`: SharePoint file access\n   */\n  connectorId: McpConnectorId;\n}\n\n/**\n * OpenAI MCP tool type for the Responses API.\n */\nexport type McpTool = OpenAIClient.Responses.Tool.Mcp;\n\n/**\n * Converts a McpToolFilter to the API format.\n */\nfunction convertToolFilter(\n  filter: McpToolFilter\n): OpenAIClient.Responses.Tool.Mcp.McpToolFilter {\n  return {\n    tool_names: filter.toolNames,\n    read_only: filter.readOnly,\n  };\n}\n\n/**\n * Converts allowed_tools option to API format.\n */\nfunction convertAllowedTools(\n  allowedTools: string[] | McpToolFilter | undefined\n): Array<string> | OpenAIClient.Responses.Tool.Mcp.McpToolFilter | undefined {\n  if (!allowedTools) return undefined;\n  if (Array.isArray(allowedTools)) return allowedTools;\n  return convertToolFilter(allowedTools);\n}\n\n/**\n * Converts require_approval option to API format.\n */\nfunction convertRequireApproval(\n  requireApproval: \"always\" | \"never\" | McpApprovalFilter | undefined\n):\n  | OpenAIClient.Responses.Tool.Mcp.McpToolApprovalFilter\n  | \"always\"\n  | \"never\"\n  | undefined {\n  if (!requireApproval) return undefined;\n  if (typeof requireApproval === \"string\") return requireApproval;\n  return {\n    always: requireApproval.always\n      ? convertToolFilter(requireApproval.always)\n      : undefined,\n    never: requireApproval.never\n      ? convertToolFilter(requireApproval.never)\n      : undefined,\n  };\n}\n\n/**\n * Creates an MCP tool that connects to a remote MCP server or OpenAI service connector.\n * This allows OpenAI models to access external tools and services via the Model Context Protocol.\n *\n * There are two ways to use MCP tools:\n * 1. **Remote MCP servers**: Connect to any server on the public Internet that implements\n *    the MCP protocol using `serverUrl`.\n * 2. **Connectors**: Use OpenAI-maintained MCP wrappers for popular services like\n *    Google Workspace or Dropbox using `connectorId`.\n *\n * @see {@link https://platform.openai.com/docs/guides/tools-remote-mcp | OpenAI MCP Documentation}\n *\n * @param options - Configuration options for the MCP tool\n * @returns An MCP tool definition to be passed to the OpenAI Responses API\n *\n * @example\n * ```typescript\n * import { ChatOpenAI, tools } from \"@langchain/openai\";\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o\" });\n *\n * // Using a remote MCP server\n * const response = await model.invoke(\"Roll 2d4+1\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverDescription: \"A D&D MCP server for dice rolling\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // Using a connector (e.g., Google Calendar)\n * const calendarResponse = await model.invoke(\"What's on my calendar today?\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"google_calendar\",\n *     connectorId: \"connector_googlecalendar\",\n *     authorization: \"<oauth-access-token>\",\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With tool filtering - only allow specific tools\n * const filteredResponse = await model.invoke(\"Roll some dice\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"dmcp\",\n *     serverUrl: \"https://dmcp-server.deno.dev/sse\",\n *     allowedTools: [\"roll\"],  // Only allow the \"roll\" tool\n *     requireApproval: \"never\",\n *   })],\n * });\n *\n * // With fine-grained approval control\n * const controlledResponse = await model.invoke(\"Search and modify files\", {\n *   tools: [tools.mcp({\n *     serverLabel: \"deepwiki\",\n *     serverUrl: \"https://mcp.deepwiki.com/mcp\",\n *     requireApproval: {\n *       never: { toolNames: [\"ask_question\", \"read_wiki_structure\"] },\n *       // All other tools will require approval\n *     },\n *   })],\n * });\n * ```\n */\nexport function mcp(options: McpRemoteServerOptions): ServerTool;\nexport function mcp(options: McpConnectorOptions): ServerTool;\nexport function mcp(\n  options: McpRemoteServerOptions | McpConnectorOptions\n): ServerTool {\n  const baseConfig: McpTool = {\n    type: \"mcp\",\n    server_label: options.serverLabel,\n    allowed_tools: convertAllowedTools(options.allowedTools),\n    authorization: options.authorization,\n    headers: options.headers,\n    require_approval: convertRequireApproval(options.requireApproval),\n    server_description: options.serverDescription,\n  };\n\n  if (\"serverUrl\" in options) {\n    return {\n      ...baseConfig,\n      server_url: options.serverUrl,\n    } satisfies McpTool;\n  }\n\n  return {\n    ...baseConfig,\n    connector_id: options.connectorId,\n  } satisfies McpTool;\n}\n"],"mappings":";;;;AA4HA,SAAS,kBACPA,QAC+C;AAC/C,QAAO;EACL,YAAY,OAAO;EACnB,WAAW,OAAO;CACnB;AACF;;;;AAKD,SAAS,oBACPC,cAC2E;AAC3E,KAAI,CAAC,aAAc,QAAO;AAC1B,KAAI,MAAM,QAAQ,aAAa,CAAE,QAAO;AACxC,QAAO,kBAAkB,aAAa;AACvC;;;;AAKD,SAAS,uBACPC,iBAKY;AACZ,KAAI,CAAC,gBAAiB,QAAO;AAC7B,KAAI,OAAO,oBAAoB,SAAU,QAAO;AAChD,QAAO;EACL,QAAQ,gBAAgB,SACpB,kBAAkB,gBAAgB,OAAO,GACzC;EACJ,OAAO,gBAAgB,QACnB,kBAAkB,gBAAgB,MAAM,GACxC;CACL;AACF;AAoED,SAAgB,IACdC,SACY;CACZ,MAAMC,aAAsB;EAC1B,MAAM;EACN,cAAc,QAAQ;EACtB,eAAe,oBAAoB,QAAQ,aAAa;EACxD,eAAe,QAAQ;EACvB,SAAS,QAAQ;EACjB,kBAAkB,uBAAuB,QAAQ,gBAAgB;EACjE,oBAAoB,QAAQ;CAC7B;AAED,KAAI,eAAe,QACjB,QAAO;EACL,GAAG;EACH,YAAY,QAAQ;CACrB;AAGH,QAAO;EACL,GAAG;EACH,cAAc,QAAQ;CACvB;AACF"}