@link-assistant/agent 0.0.8

package/src/tool/read.ts

@@ -0,0 +1,201 @@
+import z from "zod"
+import * as fs from "fs"
+import * as path from "path"
+import { Tool } from "./tool"
+import { FileTime } from "../file/time"
+import DESCRIPTION from "./read.txt"
+import { Filesystem } from "../util/filesystem"
+import { Instance } from "../project/instance"
+import { Provider } from "../provider/provider"
+import { Identifier } from "../id/id"
+import { iife } from "../util/iife"
+
+const DEFAULT_READ_LIMIT = 2000
+const MAX_LINE_LENGTH = 2000
+
+export const ReadTool = Tool.define("read", {
+  description: DESCRIPTION,
+  parameters: z.object({
+    filePath: z.string().describe("The path to the file to read"),
+    offset: z.coerce.number().describe("The line number to start reading from (0-based)").optional(),
+    limit: z.coerce.number().describe("The number of lines to read (defaults to 2000)").optional(),
+  }),
+  async execute(params, ctx) {
+    let filepath = params.filePath
+    if (!path.isAbsolute(filepath)) {
+      filepath = path.join(process.cwd(), filepath)
+    }
+    const title = path.relative(Instance.worktree, filepath)
+
+    // No restrictions - unrestricted file read
+    const file = Bun.file(filepath)
+    if (!(await file.exists())) {
+      const dir = path.dirname(filepath)
+      const base = path.basename(filepath)
+
+      const dirEntries = fs.readdirSync(dir)
+      const suggestions = dirEntries
+        .filter(
+          (entry) =>
+            entry.toLowerCase().includes(base.toLowerCase()) || base.toLowerCase().includes(entry.toLowerCase()),
+        )
+        .map((entry) => path.join(dir, entry))
+        .slice(0, 3)
+
+      if (suggestions.length > 0) {
+        throw new Error(`File not found: ${filepath}\n\nDid you mean one of these?\n${suggestions.join("\n")}`)
+      }
+
+      throw new Error(`File not found: ${filepath}`)
+    }
+
+    const isImage = isImageFile(filepath)
+    const supportsImages = await (async () => {
+      if (!ctx.extra?.["providerID"] || !ctx.extra?.["modelID"]) return false
+      const providerID = ctx.extra["providerID"] as string
+      const modelID = ctx.extra["modelID"] as string
+      const model = await Provider.getModel(providerID, modelID).catch(() => undefined)
+      if (!model) return false
+      return model.info.modalities?.input?.includes("image") ?? false
+    })()
+    if (isImage) {
+      if (!supportsImages) {
+        throw new Error(`Failed to read image: ${filepath}, model may not be able to read images`)
+      }
+      const mime = file.type
+      const msg = "Image read successfully"
+      return {
+        title,
+        output: msg,
+        metadata: {
+          preview: msg,
+        },
+        attachments: [
+          {
+            id: Identifier.ascending("part"),
+            sessionID: ctx.sessionID,
+            messageID: ctx.messageID,
+            type: "file",
+            mime,
+            url: `data:${mime};base64,${Buffer.from(await file.bytes()).toString("base64")}`,
+          },
+        ],
+      }
+    }
+
+    const isBinary = await isBinaryFile(filepath, file)
+    if (isBinary) throw new Error(`Cannot read binary file: ${filepath}`)
+
+    const limit = params.limit ?? DEFAULT_READ_LIMIT
+    const offset = params.offset || 0
+    const lines = await file.text().then((text) => text.split("\n"))
+    const raw = lines.slice(offset, offset + limit).map((line) => {
+      return line.length > MAX_LINE_LENGTH ? line.substring(0, MAX_LINE_LENGTH) + "..." : line
+    })
+    const content = raw.map((line, index) => {
+      return `${(index + offset + 1).toString().padStart(5, "0")}| ${line}`
+    })
+    const preview = raw.slice(0, 20).join("\n")
+
+    let output = "<file>\n"
+    output += content.join("\n")
+
+    const totalLines = lines.length
+    const lastReadLine = offset + content.length
+    const hasMoreLines = totalLines > lastReadLine
+
+    if (hasMoreLines) {
+      output += `\n\n(File has more lines. Use 'offset' parameter to read beyond line ${lastReadLine})`
+    } else {
+      output += `\n\n(End of file - total ${totalLines} lines)`
+    }
+    output += "\n</file>"
+
+    // just warms the lsp client
+    FileTime.read(ctx.sessionID, filepath)
+
+    return {
+      title,
+      output,
+      metadata: {
+        preview,
+      },
+    }
+  },
+})
+
+function isImageFile(filePath: string): string | false {
+  const ext = path.extname(filePath).toLowerCase()
+  switch (ext) {
+    case ".jpg":
+    case ".jpeg":
+      return "JPEG"
+    case ".png":
+      return "PNG"
+    case ".gif":
+      return "GIF"
+    case ".bmp":
+      return "BMP"
+    case ".webp":
+      return "WebP"
+    default:
+      return false
+  }
+}
+
+async function isBinaryFile(filepath: string, file: Bun.BunFile): Promise<boolean> {
+  const ext = path.extname(filepath).toLowerCase()
+  // binary check for common non-text extensions
+  switch (ext) {
+    case ".zip":
+    case ".tar":
+    case ".gz":
+    case ".exe":
+    case ".dll":
+    case ".so":
+    case ".class":
+    case ".jar":
+    case ".war":
+    case ".7z":
+    case ".doc":
+    case ".docx":
+    case ".xls":
+    case ".xlsx":
+    case ".ppt":
+    case ".pptx":
+    case ".odt":
+    case ".ods":
+    case ".odp":
+    case ".bin":
+    case ".dat":
+    case ".obj":
+    case ".o":
+    case ".a":
+    case ".lib":
+    case ".wasm":
+    case ".pyc":
+    case ".pyo":
+      return true
+    default:
+      break
+  }
+
+  const stat = await file.stat()
+  const fileSize = stat.size
+  if (fileSize === 0) return false
+
+  const bufferSize = Math.min(4096, fileSize)
+  const buffer = await file.arrayBuffer()
+  if (buffer.byteLength === 0) return false
+  const bytes = new Uint8Array(buffer.slice(0, bufferSize))
+
+  let nonPrintableCount = 0
+  for (let i = 0; i < bytes.length; i++) {
+    if (bytes[i] === 0) return true
+    if (bytes[i] < 9 || (bytes[i] > 13 && bytes[i] < 32)) {
+      nonPrintableCount++
+    }
+  }
+  // If >30% non-printable characters, consider it binary
+  return nonPrintableCount / bytes.length > 0.3
+}

