事件钩子

Hermes 提供了两个钩子系统，在关键生命周期节点运行自定义代码：

系统	注册方式	运行环境	使用场景
网关钩子	HOOK.yaml + handler.py 在 ~/.hermes/hooks/ 中	仅网关	日志记录、告警、Webhook
插件钩子	ctx.register_hook() 在 插件 中	CLI + 网关	工具拦截、指标统计、安全策略

两个系统均为非阻塞模式 —— 任何钩子中出现的错误都会被捕获并记录，绝不会导致代理崩溃。

网关事件钩子

网关钩子在网关运行期间（Telegram、Discord、Slack、WhatsApp）自动触发，且不会阻塞主代理流程。

创建钩子

每个钩子是一个位于 ~/.hermes/hooks/ 下的目录，包含两个文件：

~/.hermes/hooks/
└── my-hook/
    ├── HOOK.yaml      # Declares which events to listen for
    └── handler.py     # Python handler function

HOOK.yaml

name: my-hook
description: Log all agent activity to a file
events:
  - agent:start
  - agent:end
  - agent:step

events 列表决定了哪些事件会触发你的处理器。你可以订阅任意组合的事件，包括通配符如 command:*。

handler.py

import json
from datetime import datetime
from pathlib import Path

LOG_FILE = Path.home() / ".hermes" / "hooks" / "my-hook" / "activity.log"

async def handle(event_type: str, context: dict):
    """Called for each subscribed event. Must be named 'handle'."""
    entry = {
        "timestamp": datetime.now().isoformat(),
        "event": event_type,
        **context,
    }
    with open(LOG_FILE, "a") as f:
        f.write(json.dumps(entry) + "\n")

处理器规则：

• 必须命名为 handle
• 接收 event_type（字符串）和 context（字典）
• 可以是异步函数或普通函数 —— 两者均可工作
• 错误会被捕获并记录，绝不会导致代理崩溃

可用事件

事件	触发时机	上下文键值
gateway:startup	网关进程启动时	platforms（当前激活的平台名称列表）
session:start	新消息会话创建时	platform, user_id, session_id, session_key
session:end	会话结束前（重置前）	platform, user_id, session_key
session:reset	用户执行了 /new 或 /reset	platform, user_id, session_key
agent:start	代理开始处理消息	platform, user_id, session_id, message
agent:step	每次工具调用循环迭代	platform, user_id, session_id, iteration, tool_names
agent:end	代理完成处理	platform, user_id, session_id, message, response
command:*	任意斜杠命令执行	platform, user_id, command, args

通配符匹配

注册为 command:* 的处理器将对所有 command: 事件触发（如 command:model、command:reset 等）。通过单一订阅即可监控所有斜杠命令。

示例

启动检查清单（BOOT.md）—— 内建钩子

网关自带一个内建的 boot-md 钩子，会在每次启动时检查是否存在 ~/.hermes/BOOT.md。如果该文件存在，代理将在后台会话中执行其指令。无需安装 —— 只需创建此文件即可。

创建 ~/.hermes/BOOT.md：

# Startup Checklist

1. Check if any cron jobs failed overnight — run `hermes cron list`
2. Send a message to Discord #general saying "Gateway restarted, all systems go"
3. Check if /opt/app/deploy.log has any errors from the last 24 hours

代理会在后台线程中运行这些指令，因此不会阻塞网关启动。若无待处理事项，代理将回复 [SILENT]，且不会发送任何消息。

tip

没有 BOOT.md？该钩子会静默跳过 —— 无额外开销。需要启动自动化时创建文件，不需要时删除即可。

长任务 Telegram 告警

当代理执行超过 10 步时，向自己发送一条消息：

# ~/.hermes/hooks/long-task-alert/HOOK.yaml
name: long-task-alert
description: Alert when agent is taking many steps
events:
  - agent:step

# ~/.hermes/hooks/long-task-alert/handler.py
import os
import httpx

THRESHOLD = 10
BOT_TOKEN = os.getenv("TELEGRAM_BOT_TOKEN")
CHAT_ID = os.getenv("TELEGRAM_HOME_CHANNEL")

async def handle(event_type: str, context: dict):
    iteration = context.get("iteration", 0)
    if iteration == THRESHOLD and BOT_TOKEN and CHAT_ID:
        tools = ", ".join(context.get("tool_names", []))
        text = f"⚠️ Agent has been running for {iteration} steps. Last tools: {tools}"
        async with httpx.AsyncClient() as client:
            await client.post(
                f"https://api.telegram.org/bot{BOT_TOKEN}/sendMessage",
                json={"chat_id": CHAT_ID, "text": text},
            )

命令使用日志记录器

追踪哪些斜杠命令被使用：

