hermes教程-工具运行时

工具注册模型

每个工具模块在导入时调用 registry.register(...)。

model_tools.py 负责导入/发现工具模块并构建模型使用的 schema 列表。

`registry.register()` 的工作原理

tools/ 中的每个工具文件都在模块级别调用 registry.register() 来声明自身。函数签名如下：

python

registry.register(
    name="terminal",               # 唯一工具名称（用于 API schema）
    toolset="terminal",            # 该工具所属的工具集
    schema={...},                  # OpenAI 函数调用 schema（描述、参数）
    handler=handle_terminal,       # 工具被调用时执行的函数
    check_fn=check_terminal,       # 可选：返回 True/False 表示可用性
    requires_env=["SOME_VAR"],     # 可选：所需的环境变量（用于 UI 显示）
    is_async=False,                # handler 是否为异步协程
    description="Run commands",    # 人类可读的描述
    emoji="💻",                    # 用于 spinner/进度显示的 emoji
)

每次调用都会创建一个 ToolEntry，存储在单例 ToolRegistry._tools 字典中，以工具名称为键。如果跨工具集发生名称冲突，会记录警告，后注册的覆盖先注册的。

发现：`discover_builtin_tools()`

当导入 model_tools.py 时，它会调用 tools/registry.py 中的 discover_builtin_tools()。该函数使用 AST 解析扫描每个 tools/*.py 文件，查找包含顶层 registry.register() 调用的模块，然后导入它们：

python

## tools/registry.py（简化版）
def discover_builtin_tools(tools_dir=None):
    tools_path = Path(tools_dir) if tools_dir else Path(__file__).parent
    for path in sorted(tools_path.glob("*.py")):
        if path.name in {"__init__.py", "registry.py", "mcp_tool.py"}:
            continue
        if _module_registers_tools(path):  # AST 检查顶层 registry.register()
            importlib.import_module(f"tools.{path.stem}")

这种自动发现意味着新的工具文件会被自动识别——无需手动维护列表。AST 检查仅匹配顶层的 registry.register() 调用（不匹配函数内部的调用），因此 tools/ 中的辅助模块不会被导入。

每次导入都会触发模块的 registry.register() 调用。可选工具中的错误（例如，图像生成缺少 fal_client）会被捕获并记录——它们不会阻止其他工具的加载。

核心工具发现之后，还会发现 MCP 工具和插件工具：

MCP 工具 — tools.mcp_tool.discover_mcp_tools() 读取 MCP 服务器配置并从外部服务器注册工具。
插件工具 — hermes_cli.plugins.discover_plugins() 加载用户/项目/pip 插件，这些插件可能注册额外的工具。

工具可用性检查（`check_fn`）

每个工具可以选择提供一个 check_fn——一个可调用对象，当工具可用时返回 True，否则返回 False。典型的检查包括：

API 密钥存在 — 例如，lambda: bool(os.environ.get("SERP_API_KEY")) 用于网络搜索
服务运行中 — 例如，检查 Honcho 服务器是否已配置
二进制文件已安装 — 例如，验证 playwright 是否可用于浏览器工具

当 registry.get_definitions() 为模型构建 schema 列表时，它会运行每个工具的 check_fn()：

python

## 从 registry.py 简化
if entry.check_fn:
    try:
        available = bool(entry.check_fn())
    except Exception:
        available = False   # 异常 = 不可用
    if not available:
        continue            # 完全跳过此工具

关键行为：

检查结果每次调用都会缓存——如果多个工具共享同一个 check_fn，它只会运行一次。
check_fn() 中的异常被视为“不可用”（故障安全）。
is_toolset_available() 方法检查工具集的 check_fn 是否通过，用于 UI 显示和工具集解析。

工具集解析

工具集是工具的命名集合。Hermes 通过以下方式解析它们：

显式启用的工具集列表和禁用的工具集列表
平台预设（hermes-cli、hermes-telegram 等）
动态 MCP 工具集
精选的特殊用途集合，如 hermes-acp

`get_tool_definitions()` 如何过滤工具

主要入口点是 model_tools.get_tool_definitions(enabled_toolsets, disabled_toolsets, quiet_mode)：

如果提供了 enabled_toolsets — 仅包含来自这些工具集的工具。每个工具集名称通过 resolve_toolset() 解析，该函数将复合工具集展开为单个工具名称。
如果提供了 disabled_toolsets — 从所有工具集开始，然后减去禁用的工具集。
如果两者都未提供 — 包含所有已知的工具集。
注册表过滤 — 解析后的工具名称集传递给 registry.get_definitions()，该函数应用 check_fn 过滤并返回 OpenAI 格式的 schema。
动态 schema 修补 — 过滤后，execute_code 和 browser_navigate 的 schema 会动态调整，仅引用实际通过过滤的工具（防止模型幻觉使用不可用的工具）。

旧版工具集名称

带有 _tools 后缀的旧工具集名称（例如 web_tools、terminal_tools）通过 _LEGACY_TOOLSET_MAP 映射到其现代工具名称，以实现向后兼容。

调度

在运行时，工具通过中央注册表进行调度，对于某些代理级工具（如 memory/todo/session-search 处理），代理循环会进行异常处理。

调度流程：模型 tool_call → handler 执行

当模型返回 tool_call 时，流程如下：

text

模型响应带有 tool_call
    ↓
run_agent.py 代理循环
    ↓
model_tools.handle_function_call(name, args, task_id, user_task)
    ↓
[代理循环工具？] → 由代理循环直接处理（todo、memory、session_search、delegate_task）
    ↓
[插件前置钩子] → invoke_hook("pre_tool_call", ...)
    ↓
registry.dispatch(name, args, **kwargs)
    ↓
按名称查找 ToolEntry
    ↓
[异步 handler？] → 通过 _run_async() 桥接
[同步 handler？]  → 直接调用
    ↓
返回结果字符串（或 JSON 错误）
    ↓
[插件后置钩子] → invoke_hook("post_tool_call", ...)

错误包装

所有工具执行都在两个级别进行错误处理包装：

registry.dispatch() — 捕获 handler 的任何异常，并以 JSON 形式返回 {"error": "Tool execution failed: ExceptionType: message"}。
handle_function_call() — 将整个调度包装在二级 try/except 中，返回 {"error": "Error executing tool_name: message"}。

这确保了模型始终收到格式良好的 JSON 字符串，而不会出现未处理的异常。

代理循环工具

四个工具在注册表调度之前被拦截，因为它们需要代理级状态（TodoStore、MemoryStore 等）：

todo — 计划/任务跟踪
memory — 持久化内存写入
session_search — 跨会话回忆
delegate_task — 生成子代理会话

这些工具的 schema 仍然在注册表中注册（用于 get_tool_definitions），但如果调度以某种方式直接到达它们，它们的 handler 会返回一个存根错误。

异步桥接

当工具 handler 是异步时，_run_async() 将其桥接到同步调度路径：

CLI 路径（无运行中的事件循环） — 使用持久事件循环以保持缓存的异步客户端存活
Gateway 路径（运行中的事件循环） — 使用 asyncio.run() 启动一个一次性线程
工作线程（并行工具） — 使用存储在线程本地存储中的每线程持久循环

DANGEROUS_PATTERNS 审批流程

终端工具集成了在 tools/approval.py 中定义的危险命令审批系统：

模式检测 — DANGEROUS_PATTERNS 是一个 (regex, description) 元组列表，涵盖破坏性操作：
- 递归删除（rm -rf）
- 文件系统格式化（mkfs、dd）
- SQL 破坏性操作（DROP TABLE、不带 WHERE 的 DELETE FROM）
- 系统配置覆盖（> /etc/）
- 服务操作（systemctl stop）
- 远程代码执行（curl | sh）
- Fork 炸弹、进程杀死等。
检测 — 在执行任何终端命令之前，detect_dangerous_command(command) 会检查所有模式。
审批提示 — 如果找到匹配项：
- CLI 模式 — 交互式提示要求用户批准、拒绝或永久允许
- Gateway 模式 — 异步审批回调将请求发送到消息平台
- 智能审批 — 可选地，辅助 LLM 可以自动批准匹配模式但风险较低的命令（例如，rm -rf node_modules/ 是安全的，但匹配“递归删除”）
会话状态 — 审批按会话跟踪。一旦你批准了某个会话的“递归删除”，后续的 rm -rf 命令不会再次提示。
永久允许列表 — “永久允许”选项将模式写入 config.yaml 的 command_allowlist，跨会话持久化。

终端/运行时环境

终端系统支持多个后端：

local
docker
ssh
singularity
modal
daytona

它还支持：

每个任务的工作目录覆盖
后台进程管理
PTY 模式
危险命令的审批回调

并发

工具调用可以顺序执行或并发执行，具体取决于工具组合和交互需求。

字节笔记本

hermes教程-工具运行时

工具注册模型

`registry.register()` 的工作原理

发现：`discover_builtin_tools()`

工具可用性检查（`check_fn`）

工具集解析

`get_tool_definitions()` 如何过滤工具

旧版工具集名称

调度

调度流程：模型 tool_call → handler 执行

错误包装

代理循环工具

异步桥接

DANGEROUS_PATTERNS 审批流程

终端/运行时环境

并发

相关文档

字节笔记本

hermes教程-工具运行时

工具注册模型

registry.register() 的工作原理

发现：discover_builtin_tools()

工具可用性检查（check_fn）

工具集解析

get_tool_definitions() 如何过滤工具

旧版工具集名称

调度

调度流程：模型 tool_call → handler 执行

错误包装

代理循环工具

异步桥接

DANGEROUS_PATTERNS 审批流程

终端/运行时环境

并发

相关文档

`registry.register()` 的工作原理

发现：`discover_builtin_tools()`

工具可用性检查（`check_fn`）

`get_tool_definitions()` 如何过滤工具