添加工具

在编写工具之前，请先问自己：这是否应该是一个技能？

仅限内置核心工具

本页面旨在为 Hermes 代码库本身添加一个内置 Hermes 工具。如果您希望创建一个不修改 Hermes 核心代码、个人使用、项目本地或自定义的工具，请使用插件路线：

大多数自定义工具创建应默认使用插件。仅当您明确希望在 tools/ 和 toolsets.py 中发布一个新的内置工具时，才遵循本页面。

当某项能力可以通过指令 + shell 命令 + 现有工具（如 arXiv 搜索、git 工作流、Docker 管理、PDF 处理）来表达时，请将其设为技能。

当它需要与 API 密钥进行端到端集成、包含自定义处理逻辑、二进制数据处理或涉及流式传输（如浏览器自动化、TTS、视觉分析）时，请将其设为工具。

概述

添加一个工具涉及 2 个文件：

tools/your_tool.py — 处理器、模式、检查函数、registry.register() 调用
toolsets.py — 将工具名称添加到 _HERMES_CORE_TOOLS（或特定的工具集）

任何在顶层具有 registry.register() 调用的 tools/*.py 文件都会在启动时被自动发现——无需维护手动导入列表。

步骤 1：创建内置工具文件

每个工具文件都遵循相同的结构：

# tools/weather_tool.py
"""天气工具 -- 查看某个位置的当前天气。"""

import json
import os
import logging

logger = logging.getLogger(__name__)


# --- 可用性检查 ---

def check_weather_requirements() -> bool:
    """如果工具的依赖项可用，则返回 True。"""
    return bool(os.getenv("WEATHER_API_KEY"))


# --- 处理器 ---

def weather_tool(location: str, units: str = "metric") -> str:
    """获取某个位置的天气。返回 JSON 字符串。"""
    api_key = os.getenv("WEATHER_API_KEY")
    if not api_key:
        return json.dumps({"error": "WEATHER_API_KEY 未配置"})
    try:
        # ... 调用天气 API ...
        return json.dumps({"location": location, "temp": 22, "units": units})
    except Exception as e:
        return json.dumps({"error": str(e)})


# --- 模式 ---

WEATHER_SCHEMA = {
    "name": "weather",
    "description": "获取某个位置的当前天气。",
    "parameters": {
        "type": "object",
        "properties": {
            "location": {
                "type": "string",
                "description": "城市名称或坐标（例如 'London' 或 '51.5,-0.1'）"
            },
            "units": {
                "type": "string",
                "enum": ["metric", "imperial"],
                "description": "温度单位（默认：metric）",
                "default": "metric"
            }
        },
        "required": ["location"]
    }
}


# --- 注册 ---

from tools.registry import registry

registry.register(
    name="weather",
    toolset="weather",
    schema=WEATHER_SCHEMA,
    handler=lambda args, **kw: weather_tool(
        location=args.get("location", ""),
        units=args.get("units", "metric")),
    check_fn=check_weather_requirements,
    requires_env=["WEATHER_API_KEY"],
)

关键规则

重要

处理器必须返回 JSON 字符串（通过 json.dumps()），绝不返回原始字典
错误必须作为 {"error": "message"} 返回，绝不作为异常抛出
check_fn 在构建工具定义时调用——如果返回 False，该工具会被静默排除
handler 接收 (args: dict, **kwargs)，其中 args 是 LLM 的工具调用参数

步骤 2：将内置工具添加到工具集

在 toolsets.py 中，添加工具名称：

# 如果它应该在所有平台上都可用（CLI + 消息）：
_HERMES_CORE_TOOLS = [
    ...
    "weather",  # <-- 在此处添加
]

# 或者创建一个新的独立工具集：
"weather": {
    "description": "天气查询工具",
    "tools": ["weather"],
    "includes": []
},

步骤 3：添加发现导入（不再需要）

在顶层具有 registry.register() 调用的工具模块会被 tools/registry.py 中的 discover_builtin_tools() 自动发现。无需维护手动导入列表——只需在 tools/ 中创建您的文件，启动时就会被加载。

异步处理器

如果您的处理器需要异步代码，请用 is_async=True 标记它：

async def weather_tool_async(location: str) -> str:
    async with aiohttp.ClientSession() as session:
        ...
    return json.dumps(result)

registry.register(
    name="weather",
    toolset="weather",
    schema=WEATHER_SCHEMA,
    handler=lambda args, **kw: weather_tool_async(args.get("location", "")),
    check_fn=check_weather_requirements,
    is_async=True,  # 注册表会自动调用 _run_async()
)

注册表透明地处理异步桥接——您永远不需要自己调用 asyncio.run()。

需要 task_id 的处理器

管理每个会话状态的工具通过 **kwargs 接收 task_id：

def _handle_weather(args, **kw):
    task_id = kw.get("task_id")
    return weather_tool(args.get("location", ""), task_id=task_id)

registry.register(
    name="weather",
    ...
    handler=_handle_weather,
)

智能体循环拦截的工具

某些工具（todo、memory、session_search、delegate_task）需要访问每个会话的智能体状态。这些工具在到达注册表之前会被 run_agent.py 拦截。注册表仍然保存它们的模式，但如果拦截被绕过，dispatch() 会返回一个回退错误。

可选：设置向导集成

如果您的工具需要 API 密钥，请将其添加到 hermes_cli/config.py：

OPTIONAL_ENV_VARS = {
    ...
    "WEATHER_API_KEY": {
        "description": "用于天气查询的天气 API 密钥",
        "prompt": "天气 API 密钥",
        "url": "https://weatherapi.com/",
        "tools": ["weather"],
        "password": True,
    },
}

检查清单

工具文件已创建，包含处理器、模式、检查函数和注册
已添加到 toolsets.py 中相应的工具集
已确认这确实应该是一个内置/核心工具，而不是插件
处理器返回 JSON 字符串，错误作为 {"error": "..."} 返回
可选：API 密钥已添加到 hermes_cli/config.py 中的 OPTIONAL_ENV_VARS
可选：已添加到 toolset_distributions.py 以进行批处理
已使用 hermes chat -q "Use the weather tool for London" 进行测试

概述​

步骤 1：创建内置工具文件​

关键规则​

步骤 2：将内置工具添加到工具集​

步骤 3：添加发现导入（不再需要）​

异步处理器​

需要 task_id 的处理器​

智能体循环拦截的工具​

可选：设置向导集成​

检查清单​

概述