# ~/.hermes/hooks/command-logger/HOOK.yaml
name: command-logger
description: Log slash command usage
events:
  - command:*

# ~/.hermes/hooks/command-logger/handler.py
import json
from datetime import datetime
from pathlib import Path

LOG = Path.home() / ".hermes" / "logs" / "command_usage.jsonl"

def handle(event_type: str, context: dict):
    LOG.parent.mkdir(parents=True, exist_ok=True)
    entry = {
        "ts": datetime.now().isoformat(),
        "command": context.get("command"),
        "args": context.get("args"),
        "platform": context.get("platform"),
        "user": context.get("user_id"),
    }
    with open(LOG, "a") as f:
        f.write(json.dumps(entry) + "\n")

会话启动 Webhook

新会话创建时向外部服务发送 POST 请求：

# ~/.hermes/hooks/session-webhook/HOOK.yaml
name: session-webhook
description: Notify external service on new sessions
events:
  - session:start
  - session:reset

# ~/.hermes/hooks/session-webhook/handler.py
import httpx

WEBHOOK_URL = "https://your-service.example.com/hermes-events"

async def handle(event_type: str, context: dict):
    async with httpx.AsyncClient() as client:
        await client.post(WEBHOOK_URL, json={
            "event": event_type,
            **context,
        }, timeout=5)

工作原理

1. 网关启动时，HookRegistry.discover_and_load() 扫描 ~/.hermes/hooks/
2. 每个包含 HOOK.yaml 和 handler.py 的子目录会被动态加载
3. 处理器根据声明的事件进行注册
4. 在每个生命周期节点，hooks.emit() 会触发所有匹配的处理器
5. 任何处理器中的错误都会被捕获并记录 —— 一个损坏的钩子绝不会导致代理崩溃

info

网关钩子仅在 网关（Telegram、Discord、Slack、WhatsApp）中触发。CLI 不会加载网关钩子。如需在所有环境中生效的钩子，请使用 插件钩子。

插件钩子

插件 可以注册在 CLI 和网关 会话中均触发的钩子。这些钩子通过在插件的 register() 函数中使用 ctx.register_hook() 进行程序化注册。

def register(ctx):
    ctx.register_hook("pre_tool_call", my_tool_observer)
    ctx.register_hook("post_tool_call", my_tool_logger)
    ctx.register_hook("pre_llm_call", my_memory_callback)
    ctx.register_hook("post_llm_call", my_sync_callback)
    ctx.register_hook("on_session_start", my_init_callback)
    ctx.register_hook("on_session_end", my_cleanup_callback)

所有钩子的通用规则：

• 回调函数接收 关键字参数。始终接受 **kwargs 以保证向前兼容 —— 未来版本可能会添加新参数，但不会破坏你的插件。
• 如果回调函数 崩溃，会被记录并跳过。其他钩子和代理将继续正常运行。行为异常的插件绝不会导致代理崩溃。
• 所有钩子均为 一次性观察者，返回值被忽略 —— 除了 pre_llm_call，它可以 注入上下文。

快速参考

钩子	触发时机	返回值
pre_tool_call	任何工具执行前	忽略
post_tool_call	任何工具返回后	忽略
pre_llm_call	每轮开始前，工具调用循环之前	上下文注入
post_llm_call	每轮结束时，工具调用循环之后	忽略
on_session_start	新会话创建时（仅第一轮）	忽略
on_session_end	会话结束时	忽略

---

pre_tool_call

在每次工具执行 之前立即触发 —— 包括内置工具和插件工具。

回调签名：

def my_callback(tool_name: str, args: dict, task_id: str, **kwargs):

参数	类型	说明
tool_name	str	即将执行的工具名称（例如 "terminal"、"web_search"、"read_file"）
args	dict	模型传递给该工具的参数
task_id	str	会话/任务标识符。未设置时为空字符串。

触发时机： 在 model_tools.py 内部，handle_function_call() 之前。每调用一次工具即触发一次 —— 若模型并行调用 3 个工具，则此钩子触发 3 次。

返回值： 忽略。

使用场景： 日志记录、审计追踪、工具调用计数、阻止危险操作（打印警告）、速率限制。

示例 —— 工具调用审计日志：

import json, logging
from datetime import datetime

logger = logging.getLogger(__name__)

def audit_tool_call(tool_name, args, task_id, **kwargs):
    logger.info("TOOL_CALL session=%s tool=%s args=%s",
                task_id, tool_name, json.dumps(args)[:200])

def register(ctx):
    ctx.register_hook("pre_tool_call", audit_tool_call)

示例 —— 对危险工具发出警告：

DANGEROUS = {"terminal", "write_file", "patch"}

def warn_dangerous(tool_name, **kwargs):
    if tool_name in DANGEROUS:
        print(f"⚠ Executing potentially dangerous tool: {tool_name}")