package/src/tool/read.txt

@@ -0,0 +1,12 @@
+Reads a file from the local filesystem. You can access any file directly by using this tool.
+Assume this tool is able to read all files on the machine. If the User provides a path to a file assume that path is valid. It is okay to read a file that does not exist; an error will be returned.
+
+Usage:
+- The filePath parameter must be an absolute path, not a relative path
+- By default, it reads up to 2000 lines starting from the beginning of the file
+- You can optionally specify a line offset and limit (especially handy for long files), but it's recommended to read the whole file by not providing these parameters
+- Any lines longer than 2000 characters will be truncated
+- Results are returned using cat -n format, with line numbers starting at 1
+- You have the capability to call multiple tools in a single response. It is always better to speculatively read multiple files as a batch that are potentially useful.
+- If you read a file that exists but has empty contents you will receive a system reminder warning in place of file contents.
+- You can read image files using this tool.

package/src/tool/registry.ts

@@ -0,0 +1,87 @@
+import { BashTool } from "./bash"
+import { EditTool } from "./edit"
+import { GlobTool } from "./glob"
+import { GrepTool } from "./grep"
+import { ListTool } from "./ls"
+import { BatchTool } from "./batch"
+import { ReadTool } from "./read"
+import { TaskTool } from "./task"
+import { TodoWriteTool, TodoReadTool } from "./todo"
+import { WebFetchTool } from "./webfetch"
+import { WriteTool } from "./write"
+import { InvalidTool } from "./invalid"
+import type { Agent } from "../agent/agent"
+import { Tool } from "./tool"
+import { Instance } from "../project/instance"
+import { Config } from "../config/config"
+import { WebSearchTool } from "./websearch"
+import { CodeSearchTool } from "./codesearch"
+import { Flag } from "../flag/flag"
+
+export namespace ToolRegistry {
+  export const state = Instance.state(async () => {
+    const custom = [] as Tool.Info[]
+    return { custom }
+  })
+
+  export async function register(tool: Tool.Info) {
+    const { custom } = await state()
+    const idx = custom.findIndex((t) => t.id === tool.id)
+    if (idx >= 0) {
+      custom.splice(idx, 1, tool)
+      return
+    }
+    custom.push(tool)
+  }
+
+  async function all(): Promise<Tool.Info[]> {
+    const custom = await state().then((x) => x.custom)
+    const config = await Config.get()
+
+    return [
+      InvalidTool,
+      BashTool,
+      ReadTool,
+      GlobTool,
+      GrepTool,
+      ListTool,
+      EditTool,
+      WriteTool,
+      TaskTool,
+      WebFetchTool,
+      WebSearchTool,
+      CodeSearchTool,
+      BatchTool,
+      TodoWriteTool,
+      TodoReadTool,
+      ...custom,
+    ]
+  }
+
+  export async function ids() {
+    return all().then((x) => x.map((t) => t.id))
+  }
+
+  export async function tools(_providerID: string, _modelID: string) {
+    const tools = await all()
+    const result = await Promise.all(
+      tools.map(async (t) => ({
+        id: t.id,
+        ...(await t.init()),
+      })),
+    )
+    return result
+  }
+
+  export async function enabled(
+    _providerID: string,
+    _modelID: string,
+    agent: Agent.Info,
+  ): Promise<Record<string, boolean>> {
+    const result: Record<string, boolean> = {}
+
+    // Permission system removed - all tools enabled by default
+
+    return result
+  }
+}

