自定义工具

自定义工具是你创建的一些函数，LLM 可以在对话期间调用它们。它们与 opencode 的内置工具（如 read、write 和 bash）配合使用。

创建一个工具

工具以 TypeScript 或 JavaScript 文件的形式定义。但是，工具定义可以调用任何语言编写的脚本——TypeScript 或 JavaScript 仅用于工具定义本身。

位置

可以通过以下方式定义工具：

在项目的 .opencode/tools/ 目录中本地定义。
或者全局定义在 ~/.config/opencode/tools/ 中。

结构

创建工具最简单的方式是使用 tool() 辅助函数，它提供类型安全和参数校验。

import { tool } from "@opencode-ai/plugin"

export default tool({
  description: "Query the project database",
  args: {
    query: tool.schema.string().describe("SQL query to execute"),
  },
  async execute(args) {
    // Your database logic here
    return `Executed query: ${args.query}`
  },
})

文件名会成为工具名称。上面的代码会创建一个 database 工具。

单文件多个工具

你也可以从单个文件导出多个工具。每个导出会成为一个独立的工具，名称为 <filename>_<exportname>：

import { tool } from "@opencode-ai/plugin"

export const add = tool({
  description: "Add two numbers",
  args: {
    a: tool.schema.number().describe("First number"),
    b: tool.schema.number().describe("Second number"),
  },
  async execute(args) {
    return (args.a + args.b).toString()
  },
})

export const multiply = tool({
  description: "Multiply two numbers",
  args: {
    a: tool.schema.number().describe("First number"),
    b: tool.schema.number().describe("Second number"),
  },
  async execute(args) {
    return (args.a * args.b).toString()
  },
})

这会创建两个工具：math_add 和 math_multiply。

与内置工具的名称冲突

自定义工具按工具名称进行键控。如果某个自定义工具与内置工具同名，自定义工具会优先生效。

例如，下面这个文件会替换内置的 bash 工具：

import { tool } from "@opencode-ai/plugin"

export default tool({
  description: "Restricted bash wrapper",
  args: {
    command: tool.schema.string(),
  },
  async execute(args) {
    return `blocked: ${args.command}`
  },
})

参数

你可以使用 tool.schema（其实就是 Zod）来定义参数类型。

args: {
  query: tool.schema.string().describe("SQL query to execute")
}

你也可以直接导入 Zod 并返回一个普通对象：

import { z } from "zod"

export default {
  description: "Tool description",
  args: {
    param: z.string().describe("Parameter description"),
  },
  async execute(args, context) {
    // Tool implementation
    return "result"
  },
}

上下文

工具可以接收关于当前会话的上下文：

import { tool } from "@opencode-ai/plugin"

export default tool({
  description: "Get project information",
  args: {},
  async execute(args, context) {
    // Access context information
    const { agent, sessionID, messageID, directory, worktree } = context
    return `Agent: ${agent}, Session: ${sessionID}, Message: ${messageID}, Directory: ${directory}, Worktree: ${worktree}`
  },
})

使用 context.directory 来获取会话的工作目录。使用 context.worktree 来获取 git worktree 的根目录。

示例

用 Python 编写一个工具

你可以使用任何你喜欢的语言来编写工具。下面是一个使用 Python 实现两数相加的示例。

首先，将工具创建为一个 Python 脚本：

import sys

a = int(sys.argv[1])
b = int(sys.argv[2])
print(a + b)

然后创建调用它的工具定义：

import { tool } from "@opencode-ai/plugin"
import path from "path"

export default tool({
  description: "Add two numbers using Python",
  args: {
    a: tool.schema.number().describe("First number"),
    b: tool.schema.number().describe("Second number"),
  },
  async execute(args, context) {
    const script = path.join(context.worktree, ".opencode/tools/add.py")
    const result = await Bun.$`python3 ${script} ${args.a} ${args.b}`.text()
    return result.trim()
  },
})

这里我们使用 Bun.$ 工具来运行 Python 脚本。