def register(ctx):
    ctx.register_hook("pre_tool_call", warn_dangerous)

---

post_tool_call

在每次工具执行 返回后立即触发。

回调签名：

def my_callback(tool_name: str, args: dict, result: str, task_id: str, **kwargs):

参数	类型	说明
tool_name	str	刚刚执行的工具名称
args	dict	模型传递给该工具的参数
result	str	工具的返回值（始终为 JSON 字符串）
task_id	str	会话/任务标识符。未设置时为空字符串。

触发时机： 在 model_tools.py 内部，handle_function_call() 之后。每调用一次工具即触发一次。不会在工具抛出未处理异常时触发（错误会被捕获并作为错误 JSON 字符串返回，此时 post_tool_call 会以该错误字符串作为 result 触发）。

返回值： 忽略。

使用场景： 记录工具结果、收集指标、跟踪工具成功率/失败率、特定工具完成后发送通知。

示例 —— 跟踪工具使用指标：

from collections import Counter
import json

_tool_counts = Counter()
_error_counts = Counter()

def track_metrics(tool_name, result, **kwargs):
    _tool_counts[tool_name] += 1
    try:
        parsed = json.loads(result)
        if "error" in parsed:
            _error_counts[tool_name] += 1
    except (json.JSONDecodeError, TypeError):
        pass

def register(ctx):
    ctx.register_hook("post_tool_call", track_metrics)

---

pre_llm_call

在每轮开始时 仅触发一次，在工具调用循环开始前。这是 唯一一个返回值会被使用的钩子 —— 它可以向当前轮次的用户消息中注入上下文。

回调签名：

def my_callback(session_id: str, user_message: str, conversation_history: list,
                is_first_turn: bool, model: str, platform: str, **kwargs):

参数	类型	说明
session_id	str	当前会话的唯一标识符
user_message	str	当前回合用户原始消息（在任何技能注入前）
conversation_history	list	完整消息列表的副本（OpenAI 格式：[{"role": "user", "content": "..."}]）
is_first_turn	bool	若为新会话的第一轮，则值为 True；后续回合则为 False
model	str	模型标识符（例如 "anthropic/claude-sonnet-4.6"）
platform	str	会话运行位置："cli"、"telegram"、"discord" 等

触发时机： 在 run_agent.py 内部，run_conversation() 中，上下文压缩之后、主 while 循环之前。每调用一次 run_conversation()（即每个用户回合）触发一次，而非工具循环内的每次 API 调用。

返回值： 若回调返回包含 "context" 键的字典，或非空字符串，该文本将被追加至当前回合的用户消息末尾。返回 None 表示不进行注入。

# Inject context
return {"context": "Recalled memories:\n- User likes Python\n- Working on hermes-agent"}

# Plain string (equivalent)
return "Recalled memories:\n- User likes Python"

# No injection
return None

上下文注入位置： 始终注入到 用户消息 中，从不修改系统提示。此举保留了提示缓存——系统提示在各回合保持一致，因此缓存的 token 可被复用。系统提示属于 Hermes 的领域（模型引导、工具执行、角色设定、技能控制）。插件则在用户输入旁提供上下文补充。

所有注入的上下文均为 临时性 —— 仅在 API 调用时添加。对话历史中的原始用户消息不会被修改，也不会持久化至会话数据库。

当 多个插件 返回上下文时，它们的输出按插件发现顺序（按目录名字母序）以双换行符连接。

使用场景： 记忆召回、RAG 上下文注入、安全防护、每回合分析。

示例 —— 记忆召回：

import httpx

MEMORY_API = "https://your-memory-api.example.com"

def recall(session_id, user_message, is_first_turn, **kwargs):
    try:
        resp = httpx.post(f"{MEMORY_API}/recall", json={
            "session_id": session_id,
            "query": user_message,
        }, timeout=3)
        memories = resp.json().get("results", [])
        if not memories:
            return None
        text = "Recalled context:\n" + "\n".join(f"- {m['text']}" for m in memories)
        return {"context": text}
    except Exception:
        return None

def register(ctx):
    ctx.register_hook("pre_llm_call", recall)

示例 —— 安全防护：

POLICY = "Never execute commands that delete files without explicit user confirmation."

def guardrails(**kwargs):
    return {"context": POLICY}

def register(ctx):
    ctx.register_hook("pre_llm_call", guardrails)

---

post_llm_call

每回合 仅触发一次，在工具调用循环结束后，且代理已生成最终响应时。仅在 成功完成 的回合中触发——若回合被中断则不触发。

回调签名：

def my_callback(session_id: str, user_message: str, assistant_response: str,
                conversation_history: list, model: str, platform: str, **kwargs):

