添加工具

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

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

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

概述

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

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

步骤 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：添加发现导入

在 model_tools.py 中，将模块添加到 _discover_tools() 列表：

def _discover_tools():
    _modules = [
        ...
        "tools.weather_tool",  # <-- 在此处添加
    ]

这个导入会触发你工具文件底部的 registry.register() 调用。

异步处理器

如果你的处理器需要异步代码，请用 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,
)

被 Agent 循环拦截的工具

有些工具（todo、memory、session_search、delegate_task）需要访问每个会话的 agent 状态。这些工具在到达注册表之前会被 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 中的适当工具集
已添加到 model_tools.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 的处理器​

被 Agent 循环拦截的工具​

可选：设置向导集成​

检查清单​

概述