@bojackduy/opencode-system-override 0.1.0 → 0.1.1

package/README.md

@@ -77,6 +77,31 @@ RAW_SYSTEM_OVERRIDE_END_9F3A
 Select the `Raw` agent and chat — the model sees only your text as its
 system prompt. Leave the space empty for a truly empty system (pure LLM).
 
+## Custom agents (any name works)
+
+The hook never checks the agent's name — it only looks for the marker pair
+in the assembled system text. So you can give any agent its own override by
+putting the markers in its file:
+
+```md
+---
+description: Code reviewer with no default baggage
+mode: primary
+permission:
+  "*": deny
+---
+
+RAW_SYSTEM_OVERRIDE_START_9F3A
+
+You are a senior reviewer. Be terse. Flag only real bugs.
+
+RAW_SYSTEM_OVERRIDE_END_9F3A
+```
+
+Each agent carries its own text between the markers; agents without markers
+are completely untouched. The shipped `agents/Raw.md` is just a blank
+starter — copy it to `Pirate.md`, `Reviewer.md`, whatever you like.
+
 ## How it works
 
 OpenCode assembles one system array per request. The
@@ -90,6 +115,16 @@ and mutates `output.system` **in place**:
 | Text between markers | system = that text |
 | Nothing/whitespace between markers | system = `[]` (pure LLM) |
 
