构建记忆提供者插件
记忆提供者插件为 Hermes Agent 提供超越内置 MEMORY.md 和 USER.md 的持久化跨会话知识。本指南介绍如何构建一个。
提示
记忆提供者是两种提供者插件类型之一。另一个是上下文引擎插件，它替换内置上下文压缩器。两者遵循相同的模式：单选、配置驱动、通过 hermes plugins 管理。
目录结构
每个记忆提供者位于 plugins/memory/<name>/：
plugins/memory/my-provider/
├── __init__.py # MemoryProvider 实现 + register() 入口点
├── plugin.yaml # 元数据（名称、描述、钩子）
└── README.md # 设置说明、配置参考、工具
MemoryProvider ABC
你的插件实现 agent/memory_provider.py 中的 MemoryProvider 抽象基类：
from agent.memory_provider import MemoryProvider
class MyMemoryProvider(MemoryProvider):
@property
def name(self) -> str:
return "my-provider"
def is_available(self) -> bool:
"""检查此提供者是否可以激活。无网络调用。"""
return bool(os.environ.get("MY_API_KEY"))
def initialize(self, session_id: str, **kwargs) -> None:
"""在 agent 启动时调用一次。
kwargs 始终包含：
hermes_home (str): 活跃的 HERMES_HOME 路径。用于存储。
"""
self._api_key = os.environ.get("MY_API_KEY", "")
self._session_id = session_id
必需方法
核心生命周期
| 方法 | 调用时机 | 必须实现？ |
|---|---|---|
name (property) | 始终 | 是 |
is_available() | Agent 初始化，激活前 | 是 — 无网络调用 |
initialize(session_id, **kwargs) | Agent 启动 | 是 |
get_tool_schemas() | 初始化后，用于工具注入 | 是 |
handle_tool_call(name, args) | 当 agent 使用你的工具时 | 是（如果你有工具） |
配置
| 方法 | 用途 | 必须实现？ |
|---|---|---|
get_config_schema() | 声明 hermes memory setup 的配置字段 | 是 |
save_config(values, hermes_home) | 将非秘密配置写入原生位置 | 是（除非仅使用环境变量） |
可选钩子
| 方法 | 调用时机 | 使用场景 |
|---|---|---|
system_prompt_block() | 系统提示组装 | 静态提供者信息 |
prefetch(query) | 每次 API 调用前 | 返回召回的上下文 |
queue_prefetch(query) | 每轮后 | 为下一轮预热 |
sync_turn(user, assistant) | 每轮完成后 | 持久化对话 |
on_session_end(messages) | 对话结束 | 最终提取/刷新 |
on_pre_compress(messages) | 上下文压缩前 | 丢弃前保存洞察 |
on_memory_write(action, target, content) | 内置记忆写入 | 镜像到你的后端 |
shutdown() | 进程退出 | 清理连接 |
配置 Schema
get_config_schema() 返回字段描述符列表：
def get_config_schema(self):
return [
{
"key": "api_key",
"description": "My Provider API key",
"secret": True, # → 写入 .env
"required": True,
"env_var": "MY_API_KEY",
"url": "https://my-provider.com/keys",
},
{
"key": "region",
"description": "Server region",
"default": "us-east",
"choices": ["us-east", "eu-west", "ap-south"],
},
]
插件入口点
def register(ctx) -> None:
"""由记忆插件发现系统调用。"""
ctx.register_memory_provider(MyMemoryProvider())
plugin.yaml
name: my-provider
version: 1.0.0
description: "Short description of what this provider does."
hooks:
- on_session_end # 列出你实现的钩子
线程契约
sync_turn() 必须非阻塞。 如果你的后端有延迟（API 调用、LLM 处理），在守护线程中运行工作：
def sync_turn(self, user_content, assistant_content):
def _sync():
try:
self._api.ingest(user_content, assistant_content)
except Exception as e:
logger.warning("Sync failed: %s", e)
if self._sync_thread and self._sync_thread.is_alive():
self._sync_thread.join(timeout=5.0)
self._sync_thread = threading.Thread(target=_sync, daemon=True)
self._sync_thread.start()
Profile 隔离
所有存储路径必须使用 initialize() 的 hermes_home kwarg，而不是硬编码 ~/.hermes：
# 正确 — profile-scoped
from hermes_constants import get_hermes_home
data_dir = get_hermes_home() / "my-provider"
# 错误 — 跨所有 profiles 共享
data_dir = Path("~/.hermes/my-provider").expanduser()
测试
from agent.memory_manager import MemoryManager
mgr = MemoryManager()
mgr.add_provider(my_provider)
mgr.initialize_all(session_id="test-1", platform="cli")
# 测试工具路由
result = mgr.handle_tool_call("my_tool", {"action": "add", "content": "test"})
# 测试生命周期
mgr.sync_all("user msg", "assistant msg")
mgr.on_session_end([])
mgr.shutdown_all()
添加 CLI 命令
记忆提供者插件可以注册自己的 CLI 子命令树（例如 hermes my-provider status、hermes my-provider config）。
工作原理
- 在你的插件目录添加
cli.py文件 - 定义
register_cli(subparser)函数构建 argparse 树 - 记忆插件系统在启动时通过
discover_plugin_cli_commands()发现它 - 你的命令出现在
hermes <provider-name> <subcommand>下
示例
def register_cli(subparser) -> None:
subs = subparser.add_subparsers(dest="my_command")
subs.add_parser("status", help="Show provider status")
subs.add_parser("config", help="Show provider config")
单提供者规则
一次只能一个外部记忆提供者处于活跃状态。如果用户尝试注册第二个，MemoryManager 会拒绝并发出警告。这防止工具 schema 膨胀和后端冲突。