opencode-rag-plugin 2.4.3 → 2.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/config.d.ts +3 -1
- package/dist/core/config.js +1 -0
- package/dist/plugin.d.ts +6 -0
- package/dist/plugin.js +52 -6
- package/dist/types/opencode-plugin.d.ts +8 -1
- package/dist/v2/v2-adapter.d.ts +42 -1
- package/dist/v2/v2-adapter.js +52 -2
- package/package.json +1 -1
package/dist/core/config.d.ts
CHANGED
|
@@ -533,8 +533,10 @@ export interface RagConfig {
|
|
|
533
533
|
readNoResultsBehavior?: ReadNoResultsBehavior;
|
|
534
534
|
/** Maximum related files shown when read results are empty. */
|
|
535
535
|
readRelatedFilesMax?: number;
|
|
536
|
-
/** Whether to inject RAG tool guidance into system prompts (default true). */
|
|
536
|
+
/** Whether to inject RAG tool guidance into system prompts when the session's tool catalog exposes the RAG tools (default true). */
|
|
537
537
|
injectSystemPrompt?: boolean;
|
|
538
|
+
/** Whether to grant the read-only RAG tools to the built-in `explore` agent (default true). */
|
|
539
|
+
exploreAgentTools?: boolean;
|
|
538
540
|
};
|
|
539
541
|
/** Custom chunker module registrations. */
|
|
540
542
|
chunkers?: ChunkerConfig[];
|
package/dist/core/config.js
CHANGED
package/dist/plugin.d.ts
CHANGED
|
@@ -37,6 +37,12 @@ type CreateRagHooksOptions = {
|
|
|
37
37
|
/** Pre-created description provider for chunk descriptions. */
|
|
38
38
|
descriptionProvider?: DescriptionProvider;
|
|
39
39
|
};
|
|
40
|
+
/**
|
|
41
|
+
* Plugin tool names advertised by the mandatory guidance and granted to the
|
|
42
|
+
* built-in `explore` agent. `read` is deliberately absent — the read override
|
|
43
|
+
* shadows a built-in tool name and is ambiguous.
|
|
44
|
+
*/
|
|
45
|
+
export declare const RAG_TOOL_NAMES: readonly ["search_semantic", "get_file_skeleton", "find_usages", "describe_image", "make_decision", "recall_quirks", "add_quirk", "update_quirk", "delete_quirk"];
|
|
40
46
|
/**
|
|
41
47
|
* Create the RAG plugin hook implementations for an OpenCode workspace.
|
|
42
48
|
*
|
package/dist/plugin.js
CHANGED
|
@@ -333,6 +333,47 @@ const defaultDependencies = {
|
|
|
333
333
|
createStore: (storePath, dimension, config) => createVectorStore(config, storePath, dimension),
|
|
334
334
|
retrieve,
|
|
335
335
|
};
|
|
336
|
+
/**
|
|
337
|
+
* Plugin tool names advertised by the mandatory guidance and granted to the
|
|
338
|
+
* built-in `explore` agent. `read` is deliberately absent — the read override
|
|
339
|
+
* shadows a built-in tool name and is ambiguous.
|
|
340
|
+
*/
|
|
341
|
+
export const RAG_TOOL_NAMES = [
|
|
342
|
+
"search_semantic",
|
|
343
|
+
"get_file_skeleton",
|
|
344
|
+
"find_usages",
|
|
345
|
+
"describe_image",
|
|
346
|
+
"make_decision",
|
|
347
|
+
"recall_quirks",
|
|
348
|
+
"add_quirk",
|
|
349
|
+
"update_quirk",
|
|
350
|
+
"delete_quirk",
|
|
351
|
+
];
|
|
352
|
+
/**
|
|
353
|
+
* Built-in agents that ship with a permission policy denying every RAG tool
|
|
354
|
+
* (e.g. `explore`: deny all except read/glob/grep and the web tools). When the
|
|
355
|
+
* host sends no tool catalog, the guidance gate assumes they lack the tools —
|
|
356
|
+
* unless the explore tool grant (openCode.exploreAgentTools) is active.
|
|
357
|
+
*/
|
|
358
|
+
const TOOLLESS_BUILTIN_AGENTS = new Set(["explore"]);
|
|
359
|
+
/**
|
|
360
|
+
* Decide whether the mandatory RAG guidance should be injected into the
|
|
361
|
+
* session's system prompt. OpenCode V2 passes the session's tool catalog to
|
|
362
|
+
* the context hook: advertise the tools only when at least one RAG tool is
|
|
363
|
+
* actually exposed. Restricted agents (`explore`) and custom permission
|
|
364
|
+
* overrides would otherwise receive an inert mandate referencing tools they
|
|
365
|
+
* cannot call. Hosts that do not send a catalog assume the legacy state —
|
|
366
|
+
* tool-less built-in agents stay skipped unless the explore tool grant is on.
|
|
367
|
+
*/
|
|
368
|
+
function shouldInjectSystemGuidance(tools, agent, exploreToolsGranted) {
|
|
369
|
+
if (tools) {
|
|
370
|
+
return RAG_TOOL_NAMES.some((name) => name in tools);
|
|
371
|
+
}
|
|
372
|
+
if (agent !== undefined && TOOLLESS_BUILTIN_AGENTS.has(agent)) {
|
|
373
|
+
return exploreToolsGranted;
|
|
374
|
+
}
|
|
375
|
+
return true;
|
|
376
|
+
}
|
|
336
377
|
/**
|
|
337
378
|
* Format a list of relevant files (aggregated from chunks) for display.
|
|
338
379
|
* Groups chunks by file path and sorts by maximum relevance score.
|
|
@@ -845,13 +886,18 @@ export function createRagHooks(options) {
|
|
|
845
886
|
// Non-critical — must never throw
|
|
846
887
|
}
|
|
847
888
|
},
|
|
848
|
-
async "experimental.chat.system.transform"(
|
|
889
|
+
async "experimental.chat.system.transform"(input, output) {
|
|
890
|
+
const cfg = getEffectiveCfg();
|
|
891
|
+
const guidanceEnabled = cfg.openCode.injectSystemPrompt !== false;
|
|
892
|
+
const exploreToolsGranted = cfg.openCode.exploreAgentTools !== false;
|
|
893
|
+
const injectGuidance = guidanceEnabled && shouldInjectSystemGuidance(input?.tools, input?.agent, exploreToolsGranted);
|
|
849
894
|
appendDebugLog(options.logFilePath, {
|
|
850
895
|
scope: "experimental.chat.system.transform",
|
|
851
|
-
message:
|
|
896
|
+
message: injectGuidance
|
|
897
|
+
? "system guidance injected"
|
|
898
|
+
: `system guidance skipped (${guidanceEnabled ? `no RAG tools in session; agent=${input?.agent ?? "unknown"}` : "injectSystemPrompt=false"})`,
|
|
852
899
|
});
|
|
853
|
-
|
|
854
|
-
if (cfg.openCode.injectSystemPrompt !== false) {
|
|
900
|
+
if (injectGuidance) {
|
|
855
901
|
const guidance = buildSystemGuidanceLines({ promptEnforcement: !!cfg.memory?.promptEnforcement, decisionEnabled: !!cfg.decision?.enabled, routeBeforeAsking: !!cfg.decision?.routeBeforeAsking });
|
|
856
902
|
output.system.unshift(guidance.join("\n"));
|
|
857
903
|
}
|
|
@@ -888,7 +934,7 @@ export function createRagHooks(options) {
|
|
|
888
934
|
}
|
|
889
935
|
// Inject relevant quirks into system prompt when memory.autoInject is enabled
|
|
890
936
|
try {
|
|
891
|
-
const sessionId =
|
|
937
|
+
const sessionId = input?.sessionID;
|
|
892
938
|
if (sessionId) {
|
|
893
939
|
const memCfg = getEffectiveCfg().memory;
|
|
894
940
|
if (memCfg?.enabled && memCfg?.autoInject) {
|
|
@@ -936,7 +982,7 @@ export function createRagHooks(options) {
|
|
|
936
982
|
// Tool-error quirks: flush the pending block captured in tool.execute.after.
|
|
937
983
|
// Freshness-bounded — a stale error must not leak into a later turn.
|
|
938
984
|
try {
|
|
939
|
-
const sessionId =
|
|
985
|
+
const sessionId = input?.sessionID;
|
|
940
986
|
if (sessionId) {
|
|
941
987
|
const pending = sessionPendingToolErrorQuirk.get(sessionId);
|
|
942
988
|
if (pending) {
|
|
@@ -47,7 +47,14 @@ declare module "@opencode-ai/plugin" {
|
|
|
47
47
|
output: { messages: { info: Message; parts: Part[] }[] }
|
|
48
48
|
) => Promise<void>;
|
|
49
49
|
"experimental.chat.system.transform"?: (
|
|
50
|
-
input: {
|
|
50
|
+
input: {
|
|
51
|
+
sessionID?: string;
|
|
52
|
+
model: Model;
|
|
53
|
+
/** Session agent ID (OpenCode V2); absent when the host does not send it. */
|
|
54
|
+
agent?: string;
|
|
55
|
+
/** Tool catalog exposed to the session (OpenCode V2); absent when the host does not send it. */
|
|
56
|
+
tools?: Record<string, { description?: string; input?: unknown }>;
|
|
57
|
+
},
|
|
51
58
|
output: { system: string[] }
|
|
52
59
|
) => Promise<void>;
|
|
53
60
|
}
|
package/dist/v2/v2-adapter.d.ts
CHANGED
|
@@ -16,6 +16,10 @@
|
|
|
16
16
|
* | `tool.execute.after` | `ctx.tool.hook("execute.after", ...)` |
|
|
17
17
|
* | `event` | `ctx.event.subscribe({ signal })` |
|
|
18
18
|
*
|
|
19
|
+
* Additional V2-only registration (no V1 equivalent): the read-only RAG tools
|
|
20
|
+
* are granted to the built-in `explore` agent via `ctx.agent.transform`
|
|
21
|
+
* (config `openCode.exploreAgentTools`, default on).
|
|
22
|
+
*
|
|
19
23
|
* The V2 prompt hook exposes the user's text as a mutable `event.prompt.text`
|
|
20
24
|
* instead of V1's parts-mutation contract; the adapter shims a V1-shaped
|
|
21
25
|
* `output.parts` view around it and writes the mutated text back.
|
|
@@ -45,6 +49,24 @@ type V2EventDomain = {
|
|
|
45
49
|
signal: AbortSignal;
|
|
46
50
|
}): AsyncIterable<unknown>;
|
|
47
51
|
};
|
|
52
|
+
/** Permission rule shape inside an agent definition (OpenCode V2 schema). */
|
|
53
|
+
type V2PermissionRule = {
|
|
54
|
+
action: string;
|
|
55
|
+
resource: string;
|
|
56
|
+
effect: "allow" | "deny" | "ask";
|
|
57
|
+
};
|
|
58
|
+
/** Mutable agent definition subset used by the explore tool grant. */
|
|
59
|
+
type V2AgentInfo = {
|
|
60
|
+
permissions?: V2PermissionRule[];
|
|
61
|
+
};
|
|
62
|
+
type V2AgentEditor = {
|
|
63
|
+
get(id: string): V2AgentInfo | undefined;
|
|
64
|
+
update(id: string, update: (agent: V2AgentInfo) => void): void;
|
|
65
|
+
};
|
|
66
|
+
type V2AgentDomain = {
|
|
67
|
+
transform(callback: (editor: V2AgentEditor) => void): Promise<V2Registration>;
|
|
68
|
+
reload(): Promise<void>;
|
|
69
|
+
};
|
|
48
70
|
/** Structural subset of the OpenCode V2 plugin context. */
|
|
49
71
|
export type V2Context = {
|
|
50
72
|
location: {
|
|
@@ -54,6 +76,7 @@ export type V2Context = {
|
|
|
54
76
|
tool: V2ToolDomain;
|
|
55
77
|
session: V2SessionDomain;
|
|
56
78
|
event: V2EventDomain;
|
|
79
|
+
agent?: V2AgentDomain;
|
|
57
80
|
};
|
|
58
81
|
/** A registered V2 tool definition (structural subset of Tool.Info). */
|
|
59
82
|
type V2Tool = {
|
|
@@ -104,9 +127,19 @@ type V2PromptHookEvent = {
|
|
|
104
127
|
text: string;
|
|
105
128
|
};
|
|
106
129
|
};
|
|
107
|
-
/**
|
|
130
|
+
/**
|
|
131
|
+
* V2 `context` hook event. `agent` and `tools` mirror the host's
|
|
132
|
+
* `SessionContext` (session agent ID and the tool catalog actually exposed to
|
|
133
|
+
* it); both stay optional so hosts that don't send them keep the legacy
|
|
134
|
+
* unconditional guidance injection.
|
|
135
|
+
*/
|
|
108
136
|
type V2ContextHookEvent = {
|
|
109
137
|
sessionID: string;
|
|
138
|
+
agent?: string;
|
|
139
|
+
tools?: Record<string, {
|
|
140
|
+
description?: string;
|
|
141
|
+
input?: unknown;
|
|
142
|
+
}>;
|
|
110
143
|
system: Array<{
|
|
111
144
|
type: "text";
|
|
112
145
|
text: string;
|
|
@@ -119,6 +152,14 @@ type V2ContextHookEvent = {
|
|
|
119
152
|
export declare function zodArgToJsonSchema(schema: unknown): Record<string, unknown>;
|
|
120
153
|
/** Convert a V1 `args` record (zod raw shape) to a JSON schema object. Exported for tests. */
|
|
121
154
|
export declare function zodShapeToJsonSchema(shape: Record<string, unknown>): Record<string, unknown>;
|
|
155
|
+
/**
|
|
156
|
+
* Grant the read-only RAG tools to the built-in `explore` agent. Appends an
|
|
157
|
+
* `allow` rule per tool action AFTER the shipped deny-all policy (OpenCode
|
|
158
|
+
* resolves permissions with "last matching rule wins"); an existing explicit
|
|
159
|
+
* rule for a tool action — user-configured allow, ask, or deny — is respected
|
|
160
|
+
* and left untouched. No-op when the agent is absent. Exported for tests.
|
|
161
|
+
*/
|
|
162
|
+
export declare function grantExploreToolPermissions(editor: V2AgentEditor): void;
|
|
122
163
|
/**
|
|
123
164
|
* Run the V1 `ragPlugin` factory for the V2 context's location and register
|
|
124
165
|
* all returned hooks as V2 transforms/hooks. Returns a cleanup function that
|
package/dist/v2/v2-adapter.js
CHANGED
|
@@ -16,6 +16,10 @@
|
|
|
16
16
|
* | `tool.execute.after` | `ctx.tool.hook("execute.after", ...)` |
|
|
17
17
|
* | `event` | `ctx.event.subscribe({ signal })` |
|
|
18
18
|
*
|
|
19
|
+
* Additional V2-only registration (no V1 equivalent): the read-only RAG tools
|
|
20
|
+
* are granted to the built-in `explore` agent via `ctx.agent.transform`
|
|
21
|
+
* (config `openCode.exploreAgentTools`, default on).
|
|
22
|
+
*
|
|
19
23
|
* The V2 prompt hook exposes the user's text as a mutable `event.prompt.text`
|
|
20
24
|
* instead of V1's parts-mutation contract; the adapter shims a V1-shaped
|
|
21
25
|
* `output.parts` view around it and writes the mutated text back.
|
|
@@ -26,7 +30,8 @@
|
|
|
26
30
|
* queries and session-end extraction fall back gracefully.
|
|
27
31
|
* - The read-tool override keeps its V1 execute contract (args + sessionID).
|
|
28
32
|
*/
|
|
29
|
-
import {
|
|
33
|
+
import { findConfigFile, loadConfig } from "../core/config.js";
|
|
34
|
+
import { ragPlugin, RAG_TOOL_NAMES } from "../plugin.js";
|
|
30
35
|
/**
|
|
31
36
|
* Extract a human-readable error string from a V2 `execute.after` error event.
|
|
32
37
|
* The exact error payload differs across OpenCode versions; probe the known
|
|
@@ -160,6 +165,25 @@ function v1ToolToV2(name, def, codemode) {
|
|
|
160
165
|
// ────────────────────────────────────────────────────────────────────────────
|
|
161
166
|
// Registration entry point
|
|
162
167
|
// ────────────────────────────────────────────────────────────────────────────
|
|
168
|
+
/**
|
|
169
|
+
* Grant the read-only RAG tools to the built-in `explore` agent. Appends an
|
|
170
|
+
* `allow` rule per tool action AFTER the shipped deny-all policy (OpenCode
|
|
171
|
+
* resolves permissions with "last matching rule wins"); an existing explicit
|
|
172
|
+
* rule for a tool action — user-configured allow, ask, or deny — is respected
|
|
173
|
+
* and left untouched. No-op when the agent is absent. Exported for tests.
|
|
174
|
+
*/
|
|
175
|
+
export function grantExploreToolPermissions(editor) {
|
|
176
|
+
if (!editor.get("explore"))
|
|
177
|
+
return;
|
|
178
|
+
editor.update("explore", (agent) => {
|
|
179
|
+
const rules = (agent.permissions ??= []);
|
|
180
|
+
for (const name of RAG_TOOL_NAMES) {
|
|
181
|
+
if (rules.some((rule) => rule.action === name))
|
|
182
|
+
continue;
|
|
183
|
+
rules.push({ action: name, resource: "*", effect: "allow" });
|
|
184
|
+
}
|
|
185
|
+
});
|
|
186
|
+
}
|
|
163
187
|
/**
|
|
164
188
|
* Run the V1 `ragPlugin` factory for the V2 context's location and register
|
|
165
189
|
* all returned hooks as V2 transforms/hooks. Returns a cleanup function that
|
|
@@ -176,6 +200,18 @@ export async function registerRagPluginV2(ctx) {
|
|
|
176
200
|
// to force the previous code-mode-only behavior.
|
|
177
201
|
const codemode = typeof ctx.options?.codemode === "boolean" ? ctx.options.codemode : false;
|
|
178
202
|
const registrations = [];
|
|
203
|
+
// Explore keeps its RAG tool grant across reloads; opt out via
|
|
204
|
+
// `openCode.exploreAgentTools: false` in opencode-rag.json.
|
|
205
|
+
let exploreToolsEnabled = true;
|
|
206
|
+
try {
|
|
207
|
+
const cfgPath = findConfigFile(ctx.location.directory);
|
|
208
|
+
if (cfgPath) {
|
|
209
|
+
exploreToolsEnabled = loadConfig(cfgPath, false).openCode.exploreAgentTools !== false;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
catch {
|
|
213
|
+
// Malformed config — the V1 factory reports it; fall back to the default
|
|
214
|
+
}
|
|
179
215
|
// ── Tools ────────────────────────────────────────────────────────────────
|
|
180
216
|
const toolDefs = (hooks.tool ?? {});
|
|
181
217
|
const toolEntries = Object.entries(toolDefs);
|
|
@@ -187,6 +223,20 @@ export async function registerRagPluginV2(ctx) {
|
|
|
187
223
|
});
|
|
188
224
|
registrations.push(registration);
|
|
189
225
|
}
|
|
226
|
+
// Explore agent tool grant: hand the read-only RAG tools to the built-in
|
|
227
|
+
// search agent. The grant appends allow rules after the shipped deny-all
|
|
228
|
+
// policy (last matching rule wins) and respects explicit user rules.
|
|
229
|
+
if (ctx.agent && exploreToolsEnabled) {
|
|
230
|
+
try {
|
|
231
|
+
const registration = await ctx.agent.transform((editor) => {
|
|
232
|
+
grantExploreToolPermissions(editor);
|
|
233
|
+
});
|
|
234
|
+
registrations.push(registration);
|
|
235
|
+
}
|
|
236
|
+
catch {
|
|
237
|
+
// Non-critical — the guidance gate falls back on the tool catalog
|
|
238
|
+
}
|
|
239
|
+
}
|
|
190
240
|
// ── prompt hook (V1 `chat.message`) ─────────────────────────────────────
|
|
191
241
|
// Shims a V1-shaped output (parts array) around the mutable prompt text,
|
|
192
242
|
// runs the V1 handler, and writes the (possibly replaced) text back.
|
|
@@ -218,7 +268,7 @@ export async function registerRagPluginV2(ctx) {
|
|
|
218
268
|
const registration = await ctx.session.hook("context", async (event) => {
|
|
219
269
|
const output = { system: [] };
|
|
220
270
|
try {
|
|
221
|
-
await systemTransformHook({ sessionID: event.sessionID }, output);
|
|
271
|
+
await systemTransformHook({ sessionID: event.sessionID, agent: event.agent, tools: event.tools }, output);
|
|
222
272
|
}
|
|
223
273
|
catch {
|
|
224
274
|
// Non-critical — must never throw
|