@copilotkit/core 1.70.0 → 1.70.1

package/dist/index.cjs

@@ -2343,6 +2343,137 @@ function isForwardedToClientPlaceholder(content) {
 	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;
+	return document.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 {
+	entries = /* @__PURE__ */ new Map();
+	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) => {
+				if (this.entries.get(name)?.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 ?? {})
+					}
+				};
+				return await tool.handler(args, {
+					toolCall,
+					signal: 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
 /**
@@ -2425,6 +2556,12 @@ var RunHandler = class {
 	*/
 	_runDepth = 0;
 	/**
+	* Keeps tools that opt in via `webmcp` registered on the page's WebMCP model
+	* context (`document.modelContext`), in addition to the normal agent
+	* registration. Reconciled on every tool registry mutation.
+	*/
+	_webmcpRegistry = new WebMCPRegistry();
+	/**
 	* Tracks the threadId of the most recent `connectAgent` call so we
 	* can distinguish a fresh thread restore (different threadId than
 	* last time — chat is rebuilding state from scratch, must clear
@@ -2495,6 +2632,7 @@ var RunHandler = class {
 	initialize(tools) {
 		this._propTools = [...tools];
 		this._cachedMergedTools = null;
+		this.syncWebMCP();
 	}
 	/**
 	* Add a tool to the registry. Survives provider re-syncs ({@link setTools}),
@@ -2508,6 +2646,7 @@ var RunHandler = class {
 		}
 		this._hookTools.set(key, tool);
 		this._cachedMergedTools = null;
+		this.syncWebMCP();
 	}
 	/**
 	* Remove a tool by name and optionally by agentId
@@ -2519,6 +2658,7 @@ var RunHandler = class {
 			return !(tool.name === id && !tool.agentId);
 		});
 		this._cachedMergedTools = null;
+		this.syncWebMCP();
 	}
 	/**
 	* Get a tool by name and optionally by agentId.
@@ -2541,6 +2681,7 @@ var RunHandler = class {
 	setTools(tools) {
 		this._propTools = [...tools];
 		this._cachedMergedTools = null;
+		this.syncWebMCP();
 	}
 	/**
 	* Return the registered A2UI catalog components (readonly).
@@ -3062,6 +3203,7 @@ var RunHandler = class {
 		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) {
@@ -3078,6 +3220,32 @@ var RunHandler = class {
 		}));
 	}
 	/**
+	* 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) {
@@ -3110,36 +3278,6 @@ var RunHandler = class {
 	}
 };
 /**
-* 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.
@@ -6568,6 +6706,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;
@@ -6581,6 +6720,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;