参数	类型	说明
session_id	str	当前会话的唯一标识符
user_message	str	当前回合用户的原始消息
assistant_response	str	代理在本回合的最终文本响应
conversation_history	list	回合完成后完整的消息列表副本
model	str	模型标识符
platform	str	会话运行位置

触发时机： 在 run_agent.py 内部，run_conversation() 中，工具循环退出并返回最终响应后。受 if final_response and not interrupted 保护——因此不会在用户中途打断回合或代理达到迭代上限但未生成响应时触发。

返回值： 忽略。

使用场景： 将对话数据同步至外部记忆系统、计算响应质量指标、记录回合摘要、触发后续操作。

示例 —— 同步至外部记忆系统：

import httpx

MEMORY_API = "https://your-memory-api.example.com"

def sync_memory(session_id, user_message, assistant_response, **kwargs):
    try:
        httpx.post(f"{MEMORY_API}/store", json={
            "session_id": session_id,
            "user": user_message,
            "assistant": assistant_response,
        }, timeout=5)
    except Exception:
        pass  # best-effort

def register(ctx):
    ctx.register_hook("post_llm_call", sync_memory)

示例 —— 跟踪响应长度：

import logging
logger = logging.getLogger(__name__)

def log_response_length(session_id, assistant_response, model, **kwargs):
    logger.info("RESPONSE session=%s model=%s chars=%d",
                session_id, model, len(assistant_response or ""))

def register(ctx):
    ctx.register_hook("post_llm_call", log_response_length)

---

on_session_start

仅在创建全新会话时触发一次。在用户继续已有会话（发送第二条消息）时不触发。

回调签名：

def my_callback(session_id: str, model: str, platform: str, **kwargs):

参数	类型	说明
session_id	str	新会话的唯一标识符
model	str	模型标识符
platform	str	会话运行位置

触发时机： 在 run_agent.py 内部，run_conversation() 中，新会话的第一轮——具体是在系统提示构建完成后、工具循环开始前。判断依据为 if not conversation_history（无先前消息 = 新会话）。

返回值： 忽略。

使用场景： 初始化会话级状态、预热缓存、向外部服务注册会话、记录会话启动日志。

示例 —— 初始化会话缓存：

_session_caches = {}

def init_session(session_id, model, platform, **kwargs):
    _session_caches[session_id] = {
        "model": model,
        "platform": platform,
        "tool_calls": 0,
        "started": __import__("datetime").datetime.now().isoformat(),
    }

def register(ctx):
    ctx.register_hook("on_session_start", init_session)

---

on_session_end

在每次 run_conversation() 调用的 最末尾 触发，无论结果如何。若通过 CLI 退出时代理正处于处理中，也会由退出处理器触发。

回调签名：

def my_callback(session_id: str, completed: bool, interrupted: bool,
                model: str, platform: str, **kwargs):

参数	类型	说明
session_id	str	会话的唯一标识符
completed	bool	若代理生成了最终响应，则为 True；否则为 False
interrupted	bool	若回合被中断（用户发送新消息、/stop 或退出），则为 True
model	str	模型标识符
platform	str	会话运行位置

触发位置：

1. run_agent.py —— 每次 run_conversation() 调用结束后的清理阶段。始终触发，即使回合出错。
2. cli.py —— CLI 的 atexit 处理器中，但 仅当 代理处于中途处理状态（_agent_running=True）时才触发。此情况可捕获 Ctrl+C 和 /exit 过程中的中断。此时 completed=False 和 interrupted=True。

返回值： 忽略。

使用场景： 刷新缓冲区、关闭连接、持久化会话状态、记录会话时长、清理在 on_session_start 中初始化的资源。

示例 —— 刷新并清理：

_session_caches = {}

def cleanup_session(session_id, completed, interrupted, **kwargs):
    cache = _session_caches.pop(session_id, None)
    if cache:
        # Flush accumulated data to disk or external service
        status = "completed" if completed else ("interrupted" if interrupted else "failed")
        print(f"Session {session_id} ended: {status}, {cache['tool_calls']} tool calls")

def register(ctx):
    ctx.register_hook("on_session_end", cleanup_session)

示例 —— 会话时长追踪：

import time, logging
logger = logging.getLogger(__name__)

_start_times = {}

def on_start(session_id, **kwargs):
    _start_times[session_id] = time.time()

def on_end(session_id, completed, interrupted, **kwargs):
    start = _start_times.pop(session_id, None)
    if start:
        duration = time.time() - start
        logger.info("SESSION_DURATION session=%s seconds=%.1f completed=%s interrupted=%s",
                     session_id, duration, completed, interrupted)

def register(ctx):
    ctx.register_hook("on_session_start", on_start)
    ctx.register_hook("on_session_end", on_end)

---

有关完整指南，请参阅 构建插件指南，其中包含工具 Schema、处理器及高级钩子模式的详细说明。