@ai-sdk-tool/parser 3.0.0-canary.3 → 3.1.0

package/dist/index.d.cts

@@ -1,125 +1,6 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { LanguageModelV3FunctionTool, LanguageModelV3ToolCall, LanguageModelV3ToolResultPart, LanguageModelV3Content, LanguageModelV3StreamPart, LanguageModelV3Middleware, LanguageModelV3ProviderTool, JSONSchema7 } from '@ai-sdk/provider';
-
-/**
- * ToolCallProtocol
- *
- * A pluggable strategy that defines how tools are surfaced to a model, how
- * tool calls are rendered into provider-facing text, and how model output is
- * parsed back into the AI SDK v2 content/stream primitives.
- *
- * Implementations can choose any wire format (e.g. XML, JSON-with-tags, etc.)
- * as long as they respect the contract below:
- * - Static formatting helpers (`formatTools`, `formatToolCall`, `formatToolResponse`)
- *   are used to construct strings that the model will read.
- * - Parsing helpers (`parseGeneratedText`, `createStreamParser`) must convert
- *   model output back into structured `LanguageModelV3Content` parts, emitting
- *   `text` for regular content and `tool-call` for detected tool invocations.
- */
-interface ToolCallProtocol {
-    /**
-     * Produces a provider-facing string that describes all available tools.
-     *
-     * Typical usage is to serialize each tool's `name`, `description`, and
-     * JSON schema and inject that text into a system prompt using the supplied
-     * `toolSystemPromptTemplate`.
-     *
-     * Implementations should be resilient to empty inputs.
-     *
-     * @param tools List of tools that can be invoked by the model.
-     * @param toolSystemPromptTemplate Function that receives the serialized
-     *                                 tools and returns the final prompt text.
-     * @returns A string to be embedded into the model's system prompt.
-     */
-    formatTools({ tools, toolSystemPromptTemplate, }: {
-        tools: LanguageModelV3FunctionTool[];
-        toolSystemPromptTemplate: (tools: string) => string;
-    }): string;
-    /**
-     * Renders a single tool invocation into provider-facing text.
-     *
-     * Implementations may accept `toolCall.input` as a JSON string or as an
-     * object (some runtimes normalize prior to calling). The result should be a
-     * string that the model can understand and that the paired parser can later
-     * recognize and recover as a `tool-call`.
-     *
-     * @param toolCall The tool call to format for the model.
-     * @returns A textual representation of the tool call (e.g., an XML element).
-     */
-    formatToolCall(toolCall: LanguageModelV3ToolCall): string;
-    /**
-     * Formats a tool result payload so the model can consume it as plain text.
-     *
-     * This is commonly used to echo tool outputs back to the model in a format
-     * symmetrical to `formatToolCall`.
-     *
-     * @param toolResult The result part produced after executing a tool.
-     * @returns Textual representation of the tool result for the model.
-     */
-    formatToolResponse(toolResult: LanguageModelV3ToolResultPart): string;
-    /**
-     * Parses a fully generated text (non-streaming) response from the model and
-     * converts it into a sequence of `LanguageModelV3Content` parts.
-     *
-     * Implementations should:
-     * - Detect tool-call segments addressed to known `tools` and emit
-     *   `{ type: "tool-call", toolName, input }` parts.
-     * - Emit `{ type: "text", text }` parts for any non-tool segments.
-     * - Call `options.onError` and fall back to emitting the original text if a
-     *   segment cannot be parsed into a valid tool call.
-     *
-     * @param text The model output to parse.
-     * @param tools The list of tools that may be invoked.
-     * @param options Optional error callback for non-fatal parsing issues.
-     * @returns A list of structured content parts derived from the text.
-     */
-    parseGeneratedText({ text, tools, options, }: {
-        text: string;
-        tools: LanguageModelV3FunctionTool[];
-        options?: {
-            onError?: (message: string, metadata?: Record<string, unknown>) => void;
-        };
-    }): LanguageModelV3Content[];
-    /**
-     * Creates a TransformStream that converts streaming model deltas
-     * (`LanguageModelV3StreamPart`) into a normalized sequence of stream parts,
-     * including `text-start`/`text-delta`/`text-end` and `tool-call` events.
-     *
-     * The stream parser should:
-     * - Buffer text until a complete tool-call segment can be recognized, then
-     *   emit a `tool-call` part and properly close/open text segments around it.
-     * - Be robust to partial/incomplete fragments commonly seen in streaming.
-     * - Invoke `options.onError` and pass through the original text when a
-     *   segment cannot be parsed into a valid tool call.
-     *
-     * @param tools The list of tools that may be invoked by the model.
-     * @param options Optional error callback for non-fatal streaming issues.
-     * @returns A TransformStream that accepts and emits `LanguageModelV3StreamPart`s.
-     */
-    createStreamParser({ tools, options, }: {
-        tools: LanguageModelV3FunctionTool[];
-        options?: {
-            onError?: (message: string, metadata?: Record<string, unknown>) => void;
-        };
-    }): TransformStream<LanguageModelV3StreamPart, LanguageModelV3StreamPart>;
-    /**
-     * Optionally returns the exact substrings that would be parsed as tool-calls
-     * from the provided text for this protocol.
-     * Used for debug logging in parse mode.
-     */
-    extractToolCallSegments?: ({ text, tools, }: {
-        text: string;
-        tools: LanguageModelV3FunctionTool[];
-    }) => string[];
-}
-
-interface JsonMixOptions {
-    toolCallStart?: string;
-    toolCallEnd?: string;
-    toolResponseStart?: string;
-    toolResponseEnd?: string;
-}
-declare const jsonMixProtocol: ({ toolCallStart, toolCallEnd, toolResponseStart, toolResponseEnd, }?: JsonMixOptions) => ToolCallProtocol;
+import { LanguageModelV3FunctionTool, LanguageModelV3ToolCall, LanguageModelV3Content, LanguageModelV3StreamPart, LanguageModelV3ProviderTool, JSONSchema7, LanguageModelV3, LanguageModelV3Middleware, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
+import { ToolResultPart } from '@ai-sdk/provider-utils';
 
 /**
  * Heuristic Engine for XML Tool-Call Parsing
@@ -179,20 +60,57 @@ declare const dedupeShellStringTagsHeuristic: ToolCallHeuristic$1;
 declare const repairAgainstSchemaHeuristic: ToolCallHeuristic$1;
 declare const defaultPipelineConfig: PipelineConfig$1;
 
+interface TCMProtocol {
+    formatTools({ tools, toolSystemPromptTemplate, }: {
+        tools: LanguageModelV3FunctionTool[];
+        toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    }): string;
+    formatToolCall(toolCall: LanguageModelV3ToolCall): string;
+    parseGeneratedText({ text, tools, options, }: {
+        text: string;
+        tools: LanguageModelV3FunctionTool[];
+        options?: {
+            onError?: (message: string, metadata?: Record<string, unknown>) => void;
+        };
+    }): LanguageModelV3Content[];
+    createStreamParser({ tools, options, }: {
+        tools: LanguageModelV3FunctionTool[];
+        options?: {
+            onError?: (message: string, metadata?: Record<string, unknown>) => void;
+        };
+    }): TransformStream<LanguageModelV3StreamPart, LanguageModelV3StreamPart>;
+    extractToolCallSegments?: ({ text, tools, }: {
+        text: string;
+        tools: LanguageModelV3FunctionTool[];
+    }) => string[];
+}
+type TCMCoreProtocol = TCMProtocol;
+declare function isProtocolFactory(protocol: TCMProtocol | (() => TCMProtocol)): protocol is () => TCMProtocol;
+declare function isTCMProtocolFactory(protocol: TCMProtocol | (() => TCMProtocol)): protocol is () => TCMProtocol;
+
+interface JsonProtocolOptions {
+    toolCallStart?: string;
+    toolCallEnd?: string;
+}
+declare const jsonProtocol: ({ toolCallStart, toolCallEnd, }?: JsonProtocolOptions) => TCMProtocol;
+
 type PipelineConfig = PipelineConfig$1;
 type ToolCallHeuristic = ToolCallHeuristic$1;
-interface MorphXmlProtocolOptions {
+interface XmlProtocolOptions {
     heuristics?: ToolCallHeuristic[];
     pipeline?: PipelineConfig;
     maxReparses?: number;
 }
-declare const morphXmlProtocol: (protocolOptions?: MorphXmlProtocolOptions) => ToolCallProtocol;
+declare const xmlProtocol: (protocolOptions?: XmlProtocolOptions) => TCMCoreProtocol;
 
-declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, placement, }: {
-    protocol: ToolCallProtocol | (() => ToolCallProtocol);
-    toolSystemPromptTemplate: (tools: string) => string;
-    placement?: "first" | "last";
-}): LanguageModelV3Middleware;
+interface YamlProtocolOptions {
+    /**
+     * Whether to include a system prompt example showing YAML multiline syntax.
+     * @default true
+     */
+    includeMultilineExample?: boolean;
+}
+declare const yamlProtocol: (_protocolOptions?: YamlProtocolOptions) => TCMCoreProtocol;
 
 type DebugLevel = "off" | "stream" | "parse";
 declare function getDebugLevel(): DebugLevel;
