opencode-zen-freex 0.2.1 → 0.2.3

package/provider.mjs

@@ -1,461 +1,509 @@
-import { createHash, randomBytes } from "node:crypto";
-import { PROFILES, agentFor, generationOf } from "./core-tools.mjs";
-import {
-  PROVIDER,
-  SDK,
-  bootstrapProvider,
-  buildModels,
-  configModels,
-  parseProtocolDocs,
-} from "./models.mjs";
-import { collapseResponse } from "./stream.mjs";
-import { guardToolResponse } from "./tool-response.mjs";
-
-// Zen moved behind opencode.ai/inference; everything under /zen/ answers 403
-// FreeTierError now, however the request is made.
-const DEFAULT_BASE = "https://opencode.ai/inference/v1";
-const CATALOG = "https://models.opencode.ai/api.json";
-const DOCS =
-  "https://raw.githubusercontent.com/anomalyco/opencode/dev/services/www/src/docs/content/console/models.mdx";
-const PATHS = { chat: "/chat/completions", responses: "/responses", anthropic: "/messages" };
-// Which generation to present when the host says nothing that tells us: the
-// one opencode-ai publishes as latest.
-const DEFAULT_GENERATION = "1.x";
-// Said only of a tool this plugin added, which the agent has no such tool for.
-// It has to be phrased as being about that one tool: a blanket "these tools are
-// not available" was measured to stop the model using the host's own tools too.
-const PLACEHOLDER =
-  "This one is a placeholder that satisfies OpenCode Zen's request and is not " +
-  "connected to anything: do not call it, and use the other tools you have.";
-
-// Zen answers a request only when the whole of it belongs to one generation of
-// OpenCode: its User-Agent, its headers and its tools have to agree. So the
-// User-Agent is not a constant here. A host that is OpenCode itself already
-// says which one it is, and that answer is above whatever floor Zen is holding,
-// so it is passed through; otherwise the generation is taken from the tools
-// the request actually carries, which is what the gate compares anyway.
-const RELEASE = /^opencode\/(?:latest|stable|beta)\/\d[^/]*\/[^/]+$/;
-
-function agentForRequest(protocol, tools, given) {
-  const said = given?.get("user-agent");
-  if (said && RELEASE.test(said)) return said;
-  return agentFor(generationOf(tools) ?? DEFAULT_GENERATION, protocol);
-}
-// How long a request for a model the last list didn't have waits before it
-// asks Zen's list again: a model Zen made free since is served at once,
-// and a model typed in by hand doesn't ask the list on every request.
-const RELIST_AFTER = 60_000;
-
-function httpURL(value) {
-  const url = new URL(value);
-  if (
-    !["http:", "https:"].includes(url.protocol) ||
-    url.username ||
-    url.password ||
-    url.search ||
-    url.hash
-  ) {
-    throw new Error("Expected an HTTP(S) URL without credentials, query or fragment");
-  }
-  return url.href.replace(/\/+$/, "");
-}
-
-function requirePublic(auth) {
-  if (auth?.type !== "api" || auth.key !== "public") {
-    throw new Error(
-      "OpenCode Zen Free uses the public credential. Enable its free access login method.",
-    );
-  }
-}
-
-async function readRemote(url, json, headers, callerSignal) {
-  const timeout = AbortSignal.timeout(15000);
-  const signal = callerSignal ? AbortSignal.any([callerSignal, timeout]) : timeout;
-  const response = await fetch(url, { headers, signal });
-  if (!response.ok) {
-    await response.body?.cancel();
-    throw new Error(`Model discovery returned HTTP ${response.status}`);
-  }
-  return json ? response.json() : response.text();
-}
-
-function normalizeTools(body, protocol) {
-  if (body.tools !== undefined && !Array.isArray(body.tools)) {
-    throw new Error("tools must be an array");
-  }
-  body.tools ??= [];
-  // A name is read out of whichever shape it arrived in. The protocol decides
-  // what is sent, but a host that sent the other shape's tools still declared
-  // them, and taking the name from one shape only would fill a gap that is not
-  // one and send the same tool twice.
-  const nameOf = (tool) => tool?.function?.name ?? tool?.name;
-  const present = new Set(body.tools.map(nameOf));
-  const declared = new Set([...present].filter((value) => typeof value === "string"));
-  if (protocol === "chat" && Array.isArray(body.functions)) {
-    for (const tool of body.functions) if (typeof tool?.name === "string") declared.add(tool.name);
-  }
-  // Zen takes a request for one generation of OpenCode or the other, and the tools
-  // it carries say which: `shell` is 2.x, `bash` is 1.x. Names move far less
-  // often than descriptions do, so this survives a rewording that a pinned
-  // User-Agent would not.
-  // Zen takes a request for one generation of OpenCode or the other, and the tools
-  // it carries say which: `shell` is 2.x, `bash` is 1.x. Names move far less
-  // often than descriptions do, so this survives a rewording that a pinned
-  // User-Agent would not.
-  const generation = generationOf(body.tools) ?? DEFAULT_GENERATION;
-  const profile = PROFILES[generation];
-  const filled = [];
-  const at = new Map();
-  body.tools.forEach((tool, index) => {
-    const name = nameOf(tool);
-    if (name && !at.has(name)) at.set(name, index);
-  });
-  for (const [name, spoken] of Object.entries(profile.tools)) {
-    const index = at.get(name);
-    if (index !== undefined) {
-      // The host's own tool, kept whole so that it still runs and the reply's
-      // call still finds it. Only the wording is replaced: Zen reads the
-      // wording of a tool it knows by name, and a host that is not OpenCode
-      // describes its tools in its own words. The host's parameters are left
-      // as they are, since Zen does not read those and the call the model
-      // makes has to fit the tool that will run it.
-      setDescription(body.tools[index], spoken.description);
-      continue;
-    }
-    // The names Zen insists on are added; the rest are read by it when present
-    // and mean nothing when they are not.
-    if (!profile.required.includes(name)) continue;
-    filled.push(name);
-    // A tool added here has nothing behind it: the agent has no such tool and
-    // a call to it is dropped. Describing it as OpenCode describes it is what
-    // Zen asks for, and it also makes the model want to call it, so the note
-    // goes after the opening Zen reads and before the closing it does not.
-    body.tools.push(shapeOf({ ...spoken, description: `${spoken.description}\n\n${PLACEHOLDER}` }, protocol));
-  }
-  return { declared, filled, generation };
-}
-
-// The description sits inside `function` on the chat shape and beside the name
-// on the other two, and which one a host used is its own business: it is
-// matched by where the name was found, so a tool sent in the other shape still
-// has its wording read and replaced.
-function descriptionAt(tool) {
-  return tool?.function ? tool.function.description : tool?.description;
-}
-
-function setDescription(tool, description) {
-  if (tool?.function) tool.function.description = description;
-  else if (tool) tool.description = description;
-}
-
-const shapeOf = (definition, protocol) =>
-  protocol === "chat"
-    ? { type: "function", function: definition }
-    : protocol === "anthropic"
-      ? { name: definition.name, description: definition.description, input_schema: definition.parameters }
-      : { type: "function", ...definition };
-
-// Zen's own wording for a refusal says only that the request did not look like
-// OpenCode's, which sends people off to change headers. Everything the plugin
-// sends apart from the tool wording is what Zen expects — the endpoint, the
-// shape of the User-Agent, both session headers — so a refusal this far in is
-// about the wording, and this says so, and says which wording went out.
-async function explain(response, toolPolicy) {
-  if (response.status !== 403 && response.status !== 426) return response;
-  const text = await response.text().catch(() => "");
-  // A 403 that is not Zen's free tier is somebody else's; it is left as sent.
-  if (response.status === 403 && !text.includes("FreeTierError"))
-    return new Response(text, response);
-  const profile = PROFILES[toolPolicy.generation];
-  const names = Object.keys(profile.tools).join(", ");
-  const { filled } = toolPolicy;
-  // 426 is not a refusal of the wording: it is this plugin presenting itself as
-  // an OpenCode older than Zen accepts, which only a newer copy of it answers.
-  const message =
-    response.status === 426
-      ? `OpenCode Zen answered 426 Upgrade Required: this plugin presents itself as OpenCode ${profile.agent.opencode} and Zen now wants a newer one. Update the plugin, or run inside a newer OpenCode.`
-      : [
-          "OpenCode Zen's free tier refused this request as not coming from OpenCode.",
-          `Zen reads the wording of ${names} from the request body, not only its headers, and wants OpenCode's own. The wording sent was this package's, for OpenCode ${profile.agent.opencode}.`,
-          filled.length
-            ? `The host declares none of ${filled.join(", ")}, so those were added from it.`
-            : `The host declared every one of them; only the wording was replaced, and its own parameters were kept so its tools still run.`,
-          "OpenCode rewords those tools between releases. Run `bun run check:gate` to see whether that copy is still current; if it is not, capture the wording again from a current OpenCode and update this package.",
-        ].join(" ");
-  return new Response(
-    JSON.stringify({
-      type: "error",
-      error: { type: response.status === 426 ? "upgrade_required" : "FreeTierError", message },
-    }),
-    { status: response.status, statusText: response.statusText, headers: response.headers },
-  );
-}
-
-const ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
-let lastStamp = 0;
-let counter = 0;
-
-// An id the way OpenCode makes one (packages/schema/src/identifier.ts):
-// 12 hex of Date.now() * 0x1000 + a per-millisecond counter (bit-inverted
-// for a session, so newer sorts first), then 14 random base62 characters.
-// Zen's free tier checks a session id has this shape, a small counter
-// included, and answers 403 FreeTierError to one that doesn't (#100).
-export function opencodeID(prefix, descending, now = Date.now()) {
-  if (now !== lastStamp) {
-    lastStamp = now;
-    counter = 0;
-  }
-  counter++;
-  const current = BigInt(now) * 0x1000n + BigInt(counter);
-  const value = (descending ? ~current : current) & 0xffffffffffffn;
-  const random = randomBytes(14);
-  let tail = "";
-  for (const byte of random) tail += ALPHABET[byte % 62];
-  return `${prefix}_${value.toString(16).padStart(12, "0")}${tail}`;
-}
-
-// A session id OpenCode itself could have made: its counter (the low 12
-// bits, inverted) is small. A hash cut to the same shape isn't one.
-export function realSessionID(value) {
-  const match = /^ses_[0-9a-f]{9}([0-9a-f]{3})[0-9A-Za-z]{14}$/.exec(value ?? "");
-  return !!match && 0xfff - Number.parseInt(match[1], 16) < 16;
-}
-
-// One made-up session per conversation, so its turns keep one session.
-const SESSIONS = new Map();
-const KEEP_SESSIONS = 1000;
-
-export function sessionID(headers, body) {
-  let signal;
-  for (const name of [
-    "x-opencode-session",
-    "x-opencode-session-id",
-    "x-session-affinity",
-    "x-session-id",
-    "conversation-id",
-  ]) {
-    if (headers.get(name)) {
-      signal = headers.get(name);
-      break;
-    }
-  }
-  if (!signal && typeof body.metadata?.session_id === "string") signal = body.metadata.session_id;
-  if (realSessionID(signal)) return signal;
-  if (!signal) {
-    const messages = body.messages ?? body.input;
-    const first = Array.isArray(messages)
-      ? messages.find((message) => message.role === "user")?.content
-      : messages;
-    if (!first) return opencodeID("ses", true);
-    signal = JSON.stringify(first);
-  }
-  const key = createHash("sha256").update(`ses\0${signal}`).digest("hex");
-  let session = SESSIONS.get(key);
-  if (session) {
-    SESSIONS.delete(key);
-  } else {
-    session = opencodeID("ses", true);
-    if (SESSIONS.size >= KEEP_SESSIONS) SESSIONS.delete(SESSIONS.keys().next().value);
-  }
-  SESSIONS.set(key, session);
-  return session;
-}
-
-async function server(_input, options = {}) {
-  const baseURL = httpURL(options.baseURL ?? DEFAULT_BASE);
-  const catalogURL = httpURL(options.catalogURL ?? CATALOG);
-  const docsURL = httpURL(options.docsURL ?? DOCS);
-  let known = buildModels(Object.keys(bootstrapProvider.models), bootstrapProvider, {}, baseURL);
-  let metadata = bootstrapProvider;
-  let protocols = {};
-  let listed = false;
-  let listedAt = 0;
-
-  async function discover(signal) {
-    const headers = { authorization: "Bearer public", "x-opencode-client": "cli" };
-    const [listing, catalog, docs] = await Promise.allSettled([
-      readRemote(`${baseURL}/models`, true, headers, signal),
-      readRemote(catalogURL, true, undefined, signal),
-      readRemote(docsURL, false, undefined, signal),
-    ]);
-    signal?.throwIfAborted();
-    let partial = false;
-    if (catalog.status === "fulfilled" && catalog.value?.opencode?.models) {
-      metadata = catalog.value.opencode;
-    } else {
-      partial = true;
-    }
-    if (docs.status === "fulfilled" && Object.keys(parseProtocolDocs(docs.value)).length) {
-      protocols = parseProtocolDocs(docs.value);
-    } else {
-      partial = true;
-    }
-    if (listing.status !== "fulfilled" || !Array.isArray(listing.value?.data)) {
-      const fallback = { ...known };
-      fallback[Symbol.for("magpie.fellBack")] = true;
-      return fallback;
-    }
-    const ids = listing.value.data.map((item) => item.id);
-    const discovered = buildModels(ids, metadata, protocols, baseURL);
-    if (partial) {
-      // Preserve previously verified models only while they remain in the live catalog.
-      for (const id of ids) {
-        if (!discovered[id] && !metadata.models?.[id] && !protocols[id] && known[id]) {
-          discovered[id] = known[id];
-        }
-      }
-      discovered[Symbol.for("magpie.fellBack")] = true;
-    }
-    known = discovered;
-    listed = true;
-    listedAt = Date.now();
-    return discovered;
-  }
-
-  return {
-    async config(cfg) {
-      cfg.provider ??= {};
-      cfg.provider[PROVIDER] ??= {
-        name: "OpenCode Zen Free",
-        npm: SDK.chat,
-        api: baseURL,
-        models: configModels(known),
-      };
-    },
-    auth: {
-      provider: PROVIDER,
-      icon: "https://opencode.ai/favicon-v3.ico",
-      maxConcurrency: 2,
-      methods: [
-        {
-          type: "api",
-          label: "Zen 免费访问（密钥填写 public）",
-          placeholder: "public",
-          async authorize() {
-            return { type: "success", key: "public" };
-          },
-        },
-      ],
-      async loader(getAuth) {
-        const auth = await getAuth();
-        if (!auth) return {};
-        requirePublic(auth);
-        return {
-          baseURL,
-          apiKey: "public",
-          async fetch(input, init) {
-            requirePublic(await getAuth());
-            const request = new Request(input, init);
-            const protocol = Object.keys(PATHS).find(
-              (key) => request.url === `${baseURL}${PATHS[key]}`,
-            );
-            if (!protocol || request.method !== "POST")
-              throw new Error("Unsupported Zen endpoint or method");
-            request.signal.throwIfAborted();
-            const body = await request.json();
-            if (!body || typeof body !== "object" || Array.isArray(body))
-              throw new Error("Expected a JSON request object");
-            if (
-              !Object.hasOwn(known, body.model) &&
-              (!listed || Date.now() - listedAt >= RELIST_AFTER)
-            ) {
-              await discover(request.signal);
-            }
-            const model = Object.hasOwn(known, body.model) ? known[body.model] : undefined;
-            if (!model) {
-              // Zen no longer gives it free, or never did: said as a model
-              // not served, so the caller sets this model aside and not the
-              // account, whose other free models are still served.
-              const free = Object.keys(known).sort().join(", ");
-              const name = typeof body.model === "string" ? body.model : "";
-              return new Response(
-                JSON.stringify({
-                  type: "error",
-                  error: {
-                    type: "not_found_error",
-                    message: `Model ${name} is not available as an OpenCode Zen free model now. Free models: ${free || "none"}.`,
-                  },
-                }),
-                { status: 404, headers: { "content-type": "application/json" } },
-              );
-            }
-            if (model.api.npm !== SDK[protocol]) {
-              throw new Error(
-                "Model is not an available free model for this protocol. Refresh the model list.",
-              );
-            }
-            const streaming = body.stream === true;
-            body.stream = true;
-            const toolPolicy = normalizeTools(body, protocol);
-            if (protocol === "chat")
-              body.stream_options = { ...body.stream_options, include_usage: true };
-            // The complete set of headers that leaves here, and nothing else. Zen takes a
-            // request for one generation of OpenCode or the other, and a header
-            // belonging to neither is as good as saying so: x-session-affinity
-            // and x-session-id are in OpenCode's own header set upstream
-            // (packages/core/src/session/model-request.ts) and sending them
-            // turns an answered request into 403. Adding one here is the
-            // easiest way to break this plugin, so index.test.mjs asserts the
-            // outbound set by name.
-            const given = request.headers;
-            const session = sessionID(given, body);
-            const project = _input?.project;
-            const headers = new Headers({
-              "content-type": "application/json",
-              accept: "*/*",
-              "user-agent": agentForRequest(protocol, body.tools, given),
-              "x-opencode-project":
-                given.get("x-opencode-project") ||
-                (project?.vcs === "git" && project.id ? project.id : "global"),
-              "x-opencode-session": session,
-              "x-opencode-client": "cli",
-              "x-opencode-session-id": session,
-            });
-            if (protocol === "anthropic") {
-              headers.set("x-api-key", "public");
-              headers.set("anthropic-version", given.get("anthropic-version") || "2023-06-01");
-              if (given.get("anthropic-beta")) headers.set("anthropic-beta", given.get("anthropic-beta"));
-            } else {
-              headers.set("authorization", "Bearer public");
-            }
-            const response = await fetch(request.url, {
-              method: "POST",
-              headers,
-              body: JSON.stringify(body),
-              signal: request.signal,
-              redirect: "error",
-            });
-            const guarded = await guardToolResponse(await explain(response, toolPolicy), protocol, toolPolicy, {
-              endCutShort: streaming,
-            });
-            return streaming ? guarded : collapseResponse(guarded, protocol);
-          },
-        };
-      },
-      async usage() {
-        return { plan: "OpenCode Zen Free", windows: [] };
-      },
-    },
-    provider: {
-      id: PROVIDER,
-      async models(provider, { auth } = {}) {
-        if (!auth) return provider.models;
-        requirePublic(auth);
-        return discover();
-      },
-    },
-    async "chat.headers"(input, output) {
-      if (![PROVIDER, `${PROVIDER}-plugin`].includes(input.model?.providerID) || !input.sessionID)
-        return;
-      // The pair Zen wants, both present and equal (see fetch). x-session-
-      // affinity and x-session-id are in OpenCode's own header set upstream and
-      // have been measured refused here, so they are not named: this hook is
-      // the one place where the host is asked for them, and a host that sets
-      // them would send a request that answers 403 (tkhs101#100 follow-up).
-      output.headers["x-opencode-session"] = input.sessionID;
-      output.headers["x-opencode-session-id"] = input.sessionID;
-    },
-  };
-}
-
-export default { id: PROVIDER, server };
+import { createHash, randomBytes } from "node:crypto";
+import { PROFILES, agentFor, generationOf } from "./core-tools.mjs";
+import {
+  PROVIDER,
+  SDK,
+  bootstrapProtocols,
+  bootstrapProvider,
+  buildModels,
+  configModels,
+  parseProtocolDocs,
+} from "./models.mjs";
+import { observeRouteStatement } from "./limits.mjs";
+import { collapseResponse } from "./stream.mjs";
+import { guardToolResponse } from "./tool-response.mjs";
+
+// Zen moved behind opencode.ai/inference; everything under /zen/ answers 403
+// FreeTierError now, however the request is made.
+const DEFAULT_BASE = "https://opencode.ai/inference/v1";
+const CATALOG = "https://models.opencode.ai/api.json";
+const DOCS =
+  "https://raw.githubusercontent.com/anomalyco/opencode/dev/services/www/src/docs/content/console/models.mdx";
+const PATHS = { chat: "/chat/completions", responses: "/responses", anthropic: "/messages" };
+// Which generation to present when the host says nothing that tells us: the
+// one opencode-ai publishes as latest.
+const DEFAULT_GENERATION = "1.x";
+// Said only of a tool this plugin added, which the agent has no such tool for.
+// It has to be phrased as being about that one tool: a blanket "these tools are
+// not available" was measured to stop the model using the host's own tools too.
+const PLACEHOLDER =
+  "This one is a placeholder that satisfies OpenCode Zen's request and is not " +
+  "connected to anything: do not call it, and use the other tools you have.";
+
+// Zen answers a request only when the whole of it belongs to one generation of
+// OpenCode: its User-Agent, its headers and its tools have to agree. So the
+// User-Agent is not a constant here. A host that is OpenCode itself already
+// says which one it is, and that answer is above whatever floor Zen is holding,
+// so it is passed through; otherwise the generation is taken from the tools
+// the request actually carries, which is what the gate compares anyway.
+const RELEASE = /^opencode\/(?:latest|stable|beta)\/\d[^/]*\/[^/]+$/;
+
+function agentForRequest(protocol, tools, given) {
+  const said = given?.get("user-agent");
+  if (said && RELEASE.test(said)) return said;
+  return agentFor(generationOf(tools) ?? DEFAULT_GENERATION, protocol);
+}
+
+// The complete set of headers that leaves here, and nothing else: one owner for
+// the names. tools-smoke.mjs builds the request it asks Zen with from this
+// function, so what the gate reports is about the request this plugin makes and
+// not about a copy of it. A copy drifts, and one did: the gate was missing
+// `accept`, and nothing failed on it. index.test.mjs asserts the names on the
+// wire.
+//
+// x-session-affinity, x-session-id and x-opencode-request are in OpenCode's own
+// header set upstream (packages/core/src/session/model-request.ts) and none of
+// them is needed, so none is sent. Measured on this set, 2026-10-15: each of the
+// three answers on its own, x-opencode-request with x-session-id answers, and
+// x-opencode-request with x-session-affinity is refused. It is the pair and not
+// either header, so a header cannot be judged by adding it on its own.
+export function outboundHeaders({
+  session,
+  agent,
+  protocol = "chat",
+  project = "global",
+  given,
+}) {
+  const headers = new Headers({
+    "content-type": "application/json",
+    accept: "*/*",
+    "user-agent": agent,
+    "x-opencode-project": project,
+    "x-opencode-session": session,
+    "x-opencode-client": "cli",
+    "x-opencode-session-id": session,
+  });
+  if (protocol === "anthropic") {
+    headers.set("x-api-key", "public");
+    headers.set("anthropic-version", given?.get("anthropic-version") || "2023-06-01");
+    if (given?.get("anthropic-beta")) headers.set("anthropic-beta", given.get("anthropic-beta"));
+  } else {
+    headers.set("authorization", "Bearer public");
+  }
+  return headers;
+}
+
+// How long a request for a model the last list didn't have waits before it
+// asks Zen's list again: a model Zen made free since is served at once,
+// and a model typed in by hand doesn't ask the list on every request.
+const RELIST_AFTER = 60_000;
+
+function httpURL(value) {
+  const url = new URL(value);
+  if (
+    !["http:", "https:"].includes(url.protocol) ||
+    url.username ||
+    url.password ||
+    url.search ||
+    url.hash
+  ) {
+    throw new Error("Expected an HTTP(S) URL without credentials, query or fragment");
+  }
+  return url.href.replace(/\/+$/, "");
+}
+
+function requirePublic(auth) {
+  if (auth?.type !== "api" || auth.key !== "public") {
+    throw new Error(
+      "OpenCode Zen Free uses the public credential. Enable its free access login method.",
+    );
+  }
+}
+
+async function readRemote(url, json, headers, callerSignal) {
+  const timeout = AbortSignal.timeout(15000);
+  const signal = callerSignal ? AbortSignal.any([callerSignal, timeout]) : timeout;
+  const response = await fetch(url, { headers, signal });
+  if (!response.ok) {
+    await response.body?.cancel();
+    throw new Error(`Model discovery returned HTTP ${response.status}`);
+  }
+  return json ? response.json() : response.text();
+}
+
+function normalizeTools(body, protocol) {
+  if (body.tools !== undefined && !Array.isArray(body.tools)) {
+    throw new Error("tools must be an array");
+  }
+  body.tools ??= [];
+  // A name is read out of whichever shape it arrived in. The protocol decides
+  // what is sent, but a host that sent the other shape's tools still declared
+  // them, and taking the name from one shape only would fill a gap that is not
+  // one and send the same tool twice.
+  const nameOf = (tool) => tool?.function?.name ?? tool?.name;
+  const present = new Set(body.tools.map(nameOf));
+  const declared = new Set([...present].filter((value) => typeof value === "string"));
+  if (protocol === "chat" && Array.isArray(body.functions)) {
+    for (const tool of body.functions) if (typeof tool?.name === "string") declared.add(tool.name);
+  }
+  // Zen takes a request for one generation of OpenCode or the other, and the tools
+  // it carries say which: `shell` is 2.x, `bash` is 1.x. Names move far less
+  // often than descriptions do, so this survives a rewording that a pinned
+  // User-Agent would not.
+  // Zen takes a request for one generation of OpenCode or the other, and the tools
+  // it carries say which: `shell` is 2.x, `bash` is 1.x. Names move far less
+  // often than descriptions do, so this survives a rewording that a pinned
+  // User-Agent would not.
+  const generation = generationOf(body.tools) ?? DEFAULT_GENERATION;
+  const profile = PROFILES[generation];
+  const filled = [];
+  const at = new Map();
+  body.tools.forEach((tool, index) => {
+    const name = nameOf(tool);
+    if (name && !at.has(name)) at.set(name, index);
+  });
+  for (const [name, spoken] of Object.entries(profile.tools)) {
+    const index = at.get(name);
+    if (index !== undefined) {
+      // The host's own tool, kept whole so that it still runs and the reply's
+      // call still finds it. Only the wording is replaced: Zen reads the
+      // wording of a tool it knows by name, and a host that is not OpenCode
+      // describes its tools in its own words. The host's parameters are left
+      // as they are, since Zen does not read those and the call the model
+      // makes has to fit the tool that will run it.
+      setDescription(body.tools[index], spoken.description);
+      continue;
+    }
+    // The names in `required` are stood in for: a host that is not OpenCode has
+    // no tool by these names, and Zen reads a request as belonging to a
+    // generation partly by the tools it carries. `required` is deliberately
+    // wider than what Zen was measured to insist on — `read` alone was answered,
+    // and everything but `read` was refused, on 2026-10-15 — because a wider
+    // set is served, so the extra names cost a host that lacks them only the
+    // tokens of a tool it will not call, and they are the first thing a
+    // tightened check would otherwise find missing.
+    if (!profile.required.includes(name)) continue;
+    filled.push(name);
+    // A tool added here has nothing behind it: the agent has no such tool and
+    // a call to it is dropped. Describing it as OpenCode describes it is what
+    // Zen asks for, and it also makes the model want to call it, so the note
+    // goes after the opening Zen reads and before the closing it does not.
+    body.tools.push(shapeOf({ ...spoken, description: `${spoken.description}\n\n${PLACEHOLDER}` }, protocol));
+  }
+  return { declared, filled, generation };
+}
+
+// The description sits inside `function` on the chat shape and beside the name
+// on the other two, and which one a host used is its own business: it is
+// matched by where the name was found, so a tool sent in the other shape still
+// has its wording read and replaced.
+function descriptionAt(tool) {
+  return tool?.function ? tool.function.description : tool?.description;
+}
+
+function setDescription(tool, description) {
+  if (tool?.function) tool.function.description = description;
+  else if (tool) tool.description = description;
+}
+
+const shapeOf = (definition, protocol) =>
+  protocol === "chat"
+    ? { type: "function", function: definition }
+    : protocol === "anthropic"
+      ? { name: definition.name, description: definition.description, input_schema: definition.parameters }
+      : { type: "function", ...definition };
+
+// Zen's own wording for a refusal says only that the request did not look like
+// OpenCode's, which sends people off to change headers. Everything the plugin
+// sends apart from the tool wording is what Zen expects — the endpoint, the
+// shape of the User-Agent, both session headers — so a refusal this far in is
+// about the wording, and this says so, and says which wording went out.
+async function explain(response, toolPolicy) {
+  if (response.status !== 403 && response.status !== 426) return response;
+  const text = await response.text().catch(() => "");
+  // A 403 that is not Zen's free tier is somebody else's; it is left as sent.
+  if (response.status === 403 && !text.includes("FreeTierError"))
+    return new Response(text, response);
+  const profile = PROFILES[toolPolicy.generation];
+  const names = Object.keys(profile.tools).join(", ");
+  const { filled } = toolPolicy;
+  // 426 is not a refusal of the wording: it is this plugin presenting itself as
+  // an OpenCode older than Zen accepts, which only a newer copy of it answers.
+  const message =
+    response.status === 426
+      ? `OpenCode Zen answered 426 Upgrade Required: this plugin presents itself as OpenCode ${profile.agent.opencode} and Zen now wants a newer one. Update the plugin, or run inside a newer OpenCode.`
+      : [
+          "OpenCode Zen's free tier refused this request as not coming from OpenCode.",
+          `Zen reads the wording of ${names} from the request body, not only its headers, and wants OpenCode's own. The wording sent was this package's, for OpenCode ${profile.agent.opencode}.`,
+          filled.length
+            ? `The host declares none of ${filled.join(", ")}, so those were added from it.`
+            : `The host declared every one of them; only the wording was replaced, and its own parameters were kept so its tools still run.`,
+          "OpenCode rewords those tools between releases. Run `bun run check:gate` to see whether that copy is still current; if it is not, capture the wording again from a current OpenCode and update this package.",
+        ].join(" ");
+  return new Response(
+    JSON.stringify({
+      type: "error",
+      error: { type: response.status === 426 ? "upgrade_required" : "FreeTierError", message },
+    }),
+    { status: response.status, statusText: response.statusText, headers: response.headers },
+  );
+}
+
+const ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+let lastStamp = 0;
+let counter = 0;
+
+// An id the way OpenCode makes one (packages/schema/src/identifier.ts):
+// 12 hex of Date.now() * 0x1000 + a per-millisecond counter (bit-inverted
+// for a session, so newer sorts first), then 14 random base62 characters.
+// Zen's free tier checks a session id has this shape, a small counter
+// included, and answers 403 FreeTierError to one that doesn't (#100).
+export function opencodeID(prefix, descending, now = Date.now()) {
+  if (now !== lastStamp) {
+    lastStamp = now;
+    counter = 0;
+  }
+  counter++;
+  const current = BigInt(now) * 0x1000n + BigInt(counter);
+  const value = (descending ? ~current : current) & 0xffffffffffffn;
+  const random = randomBytes(14);
+  let tail = "";
+  for (const byte of random) tail += ALPHABET[byte % 62];
+  return `${prefix}_${value.toString(16).padStart(12, "0")}${tail}`;
+}
+
+// A session id OpenCode itself could have made: its counter (the low 12
+// bits, inverted) is small. A hash cut to the same shape isn't one.
+export function realSessionID(value) {
+  const match = /^ses_[0-9a-f]{9}([0-9a-f]{3})[0-9A-Za-z]{14}$/.exec(value ?? "");
+  return !!match && 0xfff - Number.parseInt(match[1], 16) < 16;
+}
+
+// One made-up session per conversation, so its turns keep one session.
+const SESSIONS = new Map();
+const KEEP_SESSIONS = 1000;
+
+export function sessionID(headers, body) {
+  let signal;
+  for (const name of [
+    "x-opencode-session",
+    "x-opencode-session-id",
+    "x-session-affinity",
+    "x-session-id",
+    "conversation-id",
+  ]) {
+    if (headers.get(name)) {
+      signal = headers.get(name);
+      break;
+    }
+  }
+  if (!signal && typeof body.metadata?.session_id === "string") signal = body.metadata.session_id;
+  if (realSessionID(signal)) return signal;
+  if (!signal) {
+    const messages = body.messages ?? body.input;
+    const first = Array.isArray(messages)
+      ? messages.find((message) => message.role === "user")?.content
+      : messages;
+    if (!first) return opencodeID("ses", true);
+    signal = JSON.stringify(first);
+  }
+  const key = createHash("sha256").update(`ses\0${signal}`).digest("hex");
+  let session = SESSIONS.get(key);
+  if (session) {
+    SESSIONS.delete(key);
+  } else {
+    session = opencodeID("ses", true);
+    if (SESSIONS.size >= KEEP_SESSIONS) SESSIONS.delete(SESSIONS.keys().next().value);
+  }
+  SESSIONS.set(key, session);
+  return session;
+}
+
+async function server(_input, options = {}) {
+  const baseURL = httpURL(options.baseURL ?? DEFAULT_BASE);
+  const catalogURL = httpURL(options.catalogURL ?? CATALOG);
+  const docsURL = httpURL(options.docsURL ?? DOCS);
+  let known = buildModels(
+    Object.keys(bootstrapProvider.models),
+    bootstrapProvider,
+    bootstrapProtocols,
+    baseURL,
+  );
+  let metadata = bootstrapProvider;
+  let protocols = { ...bootstrapProtocols };
+  let listed = false;
+  let listedAt = 0;
+
+  async function discover(signal) {
+    const headers = { authorization: "Bearer public", "x-opencode-client": "cli" };
+    const [listing, catalog, docs] = await Promise.allSettled([
+      readRemote(`${baseURL}/models`, true, headers, signal),
+      readRemote(catalogURL, true, undefined, signal),
+      readRemote(docsURL, false, undefined, signal),
+    ]);
+    signal?.throwIfAborted();
+    let partial = false;
+    if (catalog.status === "fulfilled" && catalog.value?.opencode?.models) {
+      metadata = catalog.value.opencode;
+    } else {
+      partial = true;
+    }
+    if (docs.status === "fulfilled" && Object.keys(parseProtocolDocs(docs.value)).length) {
+      // The snapshot is the floor, not a rival: the docs say what they say and
+      // the snapshot only fills what they no longer name.
+      protocols = { ...bootstrapProtocols, ...parseProtocolDocs(docs.value) };
+    } else {
+      partial = true;
+    }
+    if (listing.status !== "fulfilled" || !Array.isArray(listing.value?.data)) {
+      const fallback = { ...known };
+      fallback[Symbol.for("magpie.fellBack")] = true;
+      return fallback;
+    }
+    const ids = listing.value.data.map((item) => item.id);
+    const discovered = buildModels(ids, metadata, protocols, baseURL);
+    if (partial) {
+      // Preserve previously verified models only while they remain in the live catalog.
+      for (const id of ids) {
+        if (!discovered[id] && !metadata.models?.[id] && !protocols[id] && known[id]) {
+          discovered[id] = known[id];
+        }
+      }
+      discovered[Symbol.for("magpie.fellBack")] = true;
+    }
+    known = discovered;
+    listed = true;
+    listedAt = Date.now();
+    return discovered;
+  }
+
+  return {
+    async config(cfg) {
+      cfg.provider ??= {};
+      cfg.provider[PROVIDER] ??= {
+        name: "OpenCode Zen Free",
+        npm: SDK.chat,
+        api: baseURL,
+        models: configModels(known),
+      };
+    },
+    auth: {
+      provider: PROVIDER,
+      icon: "https://opencode.ai/favicon-v3.ico",
+      maxConcurrency: 2,
+      methods: [
+        {
+          type: "api",
+          label: "Zen 免费访问（密钥填写 public）",
+          placeholder: "public",
+          async authorize() {
+            return { type: "success", key: "public" };
+          },
+        },
+      ],
+      async loader(getAuth) {
+        const auth = await getAuth();
+        if (!auth) return {};
+        requirePublic(auth);
+        return {
+          baseURL,
+          apiKey: "public",
+          async fetch(input, init) {
+            requirePublic(await getAuth());
+            const request = new Request(input, init);
+            const protocol = Object.keys(PATHS).find(
+              (key) => request.url === `${baseURL}${PATHS[key]}`,
+            );
+            if (!protocol || request.method !== "POST")
+              throw new Error("Unsupported Zen endpoint or method");
+            request.signal.throwIfAborted();
+            const body = await request.json();
+            if (!body || typeof body !== "object" || Array.isArray(body))
+              throw new Error("Expected a JSON request object");
+            if (
+              !Object.hasOwn(known, body.model) &&
+              (!listed || Date.now() - listedAt >= RELIST_AFTER)
+            ) {
+              await discover(request.signal);
+            }
+            const model = Object.hasOwn(known, body.model) ? known[body.model] : undefined;
+            if (!model) {
+              // Zen no longer gives it free, or never did: said as a model
+              // not served, so the caller sets this model aside and not the
+              // account, whose other free models are still served.
+              const free = Object.keys(known).sort().join(", ");
+              const name = typeof body.model === "string" ? body.model : "";
+              return new Response(
+                JSON.stringify({
+                  type: "error",
+                  error: {
+                    type: "not_found_error",
+                    message: `Model ${name} is not available as an OpenCode Zen free model now. Free models: ${free || "none"}.`,
+                  },
+                }),
+                { status: 404, headers: { "content-type": "application/json" } },
+              );
+            }
+            if (model.api.npm !== SDK[protocol]) {
+              throw new Error(
+                "Model is not an available free model for this protocol. Refresh the model list.",
+              );
+            }
+            const streaming = body.stream === true;
+            body.stream = true;
+            const toolPolicy = normalizeTools(body, protocol);
+            if (protocol === "chat")
+              body.stream_options = { ...body.stream_options, include_usage: true };
+            // Adding a header here is the easiest way to break this plugin: Zen
+            // takes a request for one generation of OpenCode or the other, and a
+            // header belonging to neither is as good as saying so. The names are
+            // outboundHeaders', which is also what the gate asks Zen with.
+            const given = request.headers;
+            const session = sessionID(given, body);
+            const project = _input?.project;
+            const headers = outboundHeaders({
+              session,
+              agent: agentForRequest(protocol, body.tools, given),
+              protocol,
+              given,
+              project:
+                given.get("x-opencode-project") ||
+                (project?.vcs === "git" && project.id ? project.id : "global"),
+            });
+            const response = await fetch(request.url, {
+              method: "POST",
+              headers,
+              body: JSON.stringify(body),
+              signal: request.signal,
+              redirect: "error",
+            });
+            // A refusal is the one place this route states its own window, and
+            // it has to be read before explain() replaces the body. See
+            // limits.mjs: an under-declared window is never refused, it is just
+            // quietly never used.
+            await observeRouteStatement(body.model, response);
+            const guarded = await guardToolResponse(await explain(response, toolPolicy), protocol, toolPolicy, {
+              endCutShort: streaming,
+            });
+            return streaming ? guarded : collapseResponse(guarded, protocol);
+          },
+        };
+      },
+      async usage() {
+        return { plan: "OpenCode Zen Free", windows: [] };
+      },
+    },
+    provider: {
+      id: PROVIDER,
+      async models(provider, { auth } = {}) {
+        if (!auth) return provider.models;
+        requirePublic(auth);
+        return discover();
+      },
+    },
+    async "chat.headers"(input, output) {
+      if (![PROVIDER, `${PROVIDER}-plugin`].includes(input.model?.providerID) || !input.sessionID)
+        return;
+      // The pair Zen wants, both present and equal (see outboundHeaders). This
+      // hook is the one place where the host is asked to carry them, and it asks
+      // for these two only: x-session-affinity and x-session-id are in OpenCode's
+      // own header set upstream but are not needed, and measured 2026-10-15 two
+      // headers of that set together are refused where either one alone answers
+      // (tkhs101#100 follow-up).
+      output.headers["x-opencode-session"] = input.sessionID;
+      output.headers["x-opencode-session-id"] = input.sessionID;
+    },
+  };
+}
+
+export default { id: PROVIDER, server };