添加工具
在编写工具之前，问问自己：这应该是一个技能吗？
:::warning 仅限内置核心工具 本页面用于向仓库本身添加内置的 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"],
)关键规则
:::danger 重要
- 处理程序必须返回 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, # registry 自动调用 _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"