package/src/tool/task.ts

@@ -0,0 +1,126 @@
+import { Tool } from "./tool"
+import DESCRIPTION from "./task.txt"
+import z from "zod"
+import { Session } from "../session"
+import { Bus } from "../bus"
+import { MessageV2 } from "../session/message-v2"
+import { Identifier } from "../id/id"
+import { Agent } from "../agent/agent"
+import { SessionPrompt } from "../session/prompt"
+import { iife } from "../util/iife"
+import { defer } from "../util/defer"
+
+export const TaskTool = Tool.define("task", async () => {
+  const agents = await Agent.list().then((x) => x.filter((a) => a.mode !== "primary"))
+  const description = DESCRIPTION.replace(
+    "{agents}",
+    agents
+      .map((a) => `- ${a.name}: ${a.description ?? "This subagent should only be called manually by the user."}`)
+      .join("\n"),
+  )
+  return {
+    description,
+    parameters: z.object({
+      description: z.string().describe("A short (3-5 words) description of the task"),
+      prompt: z.string().describe("The task for the agent to perform"),
+      subagent_type: z.string().describe("The type of specialized agent to use for this task"),
+      session_id: z.string().describe("Existing Task session to continue").optional(),
+    }),
+    async execute(params, ctx) {
+      const agent = await Agent.get(params.subagent_type)
+      if (!agent) throw new Error(`Unknown agent type: ${params.subagent_type} is not a valid agent type`)
+      const session = await iife(async () => {
+        if (params.session_id) {
+          const found = await Session.get(params.session_id).catch(() => {})
+          if (found) return found
+        }
+
+        return await Session.create({
+          parentID: ctx.sessionID,
+          title: params.description + ` (@${agent.name} subagent)`,
+        })
+      })
+      // Try to get parent message for model info, but use defaults if not available
+      let parentModel: { modelID: string; providerID: string } | undefined
+      try {
+        const msg = await MessageV2.get({ sessionID: ctx.sessionID, messageID: ctx.messageID })
+        if (msg.info.role === "assistant") {
+          parentModel = {
+            modelID: msg.info.modelID,
+            providerID: msg.info.providerID,
+          }
+        }
+      } catch (e) {
+        // Parent message not in storage, will use agent model or default
+      }
+
+      ctx.metadata({
+        title: params.description,
+        metadata: {
+          sessionId: session.id,
+        },
+      })
+
+      const messageID = Identifier.ascending("message")
+      const parts: Record<string, MessageV2.ToolPart> = {}
+      const unsub = Bus.subscribe(MessageV2.Event.PartUpdated, async (evt) => {
+        if (evt.properties.part.sessionID !== session.id) return
+        if (evt.properties.part.messageID === messageID) return
+        if (evt.properties.part.type !== "tool") return
+        parts[evt.properties.part.id] = evt.properties.part
+        ctx.metadata({
+          title: params.description,
+          metadata: {
+            summary: Object.values(parts).sort((a, b) => a.id?.localeCompare(b.id)),
+            sessionId: session.id,
+          },
+        })
+      })
+
+      const model = agent.model ?? parentModel ?? {
+        modelID: "grok-code",
+        providerID: "opencode",
+      }
+
+      function cancel() {
+        SessionPrompt.cancel(session.id)
+      }
+      ctx.abort.addEventListener("abort", cancel)
+      using _ = defer(() => ctx.abort.removeEventListener("abort", cancel))
+      const promptParts = await SessionPrompt.resolvePromptParts(params.prompt)
+      const result = await SessionPrompt.prompt({
+        messageID,
+        sessionID: session.id,
+        model: {
+          modelID: model.modelID,
+          providerID: model.providerID,
+        },
+        agent: agent.name,
+        tools: {
+          todowrite: false,
+          todoread: false,
+          task: false,
+          ...agent.tools,
+        },
+        parts: promptParts,
+      })
+      unsub()
+      let all
+      all = await Session.messages({ sessionID: session.id })
+      all = all.filter((x) => x.info.role === "assistant")
+      all = all.flatMap((msg) => msg.parts.filter((x: any) => x.type === "tool") as MessageV2.ToolPart[])
+      const text = result.parts.findLast((x) => x.type === "text")?.text ?? ""
+
+      const output = text + "\n\n" + ["<task_metadata>", `session_id: ${session.id}`, "</task_metadata>"].join("\n")
+
+      return {
+        title: params.description,
+        metadata: {
+          summary: all,
+          sessionId: session.id,
+        },
+        output,
+      }
+    },
+  }
+})

