hermes-agent-features/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/tools-reference.md
Teknium 76135b329d
docs(i18n): translate all docs into Simplified Chinese (zh-Hans) (#31942)
Translates the full English docs corpus (335 files) into Simplified
Chinese under website/i18n/zh-Hans/. Combined with PR #31895 (cross-
locale link fix), the 简体中文 locale toggle now serves a complete
Chinese site with working cross-page navigation.

Pipeline:
- Claude Sonnet 4.6 via OpenRouter, 8-way concurrent
- Preserves frontmatter keys, code blocks, MDX/JSX, link URLs, brand
  names, and technical jargon (prompt/token/hook/MCP/ACP/etc.)
- Translates only frontmatter title/description and prose
- Two largest files (configuration.md 93KB, research-paper-writing.md
  107KB) retried with 64K max_tokens after initial fence-drift
- 3 manual post-fixes for MDX edge cases the model didn't escape:
  < in optional-skills-catalog table, double-quotes in an alt= tag,
  and a bare URL adjacent to a full-width period

Cost: ~$30 total (Sonnet 4.6 input $3/M + output $15/M).

Verified `npm run build` succeeds for both en and zh-Hans locales,
no double-prefixed /docs/zh-Hans/docs/ URLs in rendered output,
all in-page navigation resolves correctly.

Translations are machine-generated and may need human review on
specific pages — but they're an enormous improvement over the
previous state (3 zh-Hans pages out of 335).
2026-05-25 01:47:38 -07:00

