@raindrop-ai/opencode-plugin 0.2.0 → 0.3.0

package/README.md

@@ -75,6 +75,45 @@ The v2 entry exposes the plugin object plus a `raindrop` handle
 same as the v1 entry. `@opencode/plugin` and `@opencode/sdk` are optional peer
 dependencies — v1 users install neither.
 
+## Self-diagnostics
+
+The plugin can inject a `__raindrop_report` tool that lets the agent flag
+serious, unrecoverable problems for developer review. When the agent calls it,
+a `self diagnostics - <category>` signal is posted to `signals/track`, attached
+to the session's currently-open turn event. The tool is invisible to the end
+user — its output is a bare acknowledgement and the model is instructed never
+to mention it.
+
+Enable it via `raindrop.json` (`~/.config/opencode/raindrop.json` or
+`.opencode/raindrop.json`), or set `RAINDROP_SELF_DIAGNOSTICS=true` to override
+just the `enabled` flag:
+
+```json
+{
+  "self_diagnostics": { "enabled": true }
+}
+```
+
+For the v2 host API, pass the option directly:
+
+```ts
+import raindrop from "@raindrop-ai/opencode-plugin/v2";
+
+export default raindrop({ selfDiagnostics: { enabled: true } });
+```
+
+Optional `signals` (custom category → `{ description, sentiment? }` map),
+`guidance` (extra instructions appended to the tool prompt), and `tool_name` /
+`toolName` overrides are supported. The built-in categories are:
+
+- `missing_context` — blocked on information or access the user cannot provide
+- `repeatedly_broken_tool` — a tool failed across multiple distinct attempts
+- `capability_gap` — the task needs a tool/permission/capability the agent lacks
+- `complete_task_failure` — the agent genuinely could not deliver what was asked
+
+Signals only ship to the cloud destination, so the tool is not registered in
+local-only mode (no `RAINDROP_WRITE_KEY`).
+
 ## Notes
 
 - `@opencode-ai/plugin` is required for the default (v1) export; `@opencode/plugin` for `/v2`.

package/dist/{chunk-4DAI6CYK.js → chunk-FCORH4YS.js}