package/src/tool/task.txt

@@ -0,0 +1,60 @@
+Launch a new agent to handle complex, multi-step tasks autonomously.
+
+Available agent types and the tools they have access to:
+{agents}
+
+When using the Task tool, you must specify a subagent_type parameter to select which agent type to use.
+
+When to use the Task tool:
+- When you are instructed to execute custom slash commands. Use the Task tool with the slash command invocation as the entire prompt. The slash command can take arguments. For example: Task(description="Check the file", prompt="/check-file path/to/file.py")
+
+When NOT to use the Task tool:
+- If you want to read a specific file path, use the Read or Glob tool instead of the Task tool, to find the match more quickly
+- If you are searching for a specific class definition like "class Foo", use the Glob tool instead, to find the match more quickly
+- If you are searching for code within a specific file or set of 2-3 files, use the Read tool instead of the Task tool, to find the match more quickly
+- Other tasks that are not related to the agent descriptions above
+
+
+Usage notes:
+1. Launch multiple agents concurrently whenever possible, to maximize performance; to do that, use a single message with multiple tool uses
+2. When the agent is done, it will return a single message back to you. The result returned by the agent is not visible to the user. To show the user the result, you should send a text message back to the user with a concise summary of the result.
+3. Each agent invocation is stateless unless you provide a session_id. Your prompt should contain a highly detailed task description for the agent to perform autonomously and you should specify exactly what information the agent should return back to you in its final and only message to you.
+4. The agent's outputs should generally be trusted
+5. Clearly tell the agent whether you expect it to write code or just to do research (search, file reads, web fetches, etc.), since it is not aware of the user's intent
+6. If the agent description mentions that it should be used proactively, then you should try your best to use it without the user having to ask for it first. Use your judgement.
+
+Example usage (NOTE: The agents below are fictional examples for illustration only - use the actual agents listed above):
+
+<example_agent_descriptions>
+"code-reviewer": use this agent after you are done writing a significant piece of code
+"greeting-responder": use this agent when to respond to user greetings with a friendly joke
+</example_agent_description>
+
+<example>
+user: "Please write a function that checks if a number is prime"
+assistant: Sure let me write a function that checks if a number is prime
+assistant: First let me use the Write tool to write a function that checks if a number is prime
+assistant: I'm going to use the Write tool to write the following code:
+<code>
+function isPrime(n) {
+  if (n <= 1) return false
+  for (let i = 2; i * i <= n; i++) {
+    if (n % i === 0) return false
+  }
+  return true
+}
+</code>
+<commentary>
+Since a significant piece of code was written and the task was completed, now use the code-reviewer agent to review the code
+</commentary>
+assistant: Now let me use the code-reviewer agent to review the code
+assistant: Uses the Task tool to launch the code-reviewer agent
+</example>
+
+<example>
+user: "Hello"
+<commentary>
+Since the user is greeting, use the greeting-responder agent to respond with a friendly joke
+</commentary>
+assistant: "I'm going to use the Task tool to launch the with the greeting-responder agent"
+</example>

