Narzędzia specjalistyczne

Twórz narzędzi, które LLM mogą być uruchamiane w otwartym kodzie.

Narzędzia stosowane do funkcji, z których LLM może korzystać podczas rozmów. Współpracują z [wbudowanymi narzędziami] (./tools) opencode, wtyczka jak read, write i bash.

Narzędzie do tworzenia

Narzędzia tworzą pliki TypeScript lub JavaScript. Definicja narzędzia może być odwoływana do skryptów napisanych w dowolnym języku — TypeScript lub JavaScript są używane tylko w tym samym narzędziu.

Lokalizacja

Można je uruchomić:

Lokalnie, umieszczając je w katalogu .opencode/tools/ swojego projektu.
Lub globalnie, umieszczając je w ~/.config/opencode/tools/.

Struktura

Najłatwiejszym sposobem tworzenia narzędzia jest pomocnika tool(), który zapewnia bezpieczeństwo i sprawdzanie poprawności.

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

Nazwa pliku staje się nazwą narzędzia. Pierwotne narzędzie database.

Wiele narzędzi na plik

Można także eksportować wiele narzędzi z jednego pliku. Każdy eksport staje się oddzielnym językiem o nazwie <filename>_<exportname>:

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

Tworzy do dwóch narzędzi: math_add i math_multiply.

Argumentacja

Do zdefiniowania argumentów można zastosować tool.schema, czyli po prostu Zod.

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

Można także bezpośrednio zaimportować Zod i zwyczajowo zwykły obiekt:

import { z } from "zod"

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

Kontekst

Narzędzia kontekstowe charakterystycznej sesji:

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 jako katalogowy pracodawczy. context.worktree dla katalogu głównego zwalczającego git.

Przykład

Napisz narzędzie w Pythonie

Napisz swoje narzędzie w języku angielskim. Oto przykład dodania dwóch liczb przy użyciu języka Python.

Fragment utworu jako skrypt w języku Python:

import sys

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

Utwór instrumentalny, który jest ukryty:

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

Tutaj istnieje narzędzie Bun.$ uruchamiające skryptu w języku Python.