@@ -388,13 +306,122 @@ declare function parse(text: string, optsOrReviver?: ParseOptions | ((key: strin
 declare function stringify(obj: unknown): string;
 
 declare function isToolCallContent(content: unknown): content is LanguageModelV3ToolCall;
-declare function isToolResultPart(content: unknown): content is LanguageModelV3ToolResultPart;
+declare function isToolResultPart(content: unknown): content is ToolResultPart;
 declare function hasInputProperty(obj: unknown): obj is {
     input?: unknown;
 };
 
-declare const gemmaToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare function wrapGenerate({ protocol, doGenerate, params, }: {
+    protocol: TCMCoreProtocol;
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    params: {
+        providerOptions?: ToolCallMiddlewareProviderOptions;
+    };
+}): Promise<_ai_sdk_provider.LanguageModelV3GenerateResult>;
+
 declare const hermesToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
-declare const morphXmlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare const xmlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare const yamlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+
+declare function wrapStream({ protocol, doStream, doGenerate, params, }: {
+    protocol: TCMCoreProtocol;
+    doStream: () => ReturnType<LanguageModelV3["doStream"]>;
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    params: {
+        providerOptions?: ToolCallMiddlewareProviderOptions;
+    };
+}): Promise<{
+    stream: ReadableStream<LanguageModelV3StreamPart>;
+    request?: {
+        body?: unknown;
+    };
+    response?: {
+        headers?: _ai_sdk_provider.SharedV3Headers;
+    };
+}>;
+declare function toolChoiceStream({ doGenerate, options, }: {
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    options?: {
+        onError?: (message: string, metadata?: Record<string, unknown>) => void;
+    };
+}): Promise<{
+    request: {
+        body?: unknown;
+    };
+    response: _ai_sdk_provider.LanguageModelV3ResponseMetadata & {
+        headers?: _ai_sdk_provider.SharedV3Headers;
+        body?: unknown;
+    };
+    stream: ReadableStream<LanguageModelV3StreamPart>;
+}>;
+
+declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, toolResponsePromptTemplate, placement, }: {
+    protocol: TCMCoreProtocol | (() => TCMCoreProtocol);
+    toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    toolResponsePromptTemplate?: (toolResult: ToolResultPart) => string;
+    placement?: "first" | "last";
+}): LanguageModelV3Middleware;
+
+declare function transformParams({ params, protocol, toolSystemPromptTemplate, toolResponsePromptTemplate, placement, }: {
+    params: {
+        prompt?: LanguageModelV3Prompt;
+        tools?: Array<LanguageModelV3FunctionTool | {
+            type: string;
+        }>;
+        providerOptions?: {
+            toolCallMiddleware?: {
+                toolChoice?: {
+                    type: string;
+                };
+            };
+        };
+        toolChoice?: {
+            type: string;
+            toolName?: string;
+        };
+    };
+    protocol: TCMCoreProtocol | (() => TCMCoreProtocol);
+    toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    toolResponsePromptTemplate?: (toolResult: ToolResultPart) => string;
+    placement?: "first" | "last";
+}): {
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+    providerOptions: SharedV3ProviderOptions;
+} | {
+    responseFormat: {
+        type: "json";
+        schema: JSONSchema7;
+        name: string;
+        description: string | undefined;
+    };
+    providerOptions: {
+        toolCallMiddleware: {
+            toolChoice?: {
+                type: string;
+                toolName?: string;
+            } | undefined;
+        };
+    };
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+} | {
+    responseFormat: {
+        type: "json";
+        schema: JSONSchema7;
+    };
+    providerOptions: {
+        toolCallMiddleware: {
+            toolChoice: {
+                type: "required";
+            };
+        };
+    };
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+};
 
-export { type DebugLevel, type HeuristicEngineOptions, type HeuristicPhase, type HeuristicResult, type IntermediateCall, type MorphXmlProtocolOptions, type OnErrorFn, type PipelineConfig$1 as PipelineConfig, type ParseOptions as RJSONParseOptions, type ToolCallHeuristic$1 as ToolCallHeuristic, type ToolCallMiddlewareProviderOptions, applyHeuristicPipeline, balanceTagsHeuristic, createDynamicIfThenElseSchema, createIntermediateCall, createToolMiddleware, decodeOriginalTools, dedupeShellStringTagsHeuristic, defaultPipelineConfig, encodeOriginalTools, escapeInvalidLtHeuristic, escapeRegExp, extractOnErrorOption, extractToolNamesFromOriginalTools, gemmaToolMiddleware, getDebugLevel, getPotentialStartIndex, hasInputProperty, hermesToolMiddleware, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonMixProtocol, logParseFailure, logParsedChunk, logParsedSummary, logRawChunk, mergePipelineConfigs, morphXmlProtocol, morphXmlToolMiddleware, normalizeCloseTagsHeuristic, originalToolsSchema, parse as parseRJSON, repairAgainstSchemaHeuristic, stringify as stringifyRJSON, transform as transformRJSON };
+export { type DebugLevel, type HeuristicEngineOptions, type HeuristicPhase, type HeuristicResult, type IntermediateCall, type OnErrorFn, type ParseOptions, type PipelineConfig$1 as PipelineConfig, type TCMCoreProtocol, type TCMProtocol, type ToolCallHeuristic$1 as ToolCallHeuristic, type ToolCallMiddlewareProviderOptions, type XmlProtocolOptions, type YamlProtocolOptions, applyHeuristicPipeline, balanceTagsHeuristic, createDynamicIfThenElseSchema, createIntermediateCall, createToolMiddleware, decodeOriginalTools, dedupeShellStringTagsHeuristic, defaultPipelineConfig, encodeOriginalTools, escapeInvalidLtHeuristic, escapeRegExp, extractOnErrorOption, extractToolNamesFromOriginalTools, getDebugLevel, getPotentialStartIndex, hasInputProperty, hermesToolMiddleware, isProtocolFactory, isTCMProtocolFactory, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonProtocol, logParseFailure, logParsedChunk, logParsedSummary, logRawChunk, mergePipelineConfigs, normalizeCloseTagsHeuristic, originalToolsSchema, parse, repairAgainstSchemaHeuristic, stringify, toolChoiceStream, transform, transformParams, wrapGenerate, wrapStream, xmlProtocol, xmlToolMiddleware, yamlProtocol, yamlToolMiddleware };

package/dist/index.d.ts

@@ -1,125 +1,6 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { LanguageModelV3FunctionTool, LanguageModelV3ToolCall, LanguageModelV3ToolResultPart, LanguageModelV3Content, LanguageModelV3StreamPart, LanguageModelV3Middleware, LanguageModelV3ProviderTool, JSONSchema7 } from '@ai-sdk/provider';
-
-/**
- * ToolCallProtocol
- *
- * A pluggable strategy that defines how tools are surfaced to a model, how
- * tool calls are rendered into provider-facing text, and how model output is
- * parsed back into the AI SDK v2 content/stream primitives.
- *
- * Implementations can choose any wire format (e.g. XML, JSON-with-tags, etc.)
- * as long as they respect the contract below:
- * - Static formatting helpers (`formatTools`, `formatToolCall`, `formatToolResponse`)
- *   are used to construct strings that the model will read.
- * - Parsing helpers (`parseGeneratedText`, `createStreamParser`) must convert
- *   model output back into structured `LanguageModelV3Content` parts, emitting
- *   `text` for regular content and `tool-call` for detected tool invocations.
- */
-interface ToolCallProtocol {
-    /**
-     * Produces a provider-facing string that describes all available tools.
-     *
-     * Typical usage is to serialize each tool's `name`, `description`, and
-     * JSON schema and inject that text into a system prompt using the supplied
-     * `toolSystemPromptTemplate`.
-     *
-     * Implementations should be resilient to empty inputs.
-     *
-     * @param tools List of tools that can be invoked by the model.
-     * @param toolSystemPromptTemplate Function that receives the serialized
-     *                                 tools and returns the final prompt text.
-     * @returns A string to be embedded into the model's system prompt.
-     */
-    formatTools({ tools, toolSystemPromptTemplate, }: {
-        tools: LanguageModelV3FunctionTool[];
-        toolSystemPromptTemplate: (tools: string) => string;
-    }): string;
-    /**
-     * Renders a single tool invocation into provider-facing text.
-     *
-     * Implementations may accept `toolCall.input` as a JSON string or as an
-     * object (some runtimes normalize prior to calling). The result should be a
-     * string that the model can understand and that the paired parser can later
-     * recognize and recover as a `tool-call`.
-     *
-     * @param toolCall The tool call to format for the model.
-     * @returns A textual representation of the tool call (e.g., an XML element).
-     */
-    formatToolCall(toolCall: LanguageModelV3ToolCall): string;
-    /**
-     * Formats a tool result payload so the model can consume it as plain text.
-     *
-     * This is commonly used to echo tool outputs back to the model in a format
-     * symmetrical to `formatToolCall`.
-     *
-     * @param toolResult The result part produced after executing a tool.
-     * @returns Textual representation of the tool result for the model.
-     */
-    formatToolResponse(toolResult: LanguageModelV3ToolResultPart): string;
-    /**
-     * Parses a fully generated text (non-streaming) response from the model and
-     * converts it into a sequence of `LanguageModelV3Content` parts.
-     *
-     * Implementations should:
-     * - Detect tool-call segments addressed to known `tools` and emit
-     *   `{ type: "tool-call", toolName, input }` parts.
-     * - Emit `{ type: "text", text }` parts for any non-tool segments.
-     * - Call `options.onError` and fall back to emitting the original text if a
-     *   segment cannot be parsed into a valid tool call.
-     *
-     * @param text The model output to parse.
-     * @param tools The list of tools that may be invoked.
-     * @param options Optional error callback for non-fatal parsing issues.
-     * @returns A list of structured content parts derived from the text.
-     */
-    parseGeneratedText({ text, tools, options, }: {
-        text: string;
-        tools: LanguageModelV3FunctionTool[];
-        options?: {
-            onError?: (message: string, metadata?: Record<string, unknown>) => void;
-        };
-    }): LanguageModelV3Content[];
-    /**
-     * Creates a TransformStream that converts streaming model deltas
-     * (`LanguageModelV3StreamPart`) into a normalized sequence of stream parts,
-     * including `text-start`/`text-delta`/`text-end` and `tool-call` events.
-     *
-     * The stream parser should:
-     * - Buffer text until a complete tool-call segment can be recognized, then
-     *   emit a `tool-call` part and properly close/open text segments around it.
-     * - Be robust to partial/incomplete fragments commonly seen in streaming.
-     * - Invoke `options.onError` and pass through the original text when a
-     *   segment cannot be parsed into a valid tool call.
-     *
-     * @param tools The list of tools that may be invoked by the model.
-     * @param options Optional error callback for non-fatal streaming issues.
-     * @returns A TransformStream that accepts and emits `LanguageModelV3StreamPart`s.
-     */
-    createStreamParser({ tools, options, }: {
-        tools: LanguageModelV3FunctionTool[];
-        options?: {
-            onError?: (message: string, metadata?: Record<string, unknown>) => void;
-        };
-    }): TransformStream<LanguageModelV3StreamPart, LanguageModelV3StreamPart>;
-    /**
-     * Optionally returns the exact substrings that would be parsed as tool-calls
-     * from the provided text for this protocol.
-     * Used for debug logging in parse mode.
-     */
-    extractToolCallSegments?: ({ text, tools, }: {
-        text: string;
-        tools: LanguageModelV3FunctionTool[];
-    }) => string[];
-}
-
-interface JsonMixOptions {
-    toolCallStart?: string;
-    toolCallEnd?: string;
-    toolResponseStart?: string;
-    toolResponseEnd?: string;
-}
-declare const jsonMixProtocol: ({ toolCallStart, toolCallEnd, toolResponseStart, toolResponseEnd, }?: JsonMixOptions) => ToolCallProtocol;
+import { LanguageModelV3FunctionTool, LanguageModelV3ToolCall, LanguageModelV3Content, LanguageModelV3StreamPart, LanguageModelV3ProviderTool, JSONSchema7, LanguageModelV3, LanguageModelV3Middleware, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
+import { ToolResultPart } from '@ai-sdk/provider-utils';
 
 /**
  * Heuristic Engine for XML Tool-Call Parsing
@@ -179,20 +60,57 @@ declare const dedupeShellStringTagsHeuristic: ToolCallHeuristic$1;
 declare const repairAgainstSchemaHeuristic: ToolCallHeuristic$1;
 declare const defaultPipelineConfig: PipelineConfig$1;
 
+interface TCMProtocol {
+    formatTools({ tools, toolSystemPromptTemplate, }: {
+        tools: LanguageModelV3FunctionTool[];
+        toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    }): string;
+    formatToolCall(toolCall: LanguageModelV3ToolCall): string;
+    parseGeneratedText({ text, tools, options, }: {
+        text: string;
+        tools: LanguageModelV3FunctionTool[];
+        options?: {
+            onError?: (message: string, metadata?: Record<string, unknown>) => void;
+        };
+    }): LanguageModelV3Content[];
+    createStreamParser({ tools, options, }: {
+        tools: LanguageModelV3FunctionTool[];
+        options?: {
+            onError?: (message: string, metadata?: Record<string, unknown>) => void;
+        };
+    }): TransformStream<LanguageModelV3StreamPart, LanguageModelV3StreamPart>;
+    extractToolCallSegments?: ({ text, tools, }: {
+        text: string;
+        tools: LanguageModelV3FunctionTool[];
+    }) => string[];
+}
+type TCMCoreProtocol = TCMProtocol;
+declare function isProtocolFactory(protocol: TCMProtocol | (() => TCMProtocol)): protocol is () => TCMProtocol;
+declare function isTCMProtocolFactory(protocol: TCMProtocol | (() => TCMProtocol)): protocol is () => TCMProtocol;
+
+interface JsonProtocolOptions {
+    toolCallStart?: string;
+    toolCallEnd?: string;
+}
+declare const jsonProtocol: ({ toolCallStart, toolCallEnd, }?: JsonProtocolOptions) => TCMProtocol;
+
 type PipelineConfig = PipelineConfig$1;
 type ToolCallHeuristic = ToolCallHeuristic$1;
-interface MorphXmlProtocolOptions {
+interface XmlProtocolOptions {
     heuristics?: ToolCallHeuristic[];
     pipeline?: PipelineConfig;
     maxReparses?: number;
 }
-declare const morphXmlProtocol: (protocolOptions?: MorphXmlProtocolOptions) => ToolCallProtocol;
+declare const xmlProtocol: (protocolOptions?: XmlProtocolOptions) => TCMCoreProtocol;
 
-declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, placement, }: {
-    protocol: ToolCallProtocol | (() => ToolCallProtocol);
-    toolSystemPromptTemplate: (tools: string) => string;
-    placement?: "first" | "last";
-}): LanguageModelV3Middleware;
+interface YamlProtocolOptions {
+    /**
+     * Whether to include a system prompt example showing YAML multiline syntax.
+     * @default true
+     */
+    includeMultilineExample?: boolean;
+}
+declare const yamlProtocol: (_protocolOptions?: YamlProtocolOptions) => TCMCoreProtocol;
 
 type DebugLevel = "off" | "stream" | "parse";
 declare function getDebugLevel(): DebugLevel;
@@ -388,13 +306,122 @@ declare function parse(text: string, optsOrReviver?: ParseOptions | ((key: strin
 declare function stringify(obj: unknown): string;
 
 declare function isToolCallContent(content: unknown): content is LanguageModelV3ToolCall;
-declare function isToolResultPart(content: unknown): content is LanguageModelV3ToolResultPart;
+declare function isToolResultPart(content: unknown): content is ToolResultPart;
 declare function hasInputProperty(obj: unknown): obj is {
     input?: unknown;
 };
 
-declare const gemmaToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare function wrapGenerate({ protocol, doGenerate, params, }: {
+    protocol: TCMCoreProtocol;
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    params: {
+        providerOptions?: ToolCallMiddlewareProviderOptions;
+    };
+}): Promise<_ai_sdk_provider.LanguageModelV3GenerateResult>;
+
 declare const hermesToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
-declare const morphXmlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare const xmlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+declare const yamlToolMiddleware: _ai_sdk_provider.LanguageModelV3Middleware;
+
+declare function wrapStream({ protocol, doStream, doGenerate, params, }: {
+    protocol: TCMCoreProtocol;
+    doStream: () => ReturnType<LanguageModelV3["doStream"]>;
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    params: {
+        providerOptions?: ToolCallMiddlewareProviderOptions;
+    };
+}): Promise<{
+    stream: ReadableStream<LanguageModelV3StreamPart>;
+    request?: {
+        body?: unknown;
+    };
+    response?: {
+        headers?: _ai_sdk_provider.SharedV3Headers;
+    };
+}>;
+declare function toolChoiceStream({ doGenerate, options, }: {
+    doGenerate: () => ReturnType<LanguageModelV3["doGenerate"]>;
+    options?: {
+        onError?: (message: string, metadata?: Record<string, unknown>) => void;
+    };
+}): Promise<{
+    request: {
+        body?: unknown;
+    };
+    response: _ai_sdk_provider.LanguageModelV3ResponseMetadata & {
+        headers?: _ai_sdk_provider.SharedV3Headers;
+        body?: unknown;
+    };
+    stream: ReadableStream<LanguageModelV3StreamPart>;
+}>;
+
+declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, toolResponsePromptTemplate, placement, }: {
+    protocol: TCMCoreProtocol | (() => TCMCoreProtocol);
+    toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    toolResponsePromptTemplate?: (toolResult: ToolResultPart) => string;
+    placement?: "first" | "last";
+}): LanguageModelV3Middleware;
+
+declare function transformParams({ params, protocol, toolSystemPromptTemplate, toolResponsePromptTemplate, placement, }: {
+    params: {
+        prompt?: LanguageModelV3Prompt;
+        tools?: Array<LanguageModelV3FunctionTool | {
+            type: string;
+        }>;
+        providerOptions?: {
+            toolCallMiddleware?: {
+                toolChoice?: {
+                    type: string;
+                };
+            };
+        };
+        toolChoice?: {
+            type: string;
+            toolName?: string;
+        };
+    };
+    protocol: TCMCoreProtocol | (() => TCMCoreProtocol);
+    toolSystemPromptTemplate: (tools: LanguageModelV3FunctionTool[]) => string;
+    toolResponsePromptTemplate?: (toolResult: ToolResultPart) => string;
+    placement?: "first" | "last";
+}): {
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+    providerOptions: SharedV3ProviderOptions;
+} | {
+    responseFormat: {
+        type: "json";
+        schema: JSONSchema7;
+        name: string;
+        description: string | undefined;
+    };
+    providerOptions: {
+        toolCallMiddleware: {
+            toolChoice?: {
+                type: string;
+                toolName?: string;
+            } | undefined;
+        };
+    };
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+} | {
+    responseFormat: {
+        type: "json";
+        schema: JSONSchema7;
+    };
+    providerOptions: {
+        toolCallMiddleware: {
+            toolChoice: {
+                type: "required";
+            };
+        };
+    };
+    prompt: LanguageModelV3Prompt;
+    tools: never[];
+    toolChoice: undefined;
+};
 
-export { type DebugLevel, type HeuristicEngineOptions, type HeuristicPhase, type HeuristicResult, type IntermediateCall, type MorphXmlProtocolOptions, type OnErrorFn, type PipelineConfig$1 as PipelineConfig, type ParseOptions as RJSONParseOptions, type ToolCallHeuristic$1 as ToolCallHeuristic, type ToolCallMiddlewareProviderOptions, applyHeuristicPipeline, balanceTagsHeuristic, createDynamicIfThenElseSchema, createIntermediateCall, createToolMiddleware, decodeOriginalTools, dedupeShellStringTagsHeuristic, defaultPipelineConfig, encodeOriginalTools, escapeInvalidLtHeuristic, escapeRegExp, extractOnErrorOption, extractToolNamesFromOriginalTools, gemmaToolMiddleware, getDebugLevel, getPotentialStartIndex, hasInputProperty, hermesToolMiddleware, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonMixProtocol, logParseFailure, logParsedChunk, logParsedSummary, logRawChunk, mergePipelineConfigs, morphXmlProtocol, morphXmlToolMiddleware, normalizeCloseTagsHeuristic, originalToolsSchema, parse as parseRJSON, repairAgainstSchemaHeuristic, stringify as stringifyRJSON, transform as transformRJSON };
+export { type DebugLevel, type HeuristicEngineOptions, type HeuristicPhase, type HeuristicResult, type IntermediateCall, type OnErrorFn, type ParseOptions, type PipelineConfig$1 as PipelineConfig, type TCMCoreProtocol, type TCMProtocol, type ToolCallHeuristic$1 as ToolCallHeuristic, type ToolCallMiddlewareProviderOptions, type XmlProtocolOptions, type YamlProtocolOptions, applyHeuristicPipeline, balanceTagsHeuristic, createDynamicIfThenElseSchema, createIntermediateCall, createToolMiddleware, decodeOriginalTools, dedupeShellStringTagsHeuristic, defaultPipelineConfig, encodeOriginalTools, escapeInvalidLtHeuristic, escapeRegExp, extractOnErrorOption, extractToolNamesFromOriginalTools, getDebugLevel, getPotentialStartIndex, hasInputProperty, hermesToolMiddleware, isProtocolFactory, isTCMProtocolFactory, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonProtocol, logParseFailure, logParsedChunk, logParsedSummary, logRawChunk, mergePipelineConfigs, normalizeCloseTagsHeuristic, originalToolsSchema, parse, repairAgainstSchemaHeuristic, stringify, toolChoiceStream, transform, transformParams, wrapGenerate, wrapStream, xmlProtocol, xmlToolMiddleware, yamlProtocol, yamlToolMiddleware };