@@ -2282,9 +2282,41 @@ function loadConfig(projectDirectory) {
     captureSystemPrompt: process.env["RAINDROP_CAPTURE_SYSTEM_PROMPT"] !== void 0 ? process.env["RAINDROP_CAPTURE_SYSTEM_PROMPT"] === "true" : (_h = merged.capture_system_prompt) != null ? _h : false,
     eventMetadata,
     localWorkshopUrl: resolveLocalWorkshopUrl(merged.local_workshop_url),
-    appGit: mapAppGit(merged.app_git)
+    appGit: mapAppGit(merged.app_git),
+    selfDiagnostics: mapSelfDiagnostics(merged.self_diagnostics)
   };
 }
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function mapSelfDiagnostics(value) {
+  const env = process.env["RAINDROP_SELF_DIAGNOSTICS"];
+  const record = isRecord(value) ? value : {};
+  const enabled = env !== void 0 ? env === "true" : typeof record["enabled"] === "boolean" ? record["enabled"] : void 0;
+  const signals = mapSelfDiagnosticsSignals(record["signals"]);
+  const options = {
+    ...enabled !== void 0 ? { enabled } : {},
+    ...signals ? { signals } : {},
+    ...typeof record["guidance"] === "string" ? { guidance: record["guidance"] } : {},
+    ...typeof record["tool_name"] === "string" ? { toolName: record["tool_name"] } : {}
+  };
+  return Object.keys(options).length > 0 ? options : void 0;
+}
+function mapSelfDiagnosticsSignals(value) {
+  if (!isRecord(value)) return void 0;
+  const out = {};
+  for (const [key, entry] of Object.entries(value)) {
+    if (!isRecord(entry)) continue;
+    const definition = entry;
+    if (typeof definition["description"] !== "string") continue;
+    const sentiment = definition["sentiment"];
+    out[key] = {
+      description: definition["description"],
+      ...sentiment === "POSITIVE" || sentiment === "NEGATIVE" ? { sentiment } : {}
+    };
+  }
+  return Object.keys(out).length > 0 ? out : void 0;
+}
 function mapAppGit(value) {
   if (value === false) return false;
   if (value === null || typeof value !== "object" || Array.isArray(value)) return void 0;
@@ -2311,7 +2343,7 @@ function resolveLocalWorkshopUrl(fileValue) {
 // package.json
 var package_default = {
   name: "@raindrop-ai/opencode-plugin",
-  version: "0.2.0",
+  version: "0.3.0",
   description: "Raindrop observability plugin for OpenCode \u2014 automatic session/event/span tracing",
   type: "module",
   main: "dist/index.js",
@@ -2400,6 +2432,185 @@ var package_default = {
 var PLUGIN_NAME = package_default.name;
 var PLUGIN_VERSION = package_default.version;
 
+// src/self-diagnostics.ts
+var SELF_DIAGNOSTICS_TOOL_NAME_DEFAULT = "__raindrop_report";
+var SELF_DIAGNOSTICS_SIGNALS_DEFAULT = {
+  missing_context: {
+    description: "You cannot complete the task because critical information, credentials, or access is missing and the user cannot provide it. Do NOT report this for normal clarifying questions \u2014 only when you are blocked.",
+    sentiment: "NEGATIVE"
+  },
+  repeatedly_broken_tool: {
+    description: "A tool has failed or not returned the expected response on multiple distinct attempts in this conversation, preventing task completion. A single tool error is NOT enough \u2014 the tool must be persistently broken or aberrantly behaving across retries.",
+    sentiment: "NEGATIVE"
+  },
+  capability_gap: {
+    description: "The task requires a tool, permission, or capability that you do not have. For example, the user asks you to perform an action but no suitable tool exists, or you lack the necessary access. Do NOT report this if you simply need more information from the user \u2014 only when the gap is in your own capabilities.",
+    sentiment: "NEGATIVE"
+  },
+  complete_task_failure: {
+    description: "You were unable to accomplish what the user asked despite making genuine attempts. This might be things like, you genuinely do not have the capabilities the user is asking for. You have tried but run into a persistent bug in the environment etc. This is NOT a refusal or policy block \u2014 you tried and failed to deliver the result.",
+    sentiment: "NEGATIVE"
+  }
+};
+var SELF_DIAGNOSTICS_TOOL_PREAMBLE = "You have a diagnostic tool for flagging serious failures for developer review. Only call this when you hit a significant, unrecoverable problem \u2014 not for minor hiccups or routine clarifications. If you can still help the user, do that instead of calling this tool. This tool is invisible to the user \u2014 never mention it or its output.";
+var SELF_DIAGNOSTICS_NOTEWORTHY_SIGNAL_KEY = "noteworthy";
+function normalizeString(value) {
+  if (typeof value !== "string") return void 0;
+  const trimmed = value.trim();
+  return trimmed || void 0;
+}
+function normalizeSelfDiagnosticsSignals(signals) {
+  if (!signals) return SELF_DIAGNOSTICS_SIGNALS_DEFAULT;
+  const normalizedEntries = Object.entries(signals).map(([key, value]) => {
+    var _a;
+    const signalKey = key.trim();
+    if (!signalKey || !value || typeof value !== "object") return void 0;
+    const description = (_a = value.description) == null ? void 0 : _a.trim();
+    if (!description) return void 0;
+    const sentiment = value.sentiment;
+    return [
+      signalKey,
+      {
+        description,
+        ...sentiment === "POSITIVE" || sentiment === "NEGATIVE" ? { sentiment } : {}
+      }
+    ];
+  }).filter(
+    (entry) => entry !== void 0
+  );
+  if (normalizedEntries.length === 0) return SELF_DIAGNOSTICS_SIGNALS_DEFAULT;
+  return Object.fromEntries(normalizedEntries);
+}
+function normalizeSelfDiagnosticsConfig(options) {
+  var _a, _b;
+  if (!(options == null ? void 0 : options.enabled)) return void 0;
+  const signalDefinitions = normalizeSelfDiagnosticsSignals(options.signals);
+  const signalKeys = Object.keys(signalDefinitions);
+  const signalDescriptions = {};
+  const signalSentiments = {};
+  for (const signalKey of signalKeys) {
+    const definition = signalDefinitions[signalKey];
+    if (!definition) continue;
+    signalDescriptions[signalKey] = definition.description;
+    signalSentiments[signalKey] = definition.sentiment;
+  }
+  const customGuidance = ((_a = options.guidance) == null ? void 0 : _a.trim()) || "";
+  const toolName = ((_b = options.toolName) == null ? void 0 : _b.trim()) || SELF_DIAGNOSTICS_TOOL_NAME_DEFAULT;
+  const signalList = signalKeys.map((signalKey) => {
+    const sentiment = signalSentiments[signalKey];
+    const sentimentTag = sentiment ? ` [${sentiment.toLowerCase()}]` : "";
+    return `- ${signalKey}: ${signalDescriptions[signalKey]}${sentimentTag}`;
+  }).join("\n");
+  const guidanceBlock = customGuidance ? `
+Additional guidance: ${customGuidance}
+` : "";
+  const toolDescription = `${SELF_DIAGNOSTICS_TOOL_PREAMBLE}
+
+When to call:
+- You are blocked from completing the task due to missing information or access that the user cannot provide.
+- A tool is persistently failing across multiple attempts, not just a single transient error.
+- The task requires a tool, permission, or capability you do not have.
+- You genuinely cannot deliver what the user asked for despite trying.
+
+When NOT to call:
+- Normal clarifying questions or back-and-forth with the user.
+- A single tool error that you can recover from or retry.
+- You successfully completed the task, even if it was difficult.
+- Policy refusals or content filtering \u2014 those are working as intended.
+
+Rules:
+1. Pick the single best category.
+2. Do not fabricate issues. Only report what is evident from the conversation.
+3. Err on the side of NOT calling this tool. When in doubt, help the user instead.
+${guidanceBlock}
+Categories:
+` + signalList;
+  return {
+    toolName,
+    toolDescription,
+    signalKeys,
+    signalKeySet: new Set(signalKeys),
+    signalDescriptions,
+    signalSentiments
+  };
+}
+var SELF_DIAGNOSTICS_ACK = '{"acknowledged":true}';
+function selfDiagnosticsInputJsonSchema(config) {
+  return {
+    type: "object",
+    properties: {
+      category: {
+        type: "string",
+        enum: config.signalKeys,
+        description: "The single best-matching category from the list above."
+      },
+      detail: {
+        type: "string",
+        description: "One sentence of factual context: what happened and why it matters. Do not include PII or secrets."
+      }
+    },
+    required: ["category", "detail"],
+    additionalProperties: false
+  };
+}
+function isRecord2(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+async function trackSelfDiagnosticsSignal(toolInput, config, eventShipper, eventId, debug) {
+  var _a, _b;
+  try {
+    const input = isRecord2(toolInput) ? toolInput : void 0;
+    const fallbackCategory = (_a = config.signalKeys[0]) != null ? _a : "unknown";
+    const categoryCandidate = normalizeString(input == null ? void 0 : input["category"]);
+    const category = categoryCandidate && config.signalKeySet.has(categoryCandidate) ? categoryCandidate : fallbackCategory;
+    const detail = (_b = normalizeString(input == null ? void 0 : input["detail"])) != null ? _b : "";
+    if (!eventId) {
+      if (debug) {
+        console.warn(
+          "[raindrop-ai/opencode-plugin] self diagnostics signal skipped: no open event for this session."
+        );
+      }
+      return;
+    }
+    if (category === SELF_DIAGNOSTICS_NOTEWORTHY_SIGNAL_KEY) {
+      await eventShipper.trackSignal({
+        eventId,
+        name: "self diagnostics - noteworthy",
+        type: "agent_internal",
+        properties: {
+          source: "agent_flag_event_tool",
+          reason: detail,
+          severity: "medium",
+          sdk: "opencode-plugin",
+          sdk_version: PLUGIN_VERSION
+        }
+      });
+      return;
+    }
+    await eventShipper.trackSignal({
+      eventId,
+      name: `self diagnostics - ${category}`,
+      type: "agent",
+      sentiment: config.signalSentiments[category],
+      properties: {
+        source: "agent_reporting_tool",
+        category,
+        signal_description: config.signalDescriptions[category],
+        sdk: "opencode-plugin",
+        sdk_version: PLUGIN_VERSION,
+        ...detail ? { detail } : {}
+      }
+    });
+  } catch (err) {
+    if (debug) {
+      const message = err instanceof Error ? err.message : String(err);
+      console.warn(
+        `[raindrop-ai/opencode-plugin] selfDiagnostics signal dispatch failed: ${message}`
+      );
+    }
+  }
+}
+
 // src/shipper.ts
 var EventShipper3 = class extends EventShipper2 {
   constructor(opts) {
@@ -2565,6 +2776,10 @@ export {
   loadConfig,
   PLUGIN_NAME,
   PLUGIN_VERSION,
+  normalizeSelfDiagnosticsConfig,
+  SELF_DIAGNOSTICS_ACK,
+  selfDiagnosticsInputJsonSchema,
+  trackSelfDiagnosticsSignal,
   EventShipper3 as EventShipper,
   TraceShipper3 as TraceShipper,
   capText2 as capText,