Herramientas personalizadas

Crea herramientas que el LLM puede invocar en opencode.

Las herramientas personalizadas son funciones que creas y que el LLM puede invocar durante las conversaciones. Funcionan junto con las herramientas integradas de opencode como read, write y bash.

Crear una herramienta

Las herramientas se definen como archivos TypeScript o JavaScript. Sin embargo, la definición de la herramienta puede invocar scripts escritos en cualquier lenguaje; TypeScript o JavaScript solo se usa para la definición de la herramienta en sí.

Ubicación

Se pueden definir:

• Localmente, colocándolas en el directorio .opencode/tools/ de tu proyecto.
• O globalmente, colocándolas en ~/.config/opencode/tools/ .

Estructura

La forma más fácil de crear herramientas es usando el helper tool(), que proporciona seguridad de tipos y validación.

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

El nombre del archivo se convierte en el nombre de la herramienta. El ejemplo anterior crea una herramienta database.

Múltiples herramientas por archivo

También puedes exportar múltiples herramientas desde un solo archivo. Cada exportación se convierte en una herramienta separada con el nombre <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
  },
})

Esto crea dos herramientas: math_add y math_multiply.

Colisiones de nombres con herramientas integradas

Las herramientas personalizadas se identifican por su nombre. Si una herramienta personalizada usa el mismo nombre que una herramienta integrada, la herramienta personalizada tiene prioridad.

Por ejemplo, este archivo reemplaza la herramienta integrada bash:

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

Nota: Prefiere nombres únicos a menos que intencionalmente quieras reemplazar una herramienta integrada. Si quieres deshabilitar una herramienta integrada pero no anularla, usa permisos.

Argumentos

Puedes usar tool.schema, que es simplemente Zod (opens in a new tab), para definir los tipos de los argumentos.

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

También puedes importar Zod (opens in a new tab) directamente y devolver un objeto plano:

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

Contexto

Las herramientas reciben contexto sobre la sesión actual:

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

Usa context.directory para el directorio de trabajo de la sesión. Usa context.worktree para la raíz del worktree de git.

Ejemplos

Escribir una herramienta en Python

Puedes escribir tus herramientas en el lenguaje que quieras. Aquí tienes un ejemplo que suma dos números usando Python.

Primero, crea la herramienta como un script de Python:

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

Luego crea la definición de la herramienta que lo invoca:

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

Aquí estamos usando la utilidad Bun.$ (opens in a new tab) para ejecutar el script de Python.