267 lines
21 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
sidebar_position: 3
title: "内置工具参考"
description: "Hermes 内置工具权威参考,按工具集分组"
---
# 内置工具参考
本页记录 Hermes 的内置工具,按工具集分组。可用性因平台、凭据和已启用的工具集而异。
**当前注册表快速统计:** 约 70 个工具 —— 10 个浏览器工具(核心)+ 2 个 CDP 门控浏览器工具、4 个文件工具、10 个 RL 工具、4 个 Home Assistant 工具、2 个终端工具、2 个 Web 工具、5 个 Feishu 工具、7 个 Spotify 工具(由内置 `spotify` 插件注册、5 个 Yuanbao 工具、7 个 kanban 工具(在 kanban 调度器生成 agent 时注册、2 个 Discord 工具,以及若干独立工具(`memory`、`clarify`、`delegate_task`、`execute_code`、`cronjob`、`session_search`、`skill_view`/`skill_manage`/`skills_list`、`text_to_speech`、`image_generate`、`video_generate`、`vision_analyze`、`video_analyze`、`mixture_of_agents`、`send_message`、`todo`、`computer_use`、`process`)。
:::tip MCP 工具
除内置工具外Hermes 还可从 MCP 服务器动态加载工具。MCP 工具以 `mcp_<server>_` 为前缀(例如,`github` MCP 服务器的 `mcp_github_create_issue`)。配置方法见 [MCP 集成](/user-guide/features/mcp)。
:::
## `browser` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `browser_back` | 在浏览器历史记录中导航回上一页。需先调用 `browser_navigate`。 | — |
| `browser_click` | 点击快照中由 ref ID 标识的元素(如 `@e5`。ref ID 显示在快照输出的方括号中。需先调用 `browser_navigate``browser_snapshot`。 | — |
| `browser_console` | 获取当前页面的浏览器控制台输出和 JavaScript 错误。返回 `console.log`/`warn`/`error`/`info` 消息及未捕获的 JS 异常。用于检测静默 JavaScript 错误、失败的 API 调用和应用警告。需先调用… | — |
| `browser_get_images` | 获取当前页面所有图片的列表,包含 URL 和 alt 文本。可用于查找供 vision 工具分析的图片。需先调用 `browser_navigate`。 | — |
| `browser_navigate` | 在浏览器中导航到某个 URL初始化会话并加载页面。必须在其他浏览器工具之前调用。对于简单信息检索优先使用 `web_search``web_extract`(更快、更省)。当需要… 时使用浏览器工具。 | — |
| `browser_press` | 按下键盘按键。适用于提交表单Enter、导航Tab或键盘快捷键。需先调用 `browser_navigate`。 | — |
| `browser_scroll` | 向某个方向滚动页面。用于显示当前视口上方或下方的更多内容。需先调用 `browser_navigate`。 | — |
| `browser_snapshot` | 获取当前页面无障碍树的文本快照。返回带 ref ID`@e1`、`@e2`)的交互元素,供 `browser_click``browser_type` 使用。`full=false`(默认):仅含交互元素的紧凑视图。`full=true`:完整… | — |
| `browser_type` | 向由 ref ID 标识的输入框中输入文本。先清空字段,再输入新文本。需先调用 `browser_navigate``browser_snapshot`。 | — |
| `browser_vision` | 对当前页面截图并用视觉 AI 分析。当需要直观理解页面内容时使用——尤其适用于 CAPTCHA、视觉验证挑战、复杂布局或文本快照… 时。 | — |
## `browser` 工具集CDP 门控工具)
这两个工具属于 `browser` 工具集,但仅在会话启动时可访问 Chrome DevTools ProtocolCDP端点时才注册——通过 `/browser connect`、`browser.cdp_url` 配置、Browserbase 会话或 Camofox。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `browser_cdp` | 发送原始 Chrome DevTools Protocol 命令。用于高层 `browser_*` 工具未覆盖的浏览器操作的逃生舱口。参见 https://chromedevtools.github.io/devtools-protocol/ | CDP 端点 |
| `browser_dialog` | 响应原生 JavaScript 对话框alert / confirm / prompt / beforeunload。先调用 `browser_snapshot`——待处理的对话框会出现在其 `pending_dialogs` 字段中。然后调用 `browser_dialog(action='accept'\|'dismiss')`。 | CDP 端点 |
## `clarify` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `clarify` | 在需要澄清、反馈或决策时向用户提问。支持两种模式1. **多选** —— 提供最多 4 个选项,用户从中选择或通过第 5 个"其他"选项自行输入。2.… | — |
## `code_execution` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `execute_code` | 运行可以编程方式调用 Hermes 工具的 Python 脚本。当需要 3 次以上工具调用且调用之间有处理逻辑、需要在大型工具输出进入上下文前过滤/压缩、需要条件分支(…)时使用。 | — |
## `cronjob` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `cronjob` | 统一的定时任务管理器。使用 `action="create"`、`"list"`、`"update"`、`"pause"`、`"resume"`、`"run"` 或 `"remove"` 管理任务。支持带一个或多个附加 skill 的 skill 驱动任务,`update` 时 `skills=[]` 可清除已附加的 skill。Cron 任务在无当前聊天上下文的全新会话中运行。 | — |
## `delegation` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `delegate_task` | 生成一个或多个子 agent在隔离上下文中处理任务。每个子 agent 拥有独立的对话、终端会话和工具集。仅返回最终摘要——中间工具结果不会进入你的上下文窗口。两种… | — |
## `feishu_doc` 工具集
仅限飞书文档评论智能回复处理器(`gateway/platforms/feishu_comment.py`)使用。不在 `hermes-cli` 或常规飞书聊天适配器中暴露。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `feishu_doc_read` | 根据 `file_type` 和 token 读取飞书/Lark 文档Docx、Doc 或 Sheet的完整文本内容。 | 飞书应用凭据 |
## `feishu_drive` 工具集
仅限飞书文档评论处理器使用。驱动云盘文件的评论读写操作。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `feishu_drive_add_comment` | 在飞书/Lark 文档或文件上添加顶级评论。 | 飞书应用凭据 |
| `feishu_drive_list_comments` | 列出飞书/Lark 文件的全文档评论,最新的排在最前。 | 飞书应用凭据 |
| `feishu_drive_list_comment_replies` | 列出特定飞书评论线程(全文档或局部选区)的回复。 | 飞书应用凭据 |
| `feishu_drive_reply_comment` | 在飞书评论线程上发布回复,支持可选的 `@` 提及。 | 飞书应用凭据 |
## `file` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `patch` | 对文件进行精准的查找替换编辑。用于替代终端中的 `sed`/`awk`。使用模糊匹配9 种策略),轻微的空白/缩进差异不会导致失败。返回统一差异格式。编辑后自动运行语法检查… | — |
| `read_file` | 带行号和分页功能读取文本文件。用于替代终端中的 `cat`/`head`/`tail`。输出格式:`LINE_NUM\|CONTENT`。找不到文件时建议相似文件名。对大文件使用 `offset``limit`。注意:无法读取图片或… | — |
| `search_files` | 搜索文件内容或按名称查找文件。用于替代终端中的 `grep`/`rg`/`find`/`ls`。基于 Ripgrep比 shell 等效命令更快。内容搜索(`target='content'`):在文件内进行正则搜索。输出模式:带行号的完整匹配… | — |
| `write_file` | 将内容写入文件,完全替换现有内容。用于替代终端中的 `echo`/`cat heredoc`。自动创建父目录。**覆盖整个文件** —— 精准编辑请使用 `patch`。 | — |
## `homeassistant` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `ha_call_service` | 调用 Home Assistant 服务以控制设备。使用 `ha_list_services` 发现各域的可用服务及其参数。 | — |
| `ha_get_state` | 获取单个 Home Assistant 实体的详细状态,包括所有属性(亮度、颜色、温度设定值、传感器读数等)。 | — |
| `ha_list_entities` | 列出 Home Assistant 实体。可按域light、switch、climate、sensor、binary_sensor、cover、fan 等)或区域名称(客厅、厨房、卧室等)过滤。 | — |
| `ha_list_services` | 列出用于设备控制的可用 Home Assistant 服务(动作)。显示每种设备类型可执行的操作及其接受的参数。用于发现如何控制通过 `ha_list_entities` 找到的设备。 | — |
## `computer_use` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `computer_use` | 通过 cua-driver 在后台控制 macOS 桌面——截图SOM / vision / AX、点击 / 拖拽 / 滚动 / 输入 / 按键 / 等待、`list_apps`、`focus_app`。**不会**抢占用户的光标或键盘焦点。适用于任何支持工具的模型。仅限 macOS。 | `cua-driver``$PATH` 中(通过 `hermes tools` 安装)。 |
:::note
**Honcho 工具**`honcho_profile`、`honcho_search`、`honcho_context`、`honcho_reasoning`、`honcho_conclude`)不再是内置工具。它们通过 `plugins/memory/honcho/` 的 Honcho 记忆提供者插件提供。安装和使用方法见 [Memory Providers](../user-guide/features/memory-providers.md)。
:::
## `image_gen` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `image_generate` | 使用 FAL.ai 从文本 prompt提示词生成高质量图片。底层模型由用户配置默认FLUX 2 Klein 9B生成时间低于 1 秒agent 不可选择。返回单个图片 URL。使用… 显示。 | FAL_KEY |
## `kanban` 工具集
在以下情况下注册:(a) agent 由 kanban 调度器生成(设置了 `HERMES_KANBAN_TASK` 环境变量),或 (b) 在显式启用 `kanban` 工具集的 profile 中运行。任务范围的 worker 使用生命周期工具处理其分配的任务;编排器 profile 还额外获得 `kanban_list``kanban_unblock` 等看板路由工具。完整工作流见 [Kanban 多 Agent](/user-guide/features/kanban)。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `kanban_show` | 显示分配给当前 worker 的活跃 kanban 任务(标题、描述、评论、依赖项)。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_list` | 带过滤器列出看板任务。仅限编排器;对调度器生成的任务 worker 隐藏。 | 含 `kanban` 工具集的 profile |
| `kanban_complete` | 用结构化交接载荷(结果、产物、后续事项)将当前任务标记为完成。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_block` | 因需向用户提问而阻塞当前任务——调度器暂停、呈现问题,并在人工回复后恢复。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_heartbeat` | 在长时间运行的操作期间发送进度心跳,让调度器知道 worker 仍在运行。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_comment` | 在不改变任务状态的情况下向任务线程添加评论——适用于呈现中间发现。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_create` | 从当前任务派生子任务。由编排器和生成后续任务的 worker 使用。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_link` | 用父 → 子依赖边链接任务。 | `HERMES_KANBAN_TASK``kanban` 工具集 |
| `kanban_unblock` | 将被阻塞的任务恢复为 `ready` 状态。仅限编排器;对调度器生成的任务 worker 隐藏。 | 含 `kanban` 工具集的 profile |
## `memory` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `memory` | 将重要信息保存到跨会话持久化的记忆中。你的记忆会在会话启动时出现在系统 prompt 中——这是你在对话之间记住用户信息和环境信息的方式。何时保存… | — |
## `messaging` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `send_message` | 向已连接的消息平台发送消息,或列出可用目标。重要:当用户要求发送到特定频道或人员(而非仅平台名称)时,请先调用 `send_message(action='list')` 查看可用目标… | — |
## `moa` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `mixture_of_agents` | 将难题路由给多个前沿 LLM 协作处理。进行 5 次 API 调用4 个参考模型 + 1 个聚合器),以最大推理力度运行——请谨慎用于真正困难的问题。最适合:复杂数学、高级算法… | OPENROUTER_API_KEY |
## `session_search` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `session_search` | 搜索存储在本地会话数据库中的历史会话,或在某个会话内滚动浏览。基于 FTS5 检索;返回数据库中的实际消息(无 LLM 调用)。三种形态:发现(传入 `query`)、滚动(传入 `session_id` + `around_message_id`)、浏览(无参数)。 | — |
## `skills` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `skill_manage` | 管理 skill创建、更新、删除。Skill 是你的程序性记忆——针对重复任务类型的可复用方法。新 skill 保存到 `~/.hermes/skills/`;现有 skill 可在其所在位置修改。操作create完整 SKILL.m… | — |
| `skill_view` | Skill 允许加载特定任务和工作流的信息,以及脚本和模板。加载某个 skill 的完整内容或访问其链接文件(参考资料、模板、脚本)。首次调用返回 SKILL.md 内容及… | — |
| `skills_list` | 列出可用 skill名称 + 描述)。使用 `skill_view(name)` 加载完整内容。 | — |
## `terminal` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `process` | 管理通过 `terminal(background=true)` 启动的后台进程。操作:`list`(显示所有)、`poll`(检查状态 + 新输出)、`log`(带分页的完整输出)、`wait`(阻塞直到完成或超时)、`kill`(终止)、`write`(发送…) | — |
| `terminal` | 在 Linux 环境中执行 shell 命令。文件系统在调用之间持久化。对长时间运行的服务器设置 `background=true`。设置 `notify_on_complete=true`(配合 `background=true`)可在进程完成时自动收到通知——无需轮询。**不要**使用 `cat`/`head`/`tail`——使用 `read_file`。**不要**使用 `grep`/`rg`/`find`——使用 `search_files`。 | — |
## `todo` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `todo` | 管理当前会话的任务列表。适用于包含 3 个以上步骤的复杂任务,或用户提供多个任务时。不带参数调用可读取当前列表。写入:- 提供 `todos` 数组以创建/更新条目 - `merge=`… | — |
## `vision` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `vision_analyze` | 使用 AI 视觉分析图片。在支持视觉的主模型上,将原始图片像素作为多模态工具结果返回,使模型在下一轮能原生看到图片。在纯文本主模型上,回退到辅助视觉模型描述图片并以文本形式返回描述。两种情况下工具签名完全相同。 | — |
## `video` 工具集
可选工具集(默认 `hermes-cli` 集中不加载)。通过 `--toolsets video` 添加,或在 `toolsets:` 配置中包含 `video`
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `video_analyze` | 分析来自 URL 或文件路径的视频内容——字幕、场景分解、关键时间戳和视觉描述。 | — |
## `video_gen` 工具集
可选工具集(默认 `hermes-cli` 集中不加载)。通过 `--toolsets video_gen` 添加,或在 `hermes tools` → Video Generation 中启用(同时引导你选择后端)。
后端以插件形式存放于 `plugins/video_gen/<name>/`
- **xAI Grok-Imagine** —— 文本生成视频和图片生成视频SuperGrok OAuth 或 `XAI_API_KEY`)。
- **FAL.ai** —— Veo 3.1、Pixverse v6、Kling O3需要 `FAL_KEY`)。
单个 `video_generate` 工具涵盖两种模态——传入 `image_url` 可为静态图片制作动画,省略则从文本生成。活跃后端自动路由到正确的端点。工具描述在会话启动时重建,以反映活跃后端的实际能力(模态、宽高比、分辨率、时长范围、最大参考图片数、音频支持)。后端开发见 [视频生成提供者插件](/developer-guide/video-gen-provider-plugin)。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `video_generate` | 使用用户配置的视频生成后端,从文本 prompt 生成视频(文本生成视频)或为静态图片制作动画(图片生成视频)。传入 `image_url` 可为该图片制作动画;省略则从文本生成。后端自动路由到正确端点。在 `video` 字段中返回 HTTP URL 或绝对文件路径。 | 活跃的 `video_gen` 插件 + 其凭据(如 `XAI_API_KEY`、`FAL_KEY` |
## `web` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `web_search` | 在网络上搜索信息。默认返回最多 5 条结果包含标题、URL 和描述。接受可选的 `limit`1-100默认 5。查询直接传递给配置的后端因此当后端支持时`site:domain`、`filetype:pdf`、`intitle:word`、`-term`、`"exact phrase"` 等运算符可能有效。 | EXA_API_KEY 或 PARALLEL_API_KEY 或 FIRECRAWL_API_KEY 或 TAVILY_API_KEY |
| `web_extract` | 从网页 URL 提取内容。以 Markdown 格式返回页面内容。也支持 PDF URL——直接传入 PDF 链接即可转换为 Markdown 文本。5000 字符以下的页面返回完整 Markdown更大的页面由 LLM 摘要处理。 | EXA_API_KEY 或 PARALLEL_API_KEY 或 FIRECRAWL_API_KEY 或 TAVILY_API_KEY |
## `x_search` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `x_search` | 使用 xAI 内置的 `x_search` Responses 工具搜索 XTwitter帖子、主页和话题串。用于获取 X 上的当前讨论、反应或观点,而非通用网页。默认关闭——通过 `hermes tools` → 🐦 X (Twitter) Search 选择启用。仅在配置了 xAI 凭据时注册 schemacheck_fn 门控)。 | XAI_API_KEY **或** xAI Grok OAuthSuperGrok / Premium+)登录 |
## `tts` 工具集
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `text_to_speech` | 将文本转换为语音音频。返回平台以语音消息形式传递的 `MEDIA:` 路径。在 Telegram 上以语音气泡播放,在 Discord/WhatsApp 上作为音频附件。在 CLI 模式下保存到 `~/voice-memos/`。语音和提供者… | — |
## `discord` 工具集
`hermes-discord` 平台工具集(仅 gateway上注册。使用与消息适配器相同的 bot token。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `discord` | 读取并参与 Discord 服务器。操作包括 `search_members`、`fetch_messages`、`send_message`、`react`、`fetch_channel`、`list_channels` 等。 | `DISCORD_BOT_TOKEN` |
## `discord_admin` 工具集
`hermes-discord` 平台工具集上注册。审核操作需要 bot 持有相应的 Discord 权限。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `discord_admin` | 通过 REST API 管理 Discord 服务器:列出 guild/频道/角色,创建/编辑/删除频道,管理角色授予、禁言、踢出和封禁。 | `DISCORD_BOT_TOKEN` + bot 权限 |
## `spotify` 工具集
由内置 `spotify` 插件注册。需要 OAuth token——运行一次 `hermes spotify setup` 进行授权。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `spotify_playback` | 控制 Spotify 播放、查看当前播放状态或获取最近播放的曲目。 | Spotify OAuth |
| `spotify_devices` | 列出 Spotify Connect 设备或将播放转移到其他设备。 | Spotify OAuth |
| `spotify_queue` | 查看用户的 Spotify 队列或向其添加项目。 | Spotify OAuth |
| `spotify_search` | 在 Spotify 目录中搜索曲目、专辑、艺术家、播放列表、节目或单集。 | Spotify OAuth |
| `spotify_playlists` | 列出、查看、创建、更新和修改 Spotify 播放列表。 | Spotify OAuth |
| `spotify_albums` | 获取 Spotify 专辑元数据或专辑曲目。 | Spotify OAuth |
| `spotify_library` | 列出、保存或移除用户已保存的 Spotify 曲目或专辑。 | Spotify OAuth |
## `hermes-yuanbao` 工具集
仅在 `hermes-yuanbao` 平台工具集上注册。元宝是腾讯的聊天应用;这些工具驱动其私信/群组/表情包 API。
| 工具 | 描述 | 所需环境 |
|------|------|----------|
| `yb_query_group_info` | 查询群组(应用内称为"派/Pai")的基本信息:名称、群主、成员数。 | 元宝凭据 |
| `yb_query_group_members` | 查询群组成员(用于 `@` 提及、按名称查找用户、列出机器人)。 | 元宝凭据 |
| `yb_send_dm` | 向群组中的用户发送私信,支持可选的媒体文件。 | 元宝凭据 |
| `yb_search_sticker` | 按关键词搜索元宝内置表情TIM 表情)目录。 | 元宝凭据 |
| `yb_send_sticker` | 向当前元宝聊天发送内置表情。 | 元宝凭据 |