@ai-sdk-tool/parser 3.2.0 → 3.3.0

package/README.md

@@ -1,131 +1,39 @@
-# AI SDK - tool call parser middleware
+<img width="3168" height="1344" alt="AI SDK Tool monorepo banner" src="https://github.com/user-attachments/assets/9a002988-e535-42ac-8baf-56ec8754410f" />
 
-▲ Also available in the Vercel AI SDK official documentation: [Custom tool call parser](https://ai-sdk.dev/docs/ai-sdk-core/middleware#custom-tool-call-parser)
-
-[![npm](https://img.shields.io/npm/v/@ai-sdk-tool/parser)](https://www.npmjs.com/package/@ai-sdk-tool/parser)
-[![npm](https://img.shields.io/npm/dt/@ai-sdk-tool/parser)](https://www.npmjs.com/package/@ai-sdk-tool/parser)
+----
+[![npm - parser](https://img.shields.io/npm/v/@ai-sdk-tool/parser)](https://www.npmjs.com/package/@ai-sdk-tool/parser)
+[![npm downloads - parser](https://img.shields.io/npm/dt/@ai-sdk-tool/parser)](https://www.npmjs.com/package/@ai-sdk-tool/parser)
 [![codecov](https://codecov.io/gh/minpeter/ai-sdk-tool-call-middleware/branch/main/graph/badge.svg)](https://codecov.io/gh/minpeter/ai-sdk-tool-call-middleware)
 
-> [!NOTE]
-> Requires AI SDK v6. For AI SDK v5, use `@ai-sdk-tool/parser@3.x`. For AI SDK v4, pin `@ai-sdk-tool/parser@1.0.0`.
-
-Middleware that enables tool calling with models that don’t natively support OpenAI‑style `tools`. Works with any provider (OpenRouter, vLLM, Ollama, etc.) via AI SDK middleware.
-
-## Why This Exists
-
-Many self‑hosted or third‑party model endpoints (vLLM, MLC‑LLM, Ollama, OpenRouter, etc.) don’t yet expose the OpenAI‑style `tools` parameter, forcing you to hack together tool parsing.  
-This project provides a flexible middleware that:
+Tooling for Vercel AI SDK: enable tool calling with models lacking native `tools`.
 
-- Parses tool calls from streaming or batch responses
-- Prebuilt protocols: JSON‑mix (Gemma/Hermes‑style) and Morph‑XML
-- Full control over the tool call system prompt
+- **@ai-sdk-tool/parser**: add tool-calling via middleware; works with any provider supported by AI SDK `wrapLanguageModel`.
+- **@ai-sdk-tool/parser/rxml**: robust XML parser/streamer/builder for AI-generated XML.
+- **@ai-sdk-tool/parser/rjson**: relaxed JSON parser with tolerant mode and JSON5-like syntax support.
 
-## Installation
+## Usage at a glance
 
-```bash
-pnpm add @ai-sdk-tool/parser
-```
-
-## Quickstart (streaming)
-
-```typescript
+```ts
+import { wrapLanguageModel, streamText } from "ai";
 import { createOpenAICompatible } from "@ai-sdk/openai-compatible";
-import { wrapLanguageModel, stepCountIs, streamText } from "ai";
 import { xmlToolMiddleware } from "@ai-sdk-tool/parser";
 
-const openrouter = createOpenAICompatible({
-  /* ... */
+const client = createOpenAICompatible({
+  /* baseURL, apiKey */
 });
 
-async function main() {
-  const result = streamText({
-    model: wrapLanguageModel({
-      model: openrouter("your-model-name"),
-      middleware: xmlToolMiddleware,
-    }),
-    system: "You are a helpful assistant.",
-    prompt: "What is the weather in my city?",
-    stopWhen: stepCountIs(4),
-    tools: {
-      get_location: {
-        /* ... */
-      },
-      get_weather: {
-        /* ... */
-      },
-    },
-  });
-
-  for await (const part of result.fullStream) {
-    // handle text/tool events
-  }
-}
-
-main().catch(console.error);
-```
-
-## Quickstart (generate)
-
-```typescript
-import { createOpenAICompatible } from "@ai-sdk/openai-compatible";
-import { wrapLanguageModel, generateText } from "ai";
-import { hermesToolMiddleware } from "@ai-sdk-tool/parser";
-
-const openrouter = createOpenAICompatible({
-  /* ... */
+const result = streamText({
+  model: wrapLanguageModel({
+    model: client("your-model-name"),
+    middleware: xmlToolMiddleware,
+  }),
+  tools: {
+    /* your tools */
+  },
+  prompt: "Find weather for Seoul today",
 });
 
-async function main() {
-  const { text } = await generateText({
-    model: wrapLanguageModel({
-      model: openrouter("nousresearch/hermes-3-llama-3.1-70b"),
-      middleware: hermesToolMiddleware,
-    }),
-    prompt: "Find weather for Seoul today",
-    tools: {
-      get_weather: {
-        /* ... */
-      },
-    },
-  });
-
-  console.log(text);
+for await (const part of result.fullStream) {
+  // handle text and tool events
 }
-
-main().catch(console.error);
 ```
-
-## Prebuilt middlewares
-
-- `hermesToolMiddleware` — JSON‑mix format wrapped in `<tool_call>` XML tags.
-- `xmlToolMiddleware` — XML format (Morph‑XML protocol).
-
-## Protocols
-
-- `jsonProtocol` — JSON function calls in flexible text wrappers.
-- `xmlProtocol` — XML element per call, robust to streaming.
-
-## Tool choice support
-
-- `toolChoice: { type: "required" }`: forces one tool call. Middleware sets a JSON response schema to validate calls.
-- `toolChoice: { type: "tool", toolName }`: forces a specific tool. Provider‑defined tools are not supported; pass only custom function tools.
-- `toolChoice: { type: "none" }` is not supported and will throw.
-
-## Examples
-
-See `examples/parser-core/src/*` for runnable demos (streaming/non‑streaming, tool choice).
-
-## [dev] Contributor notes
-
-- Debugging:
-  - Set `DEBUG_PARSER_MW=stream` to log raw/parsed chunks during runs.
-  - Set `DEBUG_PARSER_MW=parse` to log original matched text and parsed summary.
-  - Optional `DEBUG_PARSER_MW_STYLE=bg|inverse|underline|bold` to change highlight style.
-- Provider options passthrough: `providerOptions.toolCallMiddleware` fields are merged into protocol options. Internal fields used:
-  - `originalTools`: internal propagation of custom tool schemas.
-  - `toolChoice`: internal fast‑path activation for required/specific tool modes.
-- Transform details: `transformParams` injects a system message built from protocol `formatTools` and clears `tools` since many providers strip/ignore them.
-
-## License
-
-Licensed under Apache License 2.0. See the repository `LICENSE`. Include the `NOTICE` file in distributions.