@sisu-ai/tool-summarize-text 9.0.1 → 9.0.3

package/README.md

@@ -1,3 +1,9 @@
+<div align="right">
+  <a href="https://github.com/finger-gun/sisu"><img src="https://github.com/finger-gun/sisu/raw/main/sisu-light.svg" alt="ProjectSpecs" width="100" /></a>
+</div>
+
+---
+
 # Summarize Text Tool
 
 A utility tool that asks the active model to summarize large text bodies into concise outputs. Designed for use alongside `webFetch` or other content tools.
@@ -33,3 +39,78 @@ Discover what you can do through examples or documentation. Check it out at http
 - [License](https://github.com/finger-gun/sisu/blob/main/LICENSE)
 - [Report a Bug](https://github.com/finger-gun/sisu/issues/new?template=bug_report.md)
 - [Request a Feature](https://github.com/finger-gun/sisu/issues/new?template=feature_request.md)
+
+---
+
+## Documentation
+
+**Core** — [Package docs](packages/core/README.md) · [Error types](packages/core/ERROR_TYPES.md)
+
+**Adapters** — [OpenAI](packages/adapters/openai/README.md) · [Anthropic](packages/adapters/anthropic/README.md) · [Ollama](packages/adapters/ollama/README.md)
+
+<details>
+<summary>All middleware packages</summary>
+
+- [@sisu-ai/mw-agent-run-api](packages/middleware/agent-run-api/README.md)
+- [@sisu-ai/mw-context-compressor](packages/middleware/context-compressor/README.md)
+- [@sisu-ai/mw-control-flow](packages/middleware/control-flow/README.md)
+- [@sisu-ai/mw-conversation-buffer](packages/middleware/conversation-buffer/README.md)
+- [@sisu-ai/mw-cors](packages/middleware/cors/README.md)
+- [@sisu-ai/mw-error-boundary](packages/middleware/error-boundary/README.md)
+- [@sisu-ai/mw-guardrails](packages/middleware/guardrails/README.md)
+- [@sisu-ai/mw-invariants](packages/middleware/invariants/README.md)
+- [@sisu-ai/mw-orchestration](packages/middleware/orchestration/README.md)
+- [@sisu-ai/mw-rag](packages/middleware/rag/README.md)
+- [@sisu-ai/mw-react-parser](packages/middleware/react-parser/README.md)
+- [@sisu-ai/mw-register-tools](packages/middleware/register-tools/README.md)
+- [@sisu-ai/mw-tool-calling](packages/middleware/tool-calling/README.md)
+- [@sisu-ai/mw-trace-viewer](packages/middleware/trace-viewer/README.md)
+- [@sisu-ai/mw-usage-tracker](packages/middleware/usage-tracker/README.md)
+</details>
+
+<details>
+<summary>All tool packages</summary>
+
+- [@sisu-ai/tool-aws-s3](packages/tools/aws-s3/README.md)
+- [@sisu-ai/tool-azure-blob](packages/tools/azure-blob/README.md)
+- [@sisu-ai/tool-extract-urls](packages/tools/extract-urls/README.md)
+- [@sisu-ai/tool-github-projects](packages/tools/github-projects/README.md)
+- [@sisu-ai/tool-summarize-text](packages/tools/summarize-text/README.md)
+- [@sisu-ai/tool-terminal](packages/tools/terminal/README.md)
+- [@sisu-ai/tool-vec-chroma](packages/tools/vec-chroma/README.md)
+- [@sisu-ai/tool-web-fetch](packages/tools/web-fetch/README.md)
+- [@sisu-ai/tool-web-search-duckduckgo](packages/tools/web-search-duckduckgo/README.md)
+- [@sisu-ai/tool-web-search-google](packages/tools/web-search-google/README.md)
+- [@sisu-ai/tool-web-search-openai](packages/tools/web-search-openai/README.md)
+- [@sisu-ai/tool-wikipedia](packages/tools/wikipedia/README.md)
+</details>
+
+<details>
+<summary>All examples</summary>
+
+**Anthropic** — [hello](examples/anthropic-hello/README.md) · [control-flow](examples/anthropic-control-flow/README.md) · [stream](examples/anthropic-stream/README.md) · [weather](examples/anthropic-weather/README.md)
+
+**Ollama** — [hello](examples/ollama-hello/README.md) · [stream](examples/ollama-stream/README.md) · [vision](examples/ollama-vision/README.md) · [weather](examples/ollama-weather/README.md) · [web-search](examples/ollama-web-search/README.md)
+
+**OpenAI** — [hello](examples/openai-hello/README.md) · [weather](examples/openai-weather/README.md) · [stream](examples/openai-stream/README.md) · [vision](examples/openai-vision/README.md) · [reasoning](examples/openai-reasoning/README.md) · [react](examples/openai-react/README.md) · [control-flow](examples/openai-control-flow/README.md) · [branch](examples/openai-branch/README.md) · [parallel](examples/openai-parallel/README.md) · [graph](examples/openai-graph/README.md) · [orchestration](examples/openai-orchestration/README.md) · [orchestration-adaptive](examples/openai-orchestration-adaptive/README.md) · [guardrails](examples/openai-guardrails/README.md) · [error-handling](examples/openai-error-handling/README.md) · [rag-chroma](examples/openai-rag-chroma/README.md) · [web-search](examples/openai-web-search/README.md) · [web-fetch](examples/openai-web-fetch/README.md) · [wikipedia](examples/openai-wikipedia/README.md) · [terminal](examples/openai-terminal/README.md) · [github-projects](examples/openai-github-projects/README.md) · [server](examples/openai-server/README.md) · [aws-s3](examples/openai-aws-s3/README.md) · [azure-blob](examples/openai-azure-blob/README.md)
+</details>
+
+---
+
+## Contributing
+
+We build Sisu in the open. Contributions welcome.
+
+[Contributing Guide](CONTRIBUTING.md) · [Report a Bug](https://github.com/finger-gun/sisu/issues/new?template=bug_report.md) · [Request a Feature](https://github.com/finger-gun/sisu/issues/new?template=feature_request.md) · [Code of Conduct](CODE_OF_CONDUCT.md)
+
+---
+
+<div align="center">
+
+**[Star on GitHub](https://github.com/finger-gun/sisu)** if Sisu helps you build better agents.
+
+*Quiet, determined, relentlessly useful.*
+
+[Apache 2.0 License](LICENSE)
+
+</div>

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import type { Tool } from '@sisu-ai/core';
-export type TargetLength = 'short' | 'medium' | 'long';
+import type { Tool } from "@sisu-ai/core";
+export type TargetLength = "short" | "medium" | "long";
 export interface SummarizeArgs {
     text: string;
     target?: TargetLength;

package/dist/index.js

@@ -1,16 +1,16 @@
-import { z } from 'zod';
+import { z } from "zod";
 export const summarizeText = {
-    name: 'summarizeText',
-    description: 'Summarize a block of text using the current model. Useful for condensing large webFetch outputs while keeping key facts and URLs.',
+    name: "summarizeText",
+    description: "Summarize a block of text using the current model. Useful for condensing large webFetch outputs while keeping key facts and URLs.",
     schema: z.object({
         text: z.string().min(1),
-        target: z.enum(['short', 'medium', 'long']).optional(),
+        target: z.enum(["short", "medium", "long"]).optional(),
         maxChars: z.number().int().positive().max(50_000).optional(),
         bullets: z.boolean().optional(),
         includeCitations: z.boolean().optional(),
         focus: z.string().optional(),
     }),
-    handler: async ({ text, target = 'medium', maxChars, bullets, includeCitations, focus }, ctx) => {
+    handler: async ({ text, target = "medium", maxChars, bullets, includeCitations, focus }, ctx) => {
         const cap = Math.min(Math.max(Number(maxChars ?? 2000), 200), 50_000);
         const chunks = chunkText(text, 10_000);
         const chunkSummaries = [];
@@ -18,36 +18,46 @@ export const summarizeText = {
             // Allocate characters per chunk, allowing a buffer of 200, but not exceeding the cap
             const charsPerChunk = Math.min(Math.floor(cap / Math.max(chunks.length, 1)) + 200, cap);
             const prompt = buildPrompt(ch, target, charsPerChunk, bullets, includeCitations, focus, `Part ${i + 1}/${chunks.length}`);
-            const res = await ctx.model.generate(prompt, { toolChoice: 'none', signal: ctx.signal });
-            const s = String(res?.message?.content ?? '').trim();
+            const res = (await ctx.model.generate(prompt, {
+                toolChoice: "none",
+                signal: ctx.signal,
+            }));
+            const s = String(res?.message?.content ?? "").trim();
             if (s)
                 chunkSummaries.push(s.slice(0, cap));
         }
-        const combinedInput = chunkSummaries.join('\n\n');
-        const finalPrompt = buildPrompt(combinedInput || text, target, cap, bullets, includeCitations, focus, 'Final Synthesis');
-        const res = await ctx.model.generate(finalPrompt, { toolChoice: 'none', signal: ctx.signal });
-        const summary = String(res?.message?.content ?? '').slice(0, cap);
+        const combinedInput = chunkSummaries.join("\n\n");
+        const finalPrompt = buildPrompt(combinedInput || text, target, cap, bullets, includeCitations, focus, "Final Synthesis");
+        const res = (await ctx.model.generate(finalPrompt, {
+            toolChoice: "none",
+            signal: ctx.signal,
+        }));
+        const summary = String(res?.message?.content ?? "").slice(0, cap);
         const urls = includeCitations ? extractUrls([summary]) : undefined;
         return { summary, ...(urls && urls.length ? { urls } : {}) };
-    }
+    },
 };
 export default summarizeText;
 function buildPrompt(text, target, maxChars, bullets, includeCitations, focus, label) {
     const aims = [];
     aims.push(`Keep under ${maxChars} characters.`);
     if (bullets)
-        aims.push('Prefer concise bullet points.');
+        aims.push("Prefer concise bullet points.");
     if (includeCitations)
-        aims.push('Preserve any URLs as citations when relevant.');
+        aims.push("Preserve any URLs as citations when relevant.");
     if (focus)
         aims.push(`Emphasize: ${focus}`);
-    const density = target === 'short' ? 'High compression' : target === 'long' ? 'Low compression' : 'Balanced compression';
+    const density = target === "short"
+        ? "High compression"
+        : target === "long"
+            ? "Low compression"
+            : "Balanced compression";
     const sys = `You are a careful summarizer. ${density}. Do not invent facts. If URLs are present, keep them.`;
-    const usr = `${label ? `[${label}] ` : ''}Summarize the following text.\n\n${text}`;
-    const guide = aims.length ? `Guidelines: ${aims.join(' ')}\n` : '';
+    const usr = `${label ? `[${label}] ` : ""}Summarize the following text.\n\n${text}`;
+    const guide = aims.length ? `Guidelines: ${aims.join(" ")}\n` : "";
     return [
-        { role: 'system', content: sys },
-        { role: 'user', content: `${guide}${usr}` }
+        { role: "system", content: sys },
+        { role: "user", content: `${guide}${usr}` },
     ];
 }
 function chunkText(s, size = 10_000) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisu-ai/tool-summarize-text",
-  "version": "9.0.1",
+  "version": "9.0.3",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
     "zod": "^3.23.8"
   },
   "peerDependencies": {
-    "@sisu-ai/core": "^2.3.1"
+    "@sisu-ai/core": "^2.3.2"
   },
   "repository": {
     "type": "git",