自定义工具

自定义工具是你创建的函数，LLM 可以在对话期间调用它们。它们与 OpenCode 的 内置工具（如 read, write 和 bash）协同工作。

---

创建工具

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

---

位置

工具可以定义在：

• 本地：放置在你项目的 .opencode/tool/ 目录中。
• 全局：放置在 ~/.config/opencode/tool/ 中。

---

结构

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

.opencode/tool/database.ts

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

export default tool({
  description: "查询项目数据库",
  args: {
    query: tool.schema.string().describe("要执行的 SQL 查询"),
  },
  async execute(args) {
    // 在此处编写你的数据库逻辑
    return `Executed query: ${args.query}`
  },
})

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

---

每个文件多个工具

你也可以从单个文件中导出多个工具。每个导出都将成为一个 独立的工具，名称格式为 <文件名>_<导出名>：

.opencode/tool/math.ts

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

export const add = tool({
  description: "两个数字相加",
  args: {
    a: tool.schema.number().describe("第一个数字"),
    b: tool.schema.number().describe("第二个数字"),
  },
  async execute(args) {
    return args.a + args.b
  },
})

export const multiply = tool({
  description: "两个数字相乘",
  args: {
    a: tool.schema.number().describe("第一个数字"),
    b: tool.schema.number().describe("第二个数字"),
  },
  async execute(args) {
    return args.a * args.b
  },
})

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

---

参数

定义工具接受的参数。

args: {
  query: tool.schema.string().describe("要执行的 SQL 查询")
}

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

import { z } from "zod"

export default {
  description: "工具描述",
  args: {
    param: z.string().describe("参数描述"),
  },
  async execute(args: { param: string }) {
    // ...
  },
}

---

上下文

你可以配置工具可以访问的上下文。

.opencode/tool/project.ts

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

export default tool({
  description: "获取项目信息",
  args: {},
  async execute(args, context) {
    // 访问上下文信息
    const { agent, sessionID, messageID } = context
    return `Agent: ${agent}, Session: ${sessionID}, Message: ${messageID}`
  },
})

---

示例

使用 Python 编写工具

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

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

.opencode/tool/add.py

import sys

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

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

.opencode/tool/python-add.ts

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

export default tool({
  description: "使用 Python 进行两个数字相加",
  args: {
    a: tool.schema.number().describe("第一个数字"),
    b: tool.schema.number().describe("第二个数字"),
  },
  async execute(args) {
    const result = await Bun.$`python3 .opencode/tool/add.py ${args.a} ${args.b}`.text()
    return result.trim()
  },
})

这里我们使用了 Bun.$ 实用程序来运行 Python 脚本。