docs: improve zh-cn and zh-tw documentation translations (#13942)
This commit is contained in:
@@ -1,30 +1,30 @@
|
||||
---
|
||||
title: 自定义工具
|
||||
description: 创建 LLM 可以在 opencode 中调用的工具。
|
||||
description: 创建 LLM 可在 opencode 中调用的工具。
|
||||
---
|
||||
|
||||
自定义工具是您创建的函数,LLM 可以在对话期间调用。它们与 opencode 的 [Built-in Tools](/docs/tools) 一起工作,例如 `read`、`write` 和 `bash`。
|
||||
自定义工具是你创建的函数,LLM 可以在对话过程中调用它们。它们与 opencode 的[内置工具](/docs/tools)(如 `read`、`write` 和 `bash`)协同工作。
|
||||
|
||||
---
|
||||
|
||||
## 创建工具
|
||||
|
||||
工具定义为 **TypeScript** 或 **JavaScript** 文件。但是,工具定义调用可以使用 **任何语言** 编写的脚本 - TypeScript 或 JavaScript 仅用于工具定义本身。
|
||||
工具以 **TypeScript** 或 **JavaScript** 文件的形式定义。不过,工具定义可以调用**任何语言**编写的脚本——TypeScript 或 JavaScript 仅用于工具定义本身。
|
||||
|
||||
---
|
||||
|
||||
### 位置
|
||||
|
||||
它们可以定义为:
|
||||
工具可以在以下位置定义:
|
||||
|
||||
- 通过将它们放在项目的 `.opencode/tools/` 目录中来本地进行。
|
||||
- 或者在全局范围内,将它们放在 `~/.config/opencode/tools/` 中。
|
||||
- 本地定义:将工具文件放在项目的 `.opencode/tools/` 目录中。
|
||||
- 全局定义:将工具文件放在 `~/.config/opencode/tools/` 中。
|
||||
|
||||
---
|
||||
|
||||
### 结构
|
||||
|
||||
创建工具最简单的方法是使用 `tool()` 帮助程序,它提供类型安全和验证。
|
||||
创建工具最简单的方式是使用 `tool()` 辅助函数,它提供类型安全和参数校验。
|
||||
|
||||
```ts title=".opencode/tools/database.ts" {1}
|
||||
import { tool } from "@opencode-ai/plugin"
|
||||
@@ -41,13 +41,13 @@ export default tool({
|
||||
})
|
||||
```
|
||||
|
||||
**文件名** 成为 **工具名称**。以上创建了一个 `database` 工具。
|
||||
**文件名**即为**工具名称**。上面的示例创建了一个名为 `database` 的工具。
|
||||
|
||||
---
|
||||
|
||||
#### 每个文件多个工具
|
||||
#### 单文件多工具
|
||||
|
||||
您还可以从单个文件导出多个工具。每个导出都会成为 **一个单独的工具**,名称为 **`<filename>_<exportname>`**:
|
||||
你也可以从单个文件中导出多个工具。每个导出都会成为**一个独立的工具**,命名格式为 **`<filename>_<exportname>`**:
|
||||
|
||||
```ts title=".opencode/tools/math.ts"
|
||||
import { tool } from "@opencode-ai/plugin"
|
||||
@@ -75,13 +75,13 @@ export const multiply = tool({
|
||||
})
|
||||
```
|
||||
|
||||
这将创建两个工具:`math_add` 和 `math_multiply`。
|
||||
这会创建两个工具:`math_add` 和 `math_multiply`。
|
||||
|
||||
---
|
||||
|
||||
### 参数
|
||||
|
||||
您可以使用 `tool.schema`(即 [Zod](https://zod.dev))来定义参数类型。
|
||||
你可以使用 `tool.schema`(即 [Zod](https://zod.dev))来定义参数类型。
|
||||
|
||||
```ts "tool.schema"
|
||||
args: {
|
||||
@@ -89,7 +89,7 @@ args: {
|
||||
}
|
||||
```
|
||||
|
||||
您还可以直接导入 [Zod](https://zod.dev) 并返回一个普通对象:
|
||||
你也可以直接导入 [Zod](https://zod.dev) 并返回一个普通对象:
|
||||
|
||||
```ts {6}
|
||||
import { z } from "zod"
|
||||
@@ -110,7 +110,7 @@ export default {
|
||||
|
||||
### 上下文
|
||||
|
||||
工具接收有关当前会话的上下文:
|
||||
工具会接收当前会话的上下文信息:
|
||||
|
||||
```ts title=".opencode/tools/project.ts" {8}
|
||||
import { tool } from "@opencode-ai/plugin"
|
||||
@@ -126,18 +126,18 @@ export default tool({
|
||||
})
|
||||
```
|
||||
|
||||
使用 `context.directory` 作为会话工作目录。
|
||||
使用 `context.worktree` 作为 git 工作树根。
|
||||
使用 `context.directory` 获取会话的工作目录。
|
||||
使用 `context.worktree` 获取 git worktree 根目录。
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
### 使用 Python 编写工具
|
||||
### 用 Python 编写工具
|
||||
|
||||
您可以使用任何您想要的语言编写工具。下面是一个使用 Python 将两个数字相加的示例。
|
||||
你可以使用任何语言编写工具。以下示例展示了如何用 Python 实现两数相加。
|
||||
|
||||
首先,使用创建 Python 脚本的工具:
|
||||
首先,创建一个 Python 脚本作为工具:
|
||||
|
||||
```python title=".opencode/tools/add.py"
|
||||
import sys
|
||||
@@ -147,7 +147,7 @@ b = int(sys.argv[2])
|
||||
print(a + b)
|
||||
```
|
||||
|
||||
然后创建调用它的工具定义:
|
||||
然后创建调用该脚本的工具定义:
|
||||
|
||||
```ts title=".opencode/tools/python-add.ts" {10}
|
||||
import { tool } from "@opencode-ai/plugin"
|
||||
@@ -167,4 +167,4 @@ export default tool({
|
||||
})
|
||||
```
|
||||
|
||||
这里我们使用 [`Bun.$`](https://bun.com/docs/runtime/shell) 实用程序来运行 Python 脚本。
|
||||
这里我们使用 [`Bun.$`](https://bun.com/docs/runtime/shell) 工具函数来运行 Python 脚本。
|
||||
|
||||
Reference in New Issue
Block a user