Dropstone Docs

自定义工具

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

自定义工具是你创建的函数，LLM 可以在对话过程中调用它们。它们与 Dropstone 的内置工具（如 read、write 和 bash）一起工作。

创建工具

工具定义为 TypeScript 或 JavaScript 文件。工具定义本身是 TS/JS，但它执行的工作可以用任何语言实现：shell 脚本、Python、Go，任何你可以从 Bun 的 shell 助手生成的东西。

位置

它们可以定义在：

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

结构

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

import { tool } from "@blankline/dropstone-plugin"

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

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

每个文件多个工具

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

import { tool } from "@blankline/dropstone-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。

与内置工具的名称冲突

自定义工具由工具名称键入。如果自定义工具使用与内置工具相同的名称，自定义工具优先。

例如，此文件替换内置的 bash 工具：

import { tool } from "@blankline/dropstone-plugin"

export default tool({
  description: "受限的 bash 包装器",
  args: {
    command: tool.schema.string(),
  },
  async execute(args) {
    return `已阻止: ${args.command}`
  },
})

Note:

除非你有意要替换内置工具，否则优先使用唯一名称。如果你想禁用内置工具但不覆盖它，请使用权限。

参数

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

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

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

import { z } from "zod"

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

上下文

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

import { tool } from "@blankline/dropstone-plugin"

export default tool({
  description: "获取项目信息",
  args: {},
  async execute(args, context) {
    // 访问上下文信息
    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 "@blankline/dropstone-plugin"
import path from "path"

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

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

Ctrl+I