跳到主要内容

插件

Hermes 有一个插件系统,用于在不修改核心代码的情况下添加自定义工具、钩子和集成。

构建 Hermes 插件 — 带完整工作示例的分步指南。

快速概述

将一个目录放入 ~/.hermes/plugins/,包含 plugin.yaml 和 Python 代码:

~/.hermes/plugins/my-plugin/
├── plugin.yaml # 清单
├── __init__.py # register() — 将模式连接到处理器
├── schemas.py # 工具模式(LLM 看到的)
└── tools.py # 工具处理器(运行时执行的)

启动 Hermes——你的工具会与内置工具一起出现。模型可以立即调用它们。

最小工作示例

这是一个添加 hello_world 工具并通过钩子记录每次工具调用的完整插件。

~/.hermes/plugins/hello-world/plugin.yaml

name: hello-world
version: "1.0"
description: A minimal example plugin

~/.hermes/plugins/hello-world/__init__.py

"""Minimal Hermes plugin — registers a tool and a hook."""


def register(ctx):
# --- Tool: hello_world ---
schema = {
"name": "hello_world",
"description": "Returns a friendly greeting for the given name.",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name to greet",
}
},
"required": ["name"],
},
}

def handle_hello(params):
name = params.get("name", "World")
return f"Hello, {name}! 👋 (from the hello-world plugin)"

ctx.register_tool("hello_world", schema, handle_hello)

# --- Hook: log every tool call ---
def on_tool_call(tool_name, params, result):
print(f"[hello-world] tool called: {tool_name}")

ctx.register_hook("post_tool_call", on_tool_call)

将两个文件放入 ~/.hermes/plugins/hello-world/、重启 Hermes,模型就可以立即调用 hello_world。钩子在每次工具调用后打印一行日志。

项目本地插件在 ./.hermes/plugins/ 下默认禁用。通过在启动 Hermes 前设置 HERMES_ENABLE_PROJECT_PLUGINS=true 来仅为可信仓库启用它们。

插件可以做什么

能力如何
添加工具ctx.register_tool(name, schema, handler)
添加钩子ctx.register_hook("post_tool_call", callback)
添加 CLI 命令ctx.register_cli_command(name, help, setup_fn, handler_fn) — 添加 hermes <plugin> <subcommand>
注入消息ctx.inject_message(content, role="user") — 请参阅注入消息
发送数据文件Path(__file__).parent / "data" / "file.yaml"
绑定技能ctx.register_skill(name, path) — 作为 plugin:skill 命名空间,通过 skill_view("plugin:skill") 加载
环境变量门控plugin.yaml 中的 requires_env: [API_KEY] — 在 hermes plugins install 期间提示
通过 pip 分发[project.entry-points."hermes_agent.plugins"]

插件发现

来源路径用例
用户~/.hermes/plugins/个人插件
项目.hermes/plugins/项目特定插件(需要 HERMES_ENABLE_PROJECT_PLUGINS=true
piphermes_agent.plugins entry_points分发包

可用钩子

插件可以为这些生命周期事件注册回调。请参阅**事件钩子页面**获取完整详情、回调签名和示例。

钩子触发时机
pre_tool_call在任何工具执行之前
post_tool_call在任何工具返回之后
pre_llm_call每轮一次,在 LLM 循环之前——可以返回 {"context": "..."}将上下文注入用户消息
post_llm_call每轮一次,在 LLM 循环之后(仅成功轮次)
on_session_start创建新会话时(仅第一轮)
on_session_end每次 run_conversation 调用结束 + CLI 退出处理程序

插件类型

Hermes 有三种插件:

类型功能选择位置
通用插件添加工具、钩子、CLI 命令多选(启用/禁用)~/.hermes/plugins/
记忆提供商替换或增强内置记忆单选(一个活动)plugins/memory/
上下文引擎替换内置上下文压缩器单选(一个活动)plugins/context_engine/

记忆提供商和上下文引擎是提供商插件——每种类型同时只能有一个处于活动状态。通用插件可以任意组合启用。

管理插件

hermes plugins                  # 统一交互式 UI
hermes plugins list # 带启用/禁用状态的表格视图
hermes plugins install user/repo # 从 Git 安装
hermes plugins update my-plugin # 拉取最新
hermes plugins remove my-plugin # 卸载
hermes plugins enable my-plugin # 重新启用已禁用的插件
hermes plugins disable my-plugin # 禁用而不删除

交互式 UI

运行 hermes plugins 不带参数会打开复合交互式屏幕:

Plugins
↑↓ navigate SPACE toggle ENTER configure/confirm ESC done

General Plugins
→ [✓] my-tool-plugin — Custom search tool
[ ] webhook-notifier — Event hooks

Provider Plugins
Memory Provider ▸ honcho
Context Engine ▸ compressor
  • General Plugins 部分 — 复选框,用 SPACE 切换
  • Provider Plugins 部分 — 显示当前选择。按 ENTER 进入单选选择器,你可以在其中选择一个活动提供商。

提供商插件选择保存到 config.yaml

memory:
provider: "honcho" # 空字符串 = 仅内置

context:
engine: "compressor" # 默认内置压缩器

禁用通用插件

已禁用的插件保持安装状态,但在加载期间跳过。禁用列表存储在 config.yamlplugins.disabled 下:

plugins:
disabled:
- my-noisy-plugin

在运行中的会话中,/plugins 显示当前加载了哪些插件。

注入消息

插件可以使用 ctx.inject_message() 将消息注入活动对话:

ctx.inject_message("New data arrived from the webhook", role="user")

签名: ctx.inject_message(content: str, role: str = "user") -> bool

工作原理:

  • 如果代理处于空闲(等待用户输入),消息被排队作为下一个输入并开始新轮次。
  • 如果代理处于轮次中(正在运行),消息会中断当前操作——与用户输入新消息并按 Enter 相同。
  • 对于非 "user" 角色,内容带有 [role] 前缀(例如 [system] ...)。
  • 如果消息成功排队则返回 True,如果没有可用的 CLI 引用(例如在网关模式下)则返回 False

这使插件(如远程控制查看器、消息桥接或 webhook 接收器)能够从外部源将消息输入对话。

备注

inject_message 仅在 CLI 模式下可用。在网关模式下,没有 CLI 引用,方法返回 False

请参阅**完整指南**获取处理器合约、模式格式、钩子行为、错误处理和常见错误。