自定义工具 - OpenCode Docs

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

##创建工具

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

###位置

它们可以定义在：

本地，通过将它们放置在项目的 .opencode/tools/ 目录中。
或者全局，通过将它们放置在 ~/.config/opencode/tools/ 中。

###结构

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

bash

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>：

bash

  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
  },
})

  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
  },
})

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

###参数

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

bash

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

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

bash

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

###上下文

工具接收有关当前会话的上下文：

bash

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

##示例

###用 Python 编写工具

您可以使用任何语言编写工具。这是一个使用 Python 添加两个数字的示例。

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

bash

import sys

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

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

bash

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) {
    const result = await Bun.$`python3 .opencode/tools/add.py ${args.a} ${args.b}`.text()
    return result.trim()
  },
})

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