跳转到内容
展示 生态 源码解读 文档

工具

工具

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

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

配置

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

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

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

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

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

内置工具

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

bash

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

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

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

edit

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

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

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

write

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

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

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

read

从你的代码库读取文件内容。

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

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

grep

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

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

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

glob

按模式匹配查找文件。

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

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

lsp（实验性）

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

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

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

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

apply_patch

将补丁应用到文件。

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

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

处理 tool.execute.before 或 tool.execute.after 钩子时，检查 input.tool === "apply_patch"（不是 "patch"）。

apply_patch 使用 output.args.patchText 而不是 output.args.filePath。路径嵌入在 patchText 中的标记行中，相对于项目根目录（例如：*** Add File: src/new-file.ts、*** Update File: src/existing.ts、*** Move to: src/renamed.ts、*** Delete File: src/obsolete.ts）。

skill

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

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

todowrite

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

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

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

webfetch

获取网络内容。

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

允许 LLM 获取和读取网页。用于查找文档或研究在线资源。

websearch

在网上搜索信息。

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

使用 Exa AI 执行网络搜索以在线查找相关信息。用于研究主题、查找时事或收集超出训练数据截止日期的信息。

无需 API 密钥 — 该工具直接连接到 Exa AI 的托管 MCP 服务，无需身份验证。

question

在执行期间向用户提问。

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

此工具允许 LLM 在任务期间向用户提问。它用于：

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

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

自定义工具

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

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

MCP 服务器

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

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

内部

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

忽略模式

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

!node_modules/
!dist/
!build/

例如，这个 .ignore 文件允许 ripgrep 搜索 node_modules/、dist/ 和 build/ 目录，即使它们在 .gitignore 中列出。