自定义工具

在 opencode 中创建 LLM 可调用的工具。

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

创建工具

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

位置

它们可以这样定义：

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

结构

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

.opencode/tools/database.ts

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

.opencode/tools/math.ts

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

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

与内置工具的名称冲突

自定义工具以工具名作为键。如果某个自定义工具与内置工具同名，则自定义工具优先。

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

.opencode/tools/bash.ts

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 (opens in a new tab)）来定义参数类型。

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

你也可以直接导入 Zod (opens in a new tab) 并返回一个普通对象：

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

上下文

工具会收到关于当前会话的上下文：

.opencode/tools/project.ts

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

.opencode/tools/add.py

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

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

.opencode/tools/python-add.ts

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.$ (opens in a new tab) 工具来运行 Python 脚本。

Agent 技能 SDK