跳转到内容
OpenCode
HomeDocs

工具 Tools

管理 LLM 可以使用的工具。

工具允许 LLM 在你的代码库中执行操作。OpenCode 带有一组内置工具，但你可以通过 自定义工具 或 MCP 服务器 进行扩展。

默认情况下，所有工具都是 启用 的，运行不需要权限。你可以通过 权限 控制工具行为。

配置 Configure

使用 permission 字段控制工具行为。你可以允许、拒绝或要求批准每个工具。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "edit": "deny",
    "bash": "ask",
    "webfetch": "allow"
  }
}

你也可以使用通配符同时控制多个工具。例如，要要求批准来自 MCP 服务器的所有工具：

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "mymcp_*": "ask"
  }
}

了解更多 关于配置权限的信息。

内置 Built-in

以下是 OpenCode 中所有可用的内置工具。

bash

在你的项目环境中执行 shell 命令。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "bash": "allow"
  }
}

此工具允许 LLM 运行终端命令，如 npm install、git status 或任何其他 shell 命令。

edit

使用精确字符串替换修改现有文件。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "edit": "allow"
  }
}

此工具通过替换精确的文本匹配来执行精确的文件编辑。这是 LLM 修改代码的主要方式。

write

创建新文件或覆盖现有文件。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "edit": "allow"
  }
}

使用此工具允许 LLM 创建新文件。如果文件已存在，它将覆盖现有文件。

read

从代码库中读取文件内容。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "read": "allow"
  }
}

此工具读取文件并返回其内容。它支持读取大文件的特定行范围。

grep

使用正则表达式搜索文件内容。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "grep": "allow"
  }
}

在代码库中进行快速内容搜索。支持完整的正则表达式语法和文件模式过滤。

glob

通过模式匹配查找文件。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "glob": "allow"
  }
}

使用 glob 模式（如 **/*.js 或 src/**/*.ts）搜索文件。返回按修改时间排序的匹配文件路径。

list

列出给定路径中的文件和目录。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "list": "allow"
  }
}

此工具列出目录内容。它接受 glob 模式来过滤结果。

lsp (实验性)

与配置的 LSP 服务器交互，以获取代码智能功能，如定义、引用、悬停信息和调用层次结构。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "lsp": "allow"
  }
}

支持的操作包括 goToDefinition、findReferences、hover、documentSymbol、workspaceSymbol、goToImplementation、prepareCallHierarchy、incomingCalls 和 outgoingCalls。

要为你的项目配置可用的 LSP 服务器，请参阅 LSP 服务器。

patch

将补丁应用于文件。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "edit": "allow"
  }
}

此工具将补丁文件应用于你的代码库。用于应用来自各种来源的 diff 和补丁。

skill

加载 技能（即 SKILL.md 文件）并在对话中返回其内容。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "skill": "allow"
  }
}

todowrite

在编码会话期间管理待办事项列表。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "todowrite": "allow"
  }
}

创建和更新任务列表以跟踪复杂操作期间的进度。LLM 使用此工具来组织多步骤任务。

todoread

读取现有的待办事项列表。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "todoread": "allow"
  }
}

读取当前待办事项列表状态。LLM 使用此工具来跟踪哪些任务待处理或已完成。

webfetch

获取 Web 内容。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "webfetch": "allow"
  }
}

允许 LLM 获取和读取网页。对于查阅文档或研究在线资源非常有用。

question

在执行期间向用户提问。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "question": "allow"
  }
}

此工具允许 LLM 在任务期间向用户提问。这对于以下情况很有用：

  • 收集用户偏好或需求
  • 澄清模棱两可的指示
  • 获取关于实现选择的决定
  • 提供关于采取什么方向的选择

每个问题包括标题、问题文本和选项列表。用户可以从提供的选项中选择或键入自定义答案。当有多个问题时，用户可以在提交所有答案之前在它们之间导航。

自定义工具 Custom tools

自定义工具允许你定义 LLM 可以调用的自己的函数。这些在你的配置文件中定义，并且可以执行任意代码。

了解更多 关于创建自定义工具的信息。

MCP 服务器 MCP servers

MCP (Model Context Protocol) 服务器允许你集成外部工具和服务。这包括数据库访问、API 集成和第三方服务。

了解更多 关于配置 MCP 服务器的信息。

内部原理 Internals

在内部，像 grep、glob 和 list 这样的工具底层使用 ripgrep。默认情况下，ripgrep 遵循 .gitignore 模式，这意味着 .gitignore 中列出的文件和目录将从搜索和列表中排除。

忽略模式 Ignore patterns

要包含通常会被忽略的文件，请在项目根目录中创建一个 .ignore 文件。此文件可以显式允许某些路径。

.ignore
!node_modules/
!dist/
!build/

例如，此 .ignore 文件允许 ripgrep 在 node_modules/、dist/ 和 build/ 目录中搜索，即便是它们已列在 .gitignore 中。