@copilotkit/core 1.70.0 → 1.70.1

package/dist/index.umd.js

@@ -2491,6 +2491,141 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		return normalizeToolResultContent(content) === FORWARDED_TO_CLIENT;
 	}
 
+//#endregion
+//#region src/core/tool-schema.ts
+/**
+	* Empty tool schema constant
+	*/
+	const EMPTY_TOOL_SCHEMA = {
+		type: "object",
+		properties: {}
+	};
+	/**
+	* Create a JSON schema from a tool's parameters
+	*/
+	function createToolSchema(tool) {
+		if (!tool.parameters) return { ...EMPTY_TOOL_SCHEMA };
+		const rawSchema = (0, _copilotkit_shared.schemaToJsonSchema)(tool.parameters, { zodToJsonSchema: (schema, options) => (0, zod_to_json_schema.zodToJsonSchema)(schema, options) });
+		if (!rawSchema || typeof rawSchema !== "object") return { ...EMPTY_TOOL_SCHEMA };
+		const { $schema: _$schema, ...schema } = rawSchema;
+		if (typeof schema.type !== "string") schema.type = "object";
+		if (typeof schema.properties !== "object" || schema.properties === null) schema.properties = {};
+		stripAdditionalProperties(schema);
+		return schema;
+	}
+	/**
+	* Remove every `additionalProperties` key from a JSON schema tree, in place.
+	* Some LLM providers reject schemas that carry it.
+	*/
+	function stripAdditionalProperties(schema) {
+		if (!schema || typeof schema !== "object") return;
+		if (Array.isArray(schema)) {
+			schema.forEach(stripAdditionalProperties);
+			return;
+		}
+		const record = schema;
+		if (record.additionalProperties !== void 0) delete record.additionalProperties;
+		for (const value of Object.values(record)) stripAdditionalProperties(value);
+	}
+
+//#endregion
+//#region src/core/webmcp.ts
+/**
+	* Return the page's `document.modelContext`, or null when WebMCP is not
+	* available (SSR, React Native, browsers without the API enabled).
+	*/
+	function getWebMCPModelContext() {
+		if (typeof document === "undefined") return null;
+		const modelContext = document.modelContext;
+		return modelContext !== null && modelContext !== void 0 ? modelContext : null;
+	}
+	/**
+	* Keeps a set of frontend tools registered on the page's WebMCP model context.
+	*
+	* `sync(desired)` reconciles the registrations with the desired set: tools that
+	* are gone (or were re-registered with a new tool object) are unregistered by
+	* aborting their registration signal, and new tools are registered with an
+	* `execute` that delegates to the frontend tool's own handler.
+	*
+	* All WebMCP-API constraints live here so callers only supply the desired set:
+	* a tool without a description is skipped with a warning (the spec rejects
+	* empty descriptions), and failures from `registerTool` (duplicate name,
+	* unsupported context, ...) are warned rather than thrown.
+	*/
+	var WebMCPRegistry = class {
+		constructor() {
+			_defineProperty(this, "entries", /* @__PURE__ */ new Map());
+			_defineProperty(this, "warnedNames", /* @__PURE__ */ new Set());
+		}
+		/** Names currently kept registered on the model context. */
+		get registeredNames() {
+			return [...this.entries.keys()];
+		}
+		/** Reconcile the registered tools with the desired set. */
+		sync(desired) {
+			const modelContext = getWebMCPModelContext();
+			if (!modelContext) return;
+			for (const [name, entry] of [...this.entries]) if (desired.get(name) !== entry.tool) {
+				entry.controller.abort();
+				this.entries.delete(name);
+			}
+			for (const [name, tool] of desired) {
+				if (this.entries.has(name)) continue;
+				if (!tool.description) {
+					this.warnOnce(name, `Skipping WebMCP registration for tool '${name}': WebMCP requires a description.`);
+					continue;
+				}
+				const controller = new AbortController();
+				this.entries.set(name, {
+					tool,
+					controller
+				});
+				modelContext.registerTool(this.buildModelContextTool(tool), { signal: controller.signal }).catch((error) => {
+					var _this$entries$get;
+					if (((_this$entries$get = this.entries.get(name)) === null || _this$entries$get === void 0 ? void 0 : _this$entries$get.controller) !== controller) return;
+					this.entries.delete(name);
+					const message = error instanceof Error ? error.message : String(error);
+					this.warnOnce(name, `WebMCP registration failed for tool '${name}': ${message}`);
+				});
+			}
+		}
+		/**
+		* Build the WebMCP model-context tool for a frontend tool. The `execute`
+		* callback delegates to the frontend tool's own handler, so a browser agent
+		* call runs the same application code as an agent call.
+		*/
+		buildModelContextTool(tool) {
+			const annotations = typeof tool.webmcp === "object" ? tool.webmcp.annotations : void 0;
+			return {
+				name: tool.name,
+				description: tool.description,
+				inputSchema: createToolSchema(tool),
+				execute: async (args, options) => {
+					if (!tool.handler) return "";
+					const toolCall = {
+						id: (0, _copilotkit_shared.randomUUID)(),
+						type: "function",
+						function: {
+							name: tool.name,
+							arguments: JSON.stringify(args !== null && args !== void 0 ? args : {})
+						}
+					};
+					return await tool.handler(args, {
+						toolCall,
+						signal: options === null || options === void 0 ? void 0 : options.signal
+					});
+				},
+				...annotations ? { annotations } : {}
+			};
+		}
+		/** Log `message` once per tool name. Repeated syncs must not spam the log. */
+		warnOnce(name, message) {
+			if (this.warnedNames.has(name)) return;
+			this.warnedNames.add(name);
+			_copilotkit_shared.logger.warn(`[CopilotKit] ${message}`);
+		}
+	};
+
 //#endregion
 //#region src/core/run-handler.ts
 /**
@@ -2527,6 +2662,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			_defineProperty(this, "_disabledToolKeys", /* @__PURE__ */ new Set());
 			_defineProperty(this, "_runAbortController", null);
 			_defineProperty(this, "_runDepth", 0);
