跳到主要内容

构建内存提供者插件

内存提供者插件为 Hermes Agent 提供了比内置的 MEMORY.md 和 USER.md 更持久、跨会话的知识。本指南介绍了如何构建此类插件。

提示

内存提供者是两种 提供者插件 类型之一。另一种是 Context Engine Plugins，它取代了内置的上下文压缩器。两者遵循相同的模式：单选、配置驱动、通过 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:
        """在智能体启动时调用一次。

        kwargs 始终包含：
          hermes_home (str): 当前 HERMES_HOME 路径。用于存储。
        """
        self._api_key = os.environ.get("MY_API_KEY", "")
        self._session_id = session_id

    # ... 实现剩余方法

所需方法​

核心生命周期​

方法调用时机是否必须实现？
name (属性)始终是
is_available()智能体初始化，激活前是 — 不进行网络调用
initialize(session_id, **kwargs)智能体启动时是
get_tool_schemas()初始化后，用于工具注入是
handle_tool_call(name, args)智能体使用您的工具时是 (如果提供了工具)

配置​

方法目的是否必须实现？
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()进程退出时清理连接

配置模式​

get_config_schema() 返回一个字段描述符列表，该列表由 hermes memory setup 使用：

def get_config_schema(self):
    return [
        {
            "key": "api_key",
            "description": "我的提供者 API 密钥",
            "secret": True,           # → 写入 .env
            "required": True,
            "env_var": "MY_API_KEY",   # 显式环境变量名称
            "url": "https://my-provider.com/keys",  # 获取密钥的地址
        },
        {
            "key": "region",
            "description": "服务器区域",
            "default": "us-east",
            "choices": ["us-east", "eu-west", "ap-south"],
        },
        {
            "key": "project",
            "description": "项目标识符",
            "default": "hermes",
        },
    ]

带有 secret: True 和 env_var 的字段会写入 .env。非密钥字段则传递给 save_config()。

最小化与完整模式

get_config_schema() 中的每个字段都会在 hermes memory setup 期间提示。如果提供者选项很多，应保持模式最小化——只包含用户必须配置的字段（API 密钥、必需凭证）。将可选设置记录在配置文件参考（例如 $HERMES_HOME/myprovider.json）中，而不是在设置过程中全部提示。这样可以在保持设置向导快速的同时，仍支持高级配置。请参阅 Supermemory 提供者了解示例——它只提示 API 密钥；所有其他选项都存储在 supermemory.json 中。

保存配置​

def save_config(self, values: dict, hermes_home: str) -> None:
    """将非密钥配置写入您的本地位置。"""
    import json
    from pathlib import Path
    config_path = Path(hermes_home) / "my-provider.json"
    config_path.write_text(json.dumps(values, indent=2))

对于仅依赖环境变量的提供者，请保持默认的无操作（no-op）。

插件入口点​

def register(ctx) -> None:
    """由内存插件发现系统调用。"""
    ctx.register_memory_provider(MyMemoryProvider())

plugin.yaml​

name: my-provider
version: 1.0.0
description: "简短描述此提供者做什么。"
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("同步失败：%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()

配置文件隔离​

所有存储路径必须使用 initialize() 中的 hermes_home 参数，而不是硬编码的 ~/.hermes：

# 正确 — 配置文件范围
from hermes_constants import get_hermes_home
data_dir = get_hermes_home() / "my-provider"

# 错误 — 所有配置文件共享
data_dir = Path("~/.hermes/my-provider").expanduser()

测试​

有关使用真实 SQLite 提供者的完整 E2E 测试模式，请参阅 tests/agent/test_memory_plugin_e2e.py。

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）。这使用基于约定的发现系统——无需更改核心文件。

工作原理​

  1. 在插件目录中添加一个 cli.py 文件
  2. 定义一个 register_cli(subparser) 函数来构建 argparse 树
  3. 内存插件系统在启动时通过 discover_plugin_cli_commands() 发现它
  4. 您的命令将出现在 hermes <提供者名称> <子命令> 下

活动提供者门控： 只有当您的提供者是配置文件中活动的 memory.provider 时，您的 CLI 命令才会显示。如果用户没有配置您的提供者，您的命令将不会显示在 hermes --help 中。

示例​

# plugins/memory/my-provider/cli.py

def my_command(args):
    """由 argparse 分派的处理程序。"""
    sub = getattr(args, "my_command", None)
    if sub == "status":
        print("提供者已激活并连接。")
    elif sub == "config":
        print("显示配置...")
    else:
        print("用法: hermes my-provider <status|config>")

def register_cli(subparser) -> None:
    """构建 hermes my-provider 的 argparse 树。

    在 discover_plugin_cli_commands() 设置时调用。
    """
    subs = subparser.add_subparsers(dest="my_command")
    subs.add_parser("status", help="显示提供者状态")
    subs.add_parser("config", help="显示提供者配置")
    subparser.set_defaults(func=my_command)

参考实现​

请参阅 plugins/memory/honcho/cli.py，了解包含 13 个子命令、跨配置文件管理（--target-profile）和配置读写功能的完整示例。

带有 CLI 的目录结构​

plugins/memory/my-provider/
├── __init__.py      # MemoryProvider 实现 + register()
├── plugin.yaml      # 元数据
├── cli.py           # register_cli(subparser) — CLI 命令
└── README.md        # 设置说明

单提供者规则​

一次只能激活一个外部内存提供者。如果用户尝试注册第二个，MemoryManager 将发出警告并拒绝。这可以防止工具模式膨胀和后端冲突。