toolgz 0.2.7 → 0.2.8

package/README.md

@@ -346,6 +346,31 @@ style in 0.2.0.
 
 ---
 
+## Runnable examples
+
+Five files in [`examples/`](examples), all offline — no API key, no cost. Every one is
+**executed by the test suite**, so an example that stops working is a failing test rather
+than a bug report from you.
+
+```bash
+npx tsx examples/01-minimal.ts
+```
+
+| File | Shows |
+|---|---|
+| [`01-minimal.ts`](examples/01-minimal.ts) | the smallest useful thing: `recommendLevel` → `compress` → `resolve` |
+| [`02-agent-loop.ts`](examples/02-agent-loop.ts) | the full loop against a scripted model, covering all three `resolve()` outcomes including a recovery |
+| [`03-mcp-servers.ts`](examples/03-mcp-servers.ts) | 149 real tools from 14 MCP servers, all four levels, and the name-collision hazard |
+| [`04-providers.ts`](examples/04-providers.ts) | the four provider envelopes side by side, plus the Gemini schema repairs |
+| [`05-per-model.ts`](examples/05-per-model.ts) | `model`/`objective` selection and reading `stats` to see what was actually used |
+
+Two things `04-providers.ts` demonstrates rather than describes, because both have bitten
+people: `/v1/responses` needs the **flat** tool shape when you set reasoning effort, and
+Gemini returns **one** wrapper object containing all declarations, so you count
+`tools[0].functionDeclarations.length`.
+
+---
+
 ## Using it: the full guide
 
 Everything below was a separate `docs/GUIDE.md`. It is inline now, deliberately: the
@@ -767,8 +792,7 @@ console.log(c.stats);
 //   originalChars: 61461, compressedChars: 2211, savedPct: 96.4 }
 ```
 
-`savedPct` estimates the token saving (calibrated against `count_tokens`, ~1–2pp
-accurate). `originalChars` and `compressedChars` give the raw character counts.
+`savedPct` is a character saving, a few points optimistic against tokens. `originalChars` and `compressedChars` give the raw character counts.
 
 **I need the real token numbers.**
 Count them with the provider's own endpoint. Never use `tiktoken` for Claude —
@@ -842,16 +866,21 @@ Returns:
 | `codeFor(name)` | `→ string` | real name → level-3 code; throws below level 3 |
 | `stats` | `CompressStats` | `level`, `mapStyle`, `requestedMapStyle`, `fallbackReason`, `toolCount`, `wireToolCount`, `originalChars`, `compressedChars`, `savedPct` |
 
-> **`savedPct` estimates tokens, and is accurate to a point or two.** It used to be a raw
-> character ratio, which overstated by 7.6 points at level 1. Characters per token differs
-> between the two sides — uncompressed JSON is punctuation-dense, a signature line reads
-> more like prose — so it now divides each side by a ratio calibrated against
-> `count_tokens` on two unrelated corpora. Current error on the real corpus: **+1.5pp at
-> level 1, −0.3pp at level 2, +0.1pp at level 3.**
+> **`savedPct` is a character saving, and runs a few points optimistic against tokens.**
+> On the real 149-tool corpus it reports 46.8% at level 1 where `count_tokens` measures
+> 39.2%, and 96.6% at level 3 against 95.6%.
+>
+> We tried making it a token estimate in 0.2.7 and reverted it in 0.2.8. Providers charge a
+> fixed framing cost per tool definition that character counting cannot see: at 149 tools
+> it amortises away, at 2 tools it dominates, and the calibrated estimate was off by 44% on
+> a small level-1 block while being within 1% at scale. The plain character ratio is the
+> smaller and more predictable error.
+>
+> Use it as a local signal. For anything you publish, measure with your provider's token
+> counter. `originalChars` and `compressedChars` are on `stats` for the raw counts.
 >
-> It is still a local estimate with no API call. For a figure you publish, measure with
-> your provider's token counter; `originalChars` and `compressedChars` are also on `stats`
-> if you want the raw counts.
+> A negative value is possible and correct: on a very small tool set, level 1's signature
+> line can exceed the per-property descriptions it strips.
 | `encodeCallForTest(name, args)` | `→ {name, args}` | build the raw call a model would emit; test aid |
 
 ### `recommendLevel(tools, namespaceOf?) → Recommendation`
@@ -960,7 +989,7 @@ and it does not get deleted.
 ## Development
 
 ```bash
-npm test        # 277 tests, offline, no cost
+npm test        # 283 tests, offline, no cost
 npm run build   # tsc → dist/ with .d.ts
 
 npx tsx bench/harness/run-multi.ts --provider=all --reps=3 --variants   # costs money

package/dist/index.js