+			_defineProperty(this, "_webmcpRegistry", new WebMCPRegistry());
 			_defineProperty(this, "_lastConnectedThreadIdsByAgent", /* @__PURE__ */ new Map());
 			_defineProperty(this, "_anonymousAgentIds", /* @__PURE__ */ new WeakMap());
 			_defineProperty(this, "_nextAnonymousAgentId", 0);
@@ -2581,6 +2717,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		initialize(tools) {
 			this._propTools = [...tools];
 			this._cachedMergedTools = null;
+			this.syncWebMCP();
 		}
 		/**
 		* Add a tool to the registry. Survives provider re-syncs ({@link setTools}),
@@ -2594,6 +2731,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			}
 			this._hookTools.set(key, tool);
 			this._cachedMergedTools = null;
+			this.syncWebMCP();
 		}
 		/**
 		* Remove a tool by name and optionally by agentId
@@ -2605,6 +2743,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 				return !(tool.name === id && !tool.agentId);
 			});
 			this._cachedMergedTools = null;
+			this.syncWebMCP();
 		}
 		/**
 		* Get a tool by name and optionally by agentId.
@@ -2627,6 +2766,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		setTools(tools) {
 			this._propTools = [...tools];
 			this._cachedMergedTools = null;
+			this.syncWebMCP();
 		}
 		/**
 		* Return the registered A2UI catalog components (readonly).
@@ -3172,6 +3312,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			const key = this.capabilityKey(name, agentId);
 			if (enabled) this._disabledToolKeys.delete(key);
 			else this._disabledToolKeys.add(key);
+			this.syncWebMCP();
 		}
 		/** Whether a tool is currently enabled (not overridden off). Defaults true. */
 		isToolEnabled(name, agentId) {
@@ -3191,6 +3332,32 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			});
 		}
 		/**
+		* Reconcile the WebMCP registrations with the current tool registry. Tools
+		* opt in via `webmcp: true` or `webmcp: { annotations }`; the same
+		* availability rules as `buildFrontendTools` apply. WebMCP tools are
+		* page-level, so unlike the agent tool list they are not filtered by
+		* agentId — a name collision across agentIds keeps the first registration.
+		*/
+		syncWebMCP() {
+			const desired = /* @__PURE__ */ new Map();
+			const warnedCollisions = /* @__PURE__ */ new Set();
+			for (const tool of this.tools) {
+				if (!tool.webmcp) continue;
+				if (tool.name === WILDCARD_TOOL_NAME) continue;
+				if (tool.available === false || tool.available === "disabled") continue;
+				if (!this.isToolEnabled(tool.name, tool.agentId)) continue;
+				if (desired.has(tool.name)) {
+					if (!warnedCollisions.has(tool.name)) {
+						warnedCollisions.add(tool.name);
+						_copilotkit_shared.logger.warn(`[CopilotKit] Multiple WebMCP tools share the name '${tool.name}'. Only the first registration is exposed to browser agents.`);
+					}
+					continue;
+				}
+				desired.set(tool.name, tool);
+			}
+			this._webmcpRegistry.sync(desired);
+		}
+		/**
 		* Create an agent error subscriber
 		*/
 		createAgentErrorSubscriber(agent) {
@@ -3224,36 +3391,6 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		}
 	};
 	/**
-	* Empty tool schema constant
-	*/
-	const EMPTY_TOOL_SCHEMA = {
-		type: "object",
-		properties: {}
-	};
-	/**
-	* Create a JSON schema from a tool's parameters
-	*/
-	function createToolSchema(tool) {
-		if (!tool.parameters) return { ...EMPTY_TOOL_SCHEMA };
-		const rawSchema = (0, _copilotkit_shared.schemaToJsonSchema)(tool.parameters, { zodToJsonSchema: (schema, options) => (0, zod_to_json_schema.zodToJsonSchema)(schema, options) });
-		if (!rawSchema || typeof rawSchema !== "object") return { ...EMPTY_TOOL_SCHEMA };
-		const { $schema: _$schema, ...schema } = rawSchema;
-		if (typeof schema.type !== "string") schema.type = "object";
-		if (typeof schema.properties !== "object" || schema.properties === null) schema.properties = {};
-		stripAdditionalProperties(schema);
-		return schema;
-	}
-	function stripAdditionalProperties(schema) {
-		if (!schema || typeof schema !== "object") return;
-		if (Array.isArray(schema)) {
-			schema.forEach(stripAdditionalProperties);
-			return;
-		}
-		const record = schema;
-		if (record.additionalProperties !== void 0) delete record.additionalProperties;
-		for (const value of Object.values(record)) stripAdditionalProperties(value);
-	}
-	/**
 	* Ensures parsed tool arguments are a plain object.
 	* Throws for non-object values so the caller's catch block can emit
 	* a structured TOOL_ARGUMENT_PARSE_FAILED error.
@@ -6781,6 +6918,7 @@ exports.RunHandler = RunHandler;
 exports.StateManager = StateManager;
 exports.SuggestionEngine = SuggestionEngine;
 exports.ToolCallStatus = ToolCallStatus;
+exports.WebMCPRegistry = WebMCPRegistry;
 exports.completePartialMarkdown = completePartialMarkdown;
 exports.createActionGroup = createActionGroup;
 exports.createEffect = createEffect;
@@ -6794,6 +6932,7 @@ exports.emitInspectorViewThread = emitInspectorViewThread;
 exports.emitInspectorViewThreadResult = emitInspectorViewThreadResult;
 exports.empty = empty;
 exports.ensureObjectArgs = ensureObjectArgs;
+exports.getWebMCPModelContext = getWebMCPModelContext;
 exports.isAbortError = isAbortError;
 exports.isInspectorThreadBridgeEnabled = isInspectorThreadBridgeEnabled;
 exports.isRunCompletionAware = isRunCompletionAware;