Something went wrong. Try again.
opencode v2 mirror
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206export * as ReadTool from "./read.js"
import type { Context } from "@opencode/plugin/effect/plugin"import { basename, dirname, join } from "path"import { ToolFailure } from "@opencode/ai"import { Effect, Schema } from "effect"import { FSUtil } from "@opencode/util/fs-util"import { Location } from "../../location.js"import { FileAccess } from "../../file-access.js"import { SessionInstructions } from "../../session/instructions.js"import { AbsolutePath } from "../../schema.js"import { ReadToolFileSystem } from "../read-filesystem.js"import { Environment } from "../../environment/index.js"
export const name = "read"const FILENAME = "AGENTS.md"const LocationInput = Schema.Struct({ path: Schema.String.annotate({ description: "File or directory to read" }), offset: ReadToolFileSystem.PageInput.fields.offset.annotate({ description: "The line or directory entry to start reading from (1-based)", }), limit: ReadToolFileSystem.PageInput.fields.limit.annotate({ description: "The maximum number of lines or directory entries to read (defaults to 2000)", }),})export const Input = LocationInputconst Output = Schema.Union([ReadToolFileSystem.FileContent, ReadToolFileSystem.TextPage, ReadToolFileSystem.ListPage])
export const Plugin = { id: "opencode.tool.read", effect: Effect.fn("ReadTool.Plugin")(function* (ctx: Context) { const reader = yield* ReadToolFileSystem.Service const access = yield* FileAccess.Service const sessionInstructions = yield* SessionInstructions.Service const fs = yield* FSUtil.Service const location = yield* Location.Service
yield* ctx.tool .transform((editor) => editor.add({ name, options: { codemode: false }, description: "Read the contents of a file or directory. Supports text files, images, and PDFs. Images and PDFs are presented directly to the model. Each text line is prefixed by its 1-based line number as <line>: <content>. The prefix is for reference and is not part of the file content. Directory entries are returned one per line. Use offset and limit to read large files or directories in sections. Prefer one larger read over many small slices, and use grep to find specific content in large files.", input: Input, output: Output, execute: (input, context) => { return Effect.gen(function* () { const read = (target: FileAccess.Target) => reader.read(target.absolute, target.resource, { offset: input.offset, limit: input.limit, })
const requested = yield* access.authorizeRead(input.path, context) const result = yield* read(requested).pipe( Effect.map((content) => ({ content, target: requested, path: input.path })), Effect.catchIf( (error) => error instanceof Environment.NotFound, () => Effect.gen(function* () { const alternate = yield* alternatePath(requested.absolute).pipe( Effect.orElseSucceed(() => undefined), ) if (!alternate) return yield* missing(input.path, requested.absolute) const target = yield* access.authorizeRead(alternate, context, { siblingOf: requested }) const content = yield* read(target).pipe( Effect.catchIf( (error) => error instanceof Environment.NotFound, () => missing(input.path, requested.absolute), ), ) if (content.type === "list-page") return yield* missing(input.path, requested.absolute) return { content, target, path: join(dirname(input.path), basename(alternate)), } }), ), ) // After a successful read, discover nearby AGENTS.md walking up to the Location // root exclusive and inject them as durable synthetic instructions. For a // directory listing the walk starts at the directory itself (so its own AGENTS.md // is discovered); for a file it starts at the file's dirname. External reads are // skipped, and discovery failures never fail the read. yield* Effect.gen(function* () { if (result.target.externalDirectory !== undefined) return const resolved = yield* fs.resolve(result.target.absolute) const root = yield* fs.resolve(location.directory) // up() searches its stop directory, so the Location-root AGENTS.md (already // supplied by core initial instructions) is dropped by the dirname filter. const discovered = yield* fs.up({ targets: [FILENAME], start: result.content.type === "list-page" ? resolved : dirname(resolved), stop: root, }) const candidates = (yield* Effect.forEach(discovered, fs.resolve)).filter( (file) => dirname(file) !== root, ) if (candidates.length === 0) return yield* sessionInstructions.load({ sessionID: context.sessionID, paths: candidates }) }).pipe( Effect.catch(() => Effect.void), Effect.catchDefect(() => Effect.void), ) if ( result.content.type === "file" && result.content.encoding === "base64" && !ReadToolFileSystem.MEDIA_MIMES.has(result.content.mime) ) return yield* Effect.fail(new ReadToolFileSystem.BinaryFileError({ resource: result.target.resource })) return { output: result.content, path: result.path } }).pipe( Effect.map((result) => ({ output: result.output, content: toModelContent(result.path, input.offset, result.output), metadata: { truncated: result.output.type === "file" ? false : result.output.truncated }, })), Effect.mapError((error) => { if (error instanceof ToolFailure) return error const message = error instanceof ReadToolFileSystem.BinaryFileError || error instanceof ReadToolFileSystem.MediaIngestLimitError || error instanceof ReadToolFileSystem.OffsetOutOfRangeError || error instanceof ReadToolFileSystem.PathKindError ? error.message : `Unable to read ${input.path}` return new ToolFailure({ message, error }) }), ) }, }), ) .pipe(Effect.orDie)
const alternatePath = Effect.fn("ReadTool.alternatePath")(function* (absolute: string) { const base = basename(absolute).replace(/[\u00a0\u202f]/g, " ") const matches = (yield* reader.list(AbsolutePath.make(dirname(absolute)))).filter( (entry) => entry.type === "file" && entry.name.replace(/[\u00a0\u202f]/g, " ") === base, ) if (matches.length !== 1) return return join(dirname(absolute), matches[0].name) })
const missing = Effect.fn("ReadTool.missing")(function* (input: string, absolute: string) { const base = basename(input).toLowerCase() const suggestions = yield* fs.readDirectory(dirname(absolute)).pipe( Effect.map((entries) => entries .filter((entry) => { const candidate = entry.toLowerCase() return candidate.includes(base) || base.includes(candidate) }) .map((entry) => join(dirname(input), entry)) .slice(0, 3), ), Effect.orElseSucceed(() => [] as string[]), ) const message = suggestions.length === 0 ? `File not found: ${input}` : `File not found: ${input}\n\nDid you mean one of these?\n${suggestions.join("\n")}` return yield* new ToolFailure({ message }) }) }),}
export const toModelContent = (path: string, offset: number | undefined, output: typeof Output.Type) => { if (output.type === "file" && output.encoding === "base64") return [ { type: "text", text: output.mime === "application/pdf" ? "PDF read successfully" : "Image read successfully" }, { type: "file", uri: `data:${output.mime};base64,${output.content}`, mime: output.mime, name: path, }, ] as const
if (output.type === "list-page") { const start = offset || 1 const content = [ output.entries.length === 0 ? `Read directory ${path}, 0 entries` : `Read directory ${path}, entries ${start}-${start + output.entries.length - 1}`, ] output.entries.forEach((entry) => content.push(entry.path)) if (output.truncated && output.next !== undefined) content.push(`[Output truncated. Continue reading with offset: ${output.next}]`) return content.join("\n") }
const start = output.type === "text-page" ? output.offset : 1 // Pages already join selected lines; a trailing newline represents a selected blank line. const text = output.type === "file" ? output.content.replace(/\n$/, "") : output.content const lines = output.content === "" ? [] : text.split("\n") const content = [ lines.length === 0 ? `Read file ${path}, 0 lines` : `Read file ${path}, lines ${start}-${start + lines.length - 1}`, ] lines.forEach((line, index) => content.push(`${start + index}: ${line}`)) if (output.type === "text-page" && output.truncated && output.next !== undefined) content.push(`[Output truncated. Continue reading with offset: ${output.next}]`) return content.join("\n")}