@@ -160,27 +160,19 @@ export function compress(input, options = {}) {
     };
     const finish = (wire, systemPreamble, cachePreamble, resolve, encode) => {
         const compressedChars = countSchemaTokensApprox(wire) + systemPreamble.length;
-        // `savedPct` is meant to answer "how much of my tool block did I get back", which is
-        // a TOKEN question. Deriving it from a raw character ratio answered a different one
-        // and overstated: on the real corpus it reported 46.8% at level 1 where count_tokens
-        // measures 39.2% — 7.6 points high, and the field was documented as "do not publish
-        // this" rather than fixed.
+        // `savedPct` is a CHARACTER saving, deliberately.
         //
-        // Characters per token is not constant across the two sides. Uncompressed JSON is
-        // punctuation-dense; a signature line or a map row reads more like prose. Measured
-        // against count_tokens on two unrelated corpora (149 real MCP tools and a 100-tool
-        // synthetic fixture) the ratios are stable per level:
+        // 0.2.7 tried to make it a token estimate by dividing each side by a chars-per-token
+        // ratio calibrated against count_tokens. That was a mistake, and measurement caught
+        // it: providers charge a fixed framing cost per tool definition that character
+        // counting cannot see. At 149 tools it amortises away, at 2 tools it dominates — the
+        // ratio approach was off by 44% on a 2-tool level-1 block while being within 1% at
+        // 149. No local character-based calculation can span that range.
         //
-        //   uncompressed  2.39 / 2.45      level 2  2.20 / 1.99
-        //   level 1       2.15 / 2.19      level 3  1.92 / 1.91
-        //
-        // Dividing by these brings the error to ~1.5 points at level 1 and ~0.1 at level 3.
-        // Still an estimate — it is a local calculation with no API call — but now an
-        // estimate of the right quantity.
-        const CHARS_PER_TOKEN = { 0: 2.42, 1: 2.17, 2: 2.1, 3: 1.92 };
-        const estTokens = (chars, at) => chars / CHARS_PER_TOKEN[at];
-        const originalTokens = estTokens(originalChars, 0);
-        const compressedTokens = estTokens(compressedChars, level);
+        // The plain character ratio is the smaller and more predictable error: it runs a few
+        // points optimistic (−7.7% chars against −4.9% real tokens on a 2-tool set; 46.8%
+        // against 39.2% on 149 real tools). So it is reported as what it is, and the docs say
+        // to measure with your provider's counter for anything you publish.
         return {
             tools: wire,
             systemPreamble,
@@ -204,7 +196,7 @@ export function compress(input, options = {}) {
                 compressedChars,
                 savedPct: originalChars === 0
                     ? 0
-                    : Math.round((1 - compressedTokens / originalTokens) * 1000) / 10,
+                    : Math.round((1 - compressedChars / originalChars) * 1000) / 10,
             },
         };
     };

package/dist/recommend.js

@@ -57,7 +57,11 @@ export function recommendLevel(tools, namespaceOf = defaultNamespaceOf) {
     // provider's own schema enforcement, which levels 2-3 give up. That is worth more
     // than a saving you would not notice — hence an absolute threshold on the block,
     // not a shape test.
-    const THRESHOLD_TOKENS = 4000;
+    // 10,000 tokens is ~5% of a 200k window. Below that, reclaiming the block does not
+    // change what fits, and level 1 keeps the provider's own argument validation — worth
+    // more than a saving you would not notice. An external reviewer flagged the earlier
+    // 4,000 threshold for pushing 14-tool sets into dispatcher mode; they were right.
+    const THRESHOLD_TOKENS = 10000;
     if (l1Tokens < THRESHOLD_TOKENS) {
         return {
             ...base,
@@ -68,6 +72,6 @@ export function recommendLevel(tools, namespaceOf = defaultNamespaceOf) {
     return {
         ...base,
         level: 3,
-        reason: `${toolCount} tools take ~${l1Tokens.toLocaleString()} tokens at level 1; level 3 replaces them with two dispatcher tools plus a cached map. Measured on 149 real MCP tools: 41,648 tokens at level 1 against 2,980 at level 3, and 60/60 tasks completed across four frontier providers with zero hallucinated names. The cost is roughly 0.3-1.7 lookup calls per task — so about half an extra turn — plus the loss of provider-side argument checking — keep \`validate\` on, which is what catches malformed arguments instead. If latency matters more than context, stay at level 1.`,
+        reason: `${toolCount} tools take ~${l1Tokens.toLocaleString()} tokens at level 1; level 3 replaces them with two dispatcher tools plus a cached map. Measured on 149 real MCP tools: 41,648 tokens at level 1 against 2,980 at level 3, and 60/60 tasks completed across four frontier providers with zero hallucinated names. The cost is roughly 0.3-1.7 lookup calls per task — so about half an extra turn — plus the loss of provider-side argument checking. Keep \`validate\` on; it is what catches malformed arguments instead. If latency matters more than context, stay at level 1.`,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toolgz",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Compress LLM tool definitions to reclaim context window. Measured across Anthropic, OpenAI, Google and xAI.",
   "main": "dist/index.js",
   "scripts": {