Dropstone Docs

Пользовательские инструменты

Создавайте инструменты, которые LLM может вызывать в dropstone.

Пользовательские инструменты — это функции, которые вы создаёте и которые LLM может вызывать во время разговоров. Они работают вместе со встроенными инструментами Dropstone, такими как read, write и bash.

Создание инструмента

Инструменты определяются как файлы TypeScript или JavaScript. Само определение инструмента — это TS/JS, но работа, которую он выполняет, может быть реализована на любом языке: shell-скрипты, Python, Go, всё, что вы можете запустить из shell-помощников Bun.

Расположение

Их можно определить:

  • Локально, поместив их в директорию .dropstone/tools/ вашего проекта.
  • Или глобально, поместив их в ~/.config/dropstone/tools/.

Структура

Самый простой способ создать инструменты — использовать помощник tool(), который обеспечивает типобезопасность и валидацию.

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

Несколько инструментов в одном файле

Вы также можете экспортировать несколько инструментов из одного файла. Каждый экспорт становится отдельным инструментом с именем <имя_файла>_<имя_экспорта>:

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

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

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

Note:

Предпочитайте уникальные имена, если вы не хотите намеренно заменить встроенный инструмент. Если вы хотите отключить встроенный инструмент, но не переопределять его, используйте разрешения.

Аргументы

Вы можете использовать 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 "@blankline/dropstone-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 "@blankline/dropstone-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, ".dropstone/tools/add.py")
    const result = await Bun.$`python3 ${script} ${args.a} ${args.b}`.text()
    return result.trim()
  },
})

Здесь мы используем утилиту Bun.$ для запуска Python-скрипта.

Ctrl+I