opencode-readseek 0.7.0 → 0.7.1

package/README.md

@@ -9,7 +9,7 @@ Add the plugin to `opencode.json`:
 
 ```json
 {
-  "plugin": [["opencode-readseek", { "imageMode": "auto" }]]
+  "plugin": ["opencode-readseek"]
 }
 ```
 
@@ -18,7 +18,8 @@ binary dependency with Bun at startup.
 
 ## Tools
 
-- `readseek_read`: read text with `LINE:HASH` anchors; image/PDF handling is explicit and PDFs default to one page.
+- `readseek_read`: read text with `LINE:HASH` anchors; PDFs select one page by
+  default and accept an explicit page.
 - `readseek_edit`: apply line, range, and insertion edits with fresh `LINE:HASH` anchors.
 - `readseek_write`: create or replace a complete text file.
 - `readseek_grep`: plain-text or regular-expression search with anchored results.
@@ -27,15 +28,28 @@ binary dependency with Bun at startup.
 - `readseek_def`, `readseek_refs`, `readseek_hover`: symbol navigation.
 - `readseek_rename`: apply a verified rename by default; `apply: false` returns a dry-run plan.
 - `readseek_check`: parse diagnostics.
-- `readseek_view`: view an indexed PDF overview or narrow it by page, node, kind, or depth.
+- `readseek_view`: create or reuse a PDF index, return its overview, or narrow
+  it by page, node, kind, or depth.
 
 The plugin requests OpenCode read, grep, external-directory, and edit permissions
 as needed. File changes invalidate remembered anchors. Compaction context records
 paths with fresh anchors and summaries of pending dry-run rename plans. Text reads
 return at most 2,000 lines by default.
 
+The plugin also instructs OpenCode to prefer ReadSeek's anchored read, edit,
+write, and rename tools over built-in file mutation tools while leaving the
+built-ins available as fallbacks.
+
 ## Configuration
 
+Pass options with OpenCode's plugin tuple form:
+
+```json
+{
+  "plugin": [["opencode-readseek", { "imageMode": "auto" }]]
+}
+```
+
 `imageMode` defaults to `"auto"`: it exposes `none`, `all`, `ocr`, `caption`, and
 `objects`. `"on"` omits `none`; `"off"` skips image/PDF files. Omitting
 `image` also skips visual files.

package/index.ts

@@ -13,6 +13,19 @@ const MAX_OUTPUT_BYTES = 32 * 1024 * 1024;
 const DEFAULT_READ_LIMIT = 2000;
 const MAX_DOCUMENT_OUTPUT_BYTES = 256 * 1024;
 const MAX_DOCUMENT_OUTPUT_LINES = 2000;
+const EDITING_POLICY = [
+  "ReadSeek editing policy:",
+  "- Prefer readseek_read over built-in file reads when preparing to edit existing text; its LINE:HASH anchors are required by readseek_edit.",
+  "- Prefer readseek_edit for existing text files, readseek_write for whole-file creation or replacement, and readseek_rename for symbol renames.",
+  "- Do not use built-in edit, write, or apply_patch when the corresponding ReadSeek tool can perform the change.",
+  "- Use readseek_check after source edits for a quick syntax check.",
+].join("\n");
+const PREFERRED_TOOL_DESCRIPTIONS: Record<string, string> = {
+  readseek_edit: "Preferred tool for editing existing text files with verified LINE:HASH anchors.",
+  readseek_read: "Preferred file reader when an existing text file may be edited; returns the anchors required by readseek_edit.",
+  readseek_rename: "Preferred tool for renaming code symbols safely across their resolved bindings.",
+  readseek_write: "Preferred tool for creating or replacing a complete text file.",
+};
 const READSEEK_PLATFORM_PACKAGES: Record<string, string> = {
   "darwin-arm64": "@jarkkojs/readseek-darwin-arm64",
   "linux-arm64": "@jarkkojs/readseek-linux-arm64",
@@ -1333,6 +1346,13 @@ export const ReadSeekPlugin: Plugin = async (_input, options) => {
         },
       ),
     },
+    "experimental.chat.system.transform": async (_input, output) => {
+      output.system.push(EDITING_POLICY);
+    },
+    "tool.definition": async (input, output) => {
+      const preference = PREFERRED_TOOL_DESCRIPTIONS[input.toolID];
+      if (preference) output.description = `${preference} ${output.description}`;
+    },
     event: async ({ event }) => {
       if (event.type === "file.edited" || event.type === "file.watcher.updated") {
         anchors.forget(event.properties.file);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-readseek",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "OpenCode plugin for readseek-backed structural code navigation",
   "type": "module",
   "main": "./index.ts",
@@ -30,7 +30,7 @@
     "node": ">=20.0.0"
   },
   "dependencies": {
-    "@jarkkojs/readseek": "^0.7.0",
+    "@jarkkojs/readseek": "^0.7.1",
     "@opencode-ai/plugin": "^1.17.20"
   },
   "devDependencies": {