package/src/tool/todo.ts

@@ -0,0 +1,39 @@
+import z from "zod"
+import { Tool } from "./tool"
+import DESCRIPTION_WRITE from "./todowrite.txt"
+import { Todo } from "../session/todo"
+
+export const TodoWriteTool = Tool.define("todowrite", {
+  description: DESCRIPTION_WRITE,
+  parameters: z.object({
+    todos: z.array(z.object(Todo.Info.shape)).describe("The updated todo list"),
+  }),
+  async execute(params, opts) {
+    await Todo.update({
+      sessionID: opts.sessionID,
+      todos: params.todos,
+    })
+    return {
+      title: `${params.todos.filter((x) => x.status !== "completed").length} todos`,
+      output: JSON.stringify(params.todos, null, 2),
+      metadata: {
+        todos: params.todos,
+      },
+    }
+  },
+})
+
+export const TodoReadTool = Tool.define("todoread", {
+  description: "Use this tool to read your todo list",
+  parameters: z.object({}),
+  async execute(_params, opts) {
+    const todos = await Todo.get(opts.sessionID)
+    return {
+      title: `${todos.filter((x) => x.status !== "completed").length} todos`,
+      metadata: {
+        todos,
+      },
+      output: JSON.stringify(todos, null, 2),
+    }
+  },
+})

package/src/tool/todoread.txt

@@ -0,0 +1,14 @@
+Use this tool to read the current to-do list for the session. This tool should be used proactively and frequently to ensure that you are aware of
+the status of the current task list. You should make use of this tool as often as possible, especially in the following situations:
+- At the beginning of conversations to see what's pending
+- Before starting new tasks to prioritize work
+- When the user asks about previous tasks or plans
+- Whenever you're uncertain about what to do next
+- After completing tasks to update your understanding of remaining work
+- After every few messages to ensure you're on track
+
+Usage:
+- This tool takes in no parameters. So leave the input blank or empty. DO NOT include a dummy object, placeholder string or a key like "input" or "empty". LEAVE IT BLANK.
+- Returns a list of todo items with their status, priority, and content
+- Use this information to track progress and plan next steps
+- If no todos exist yet, an empty list will be returned