+A second hook, `chat.headers`, keeps OpenCode Zen free-tier models working.
+Zen only serves anonymous free models to requests carrying the opencode
+client `User-Agent`, and now also requires a stable per-conversation
+`x-opencode-session` header — without them you get `must using opencode
+for opencode free endpoint` / `429 FreeUsageLimitError`. For `opencode`
+provider requests only, the plugin injects `User-Agent: opencode/<version>`
+(when absent or not already `opencode/*`) and `x-opencode-session:
+<sessionID>`, merging in place so other plugins' headers are preserved.
+Override the UA with `OPENCODE_USER_AGENT=opencode/x.y.z` if needed.
+
 ## Dev
 
 ```sh

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@bojackduy/opencode-system-override",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Overwrite the OpenCode system prompt per agent — a raw-system hook that replaces the assembled system with the prompt between markers in your agent file.",
   "type": "module",
   "license": "AGPL-3.0-or-later",

package/src/server.test.ts

@@ -15,7 +15,7 @@ const fakeClient = {
 
 async function hooks() {
   logged.length = 0
-  const server = (pluginModule as unknown as { server: (input: unknown) => Promise<Record<string, (input: unknown, output: { system: string[] }) => Promise<void>>> }).server
+  const server = (pluginModule as unknown as { server: (input: unknown) => Promise<Record<string, (input: unknown, output: never) => Promise<void>>> }).server
   return server({ client: fakeClient } as never)
 }
 
@@ -29,6 +29,20 @@ async function transform(system: string[]) {
   return output.system
 }
 
+async function runHeaders(
+  input: { sessionID?: string; model?: { providerID: string }; provider?: { info: { id: string } } },
+  initial: Record<string, string> = {},
+) {
+  const h = await hooks()
+  const output = { headers: { ...initial } }
+  const ref = output.headers
+  await (
+    h["chat.headers"] as (input: unknown, output: { headers: Record<string, string> }) => Promise<void>
+  )(input, output as never)
+  expect(output.headers).toBe(ref)
+  return output.headers
+}
+
 describe("system-override transform", () => {
   test("leaves non-raw agents untouched (no markers)", async () => {
     const system = ["default agent prompt", "environment info"]
@@ -58,3 +72,47 @@ describe("system-override transform", () => {
     expect(logged.join("\n")).toContain("END marker missing")
   })
 })
+
+describe("chat.headers (Zen free-tier gating)", () => {
+  test("injects User-Agent + x-opencode-session for opencode provider", async () => {
+    const out = await runHeaders(
+      { sessionID: "ses_abc123", model: { providerID: "opencode" } },
+      {},
+    )
+    expect(out["User-Agent"]).toMatch(/^opencode\//)
+    expect(out["x-opencode-session"]).toBe("ses_abc123")
+  })
+
+  test("ignores non-opencode providers (no UA spoof, no session leak)", async () => {
+    const out = await runHeaders(
+      { sessionID: "ses_abc123", model: { providerID: "anthropic" } },
+      {},
+    )
+    expect(out).toEqual({})
+  })
+
+  test("never clobbers an existing opencode/* User-Agent", async () => {
+    const out = await runHeaders(
+      { sessionID: "ses_xyz", model: { providerID: "opencode" } },
+      { "User-Agent": "opencode/9.9.9" },
+    )
+    expect(out["User-Agent"]).toBe("opencode/9.9.9")
+    expect(out["x-opencode-session"]).toBe("ses_xyz")
+  })
+
+  test("repairs a non-opencode User-Agent", async () => {
+    const out = await runHeaders(
+      { sessionID: "ses_1", model: { providerID: "opencode" } },
+      { "User-Agent": "curl/8.0" },
+    )
+    expect(out["User-Agent"]).toMatch(/^opencode\//)
+  })
+
+  test("preserves an existing session header", async () => {
+    const out = await runHeaders(
+      { sessionID: "ses_new", model: { providerID: "opencode" } },
+      { "x-opencode-session": "ses_old" },
+    )
+    expect(out["x-opencode-session"]).toBe("ses_old")
+  })
+})

package/src/server.ts

@@ -24,6 +24,23 @@ const PLUGIN_ID = "opencode-system-override"
 const START = "RAW_SYSTEM_OVERRIDE_START_9F3A"
 const END = "RAW_SYSTEM_OVERRIDE_END_9F3A"
 
+// Zen free-tier gating: anonymous free models at opencode.ai/zen only serve
+// requests carrying the opencode client User-Agent, and the vendor now also
+// requires a stable per-conversation `x-opencode-session` header (missing it
+// surfaces as "must using opencode for opencode free endpoint" / 429
+// FreeUsageLimitError). Inject both via the `chat.headers` hook so free
+// models keep working regardless of which agent (Raw or not) is active.
+//
+// - User-Agent: only set when absent or not already `opencode/*`, so we never
+//   clobber the real client UA or another plugin's contribution.
+// - x-opencode-session: stable per conversation → use the opencode sessionID
+//   directly (that is exactly the vendor's stated intent).
+// - Scoped to the `opencode` provider only, so we never leak session IDs or
+//   spoof UA to third-party providers.
+const OPENCODE_PROVIDER_ID = "opencode"
+const FALLBACK_USER_AGENT = "opencode/1.18.34"
+const SESSION_HEADER = "x-opencode-session"
+
 const server: Plugin = async ({ client }) => {
   const log = (message: string) => {
     try {
@@ -34,6 +51,24 @@ const server: Plugin = async ({ client }) => {
   }
 
   return {
+    "chat.headers": async (input, output) => {
+      // Only touch opencode-provider requests (Zen / Zen-Go free + paid).
+      const providerID =
+        input.model?.providerID ?? input.provider?.info?.id ?? input.provider?.info?.name
+      if (providerID !== OPENCODE_PROVIDER_ID) {
+        return
+      }
+      output.headers ??= {}
+      const existingUA =
+        output.headers["User-Agent"] ?? output.headers["user-agent"]
+      if (!existingUA || !existingUA.startsWith("opencode/")) {
+        output.headers["User-Agent"] = process.env.OPENCODE_USER_AGENT ?? FALLBACK_USER_AGENT
+      }
+      if (input.sessionID && !output.headers[SESSION_HEADER]) {
+        output.headers[SESSION_HEADER] = input.sessionID
+      }
+    },
+
     "experimental.chat.system.transform": async (_input, output) => {
       // Join defensively in case multiple system blocks exist.
       const assembled = output.system.join("\n")