跳到主要内容

构建内存提供者插件

内存提供者插件为 Hermes Agent 提供持久化、跨会话的知识，超越内置的 MEMORY.md 和 USER.md。本指南将介绍如何构建一个内存提供者插件。

提示

内存提供者是两种 提供者插件 类型之一。另一种是 上下文引擎插件，用于替换内置的上下文压缩器。两者遵循相同的模式：单选、配置驱动，并通过 hermes plugins 进行管理。

目录结构​

每个内存提供者都位于 plugins/memory/<name>/ 目录下：

plugins/memory/my-provider/
├── __init__.py      # MemoryProvider implementation + register() entry point
├── plugin.yaml      # Metadata (name, description, hooks)
└── README.md        # Setup instructions, config reference, tools

MemoryProvider 抽象基类​

你的插件需实现 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:
        """Check if this provider can activate. NO network calls."""
        return bool(os.environ.get("MY_API_KEY"))

    def initialize(self, session_id: str, **kwargs) -> None:
        """Called once at agent startup.

        kwargs always includes:
          hermes_home (str): Active HERMES_HOME path. Use for storage.
        """
        self._api_key = os.environ.get("MY_API_KEY", "")
        self._session_id = session_id

    # ... implement remaining methods

必需方法​

核心生命周期​

方法调用时机是否必须实现？
name (属性)始终调用是
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() 返回一个字段描述列表，由 hermes memory setup 使用：

def get_config_schema(self):
    return [
        {
            "key": "api_key",
            "description": "My Provider API key",
            "secret": True,           # → written to .env
            "required": True,
            "env_var": "MY_API_KEY",   # explicit env var name
            "url": "https://my-provider.com/keys",  # where to get it
        },
        {
            "key": "region",
            "description": "Server region",
            "default": "us-east",
            "choices": ["us-east", "eu-west", "ap-south"],
        },
        {
            "key": "project",
            "description": "Project identifier",
            "default": "hermes",
        },
    ]

secret: True 且带有 env_var 的字段将写入 .env 文件。非敏感字段将传递给 save_config()。

最小化与完整 Schema

get_config_schema() 中的每个字段都会在 hermes memory setup 时被提示。具有大量选项的提供者应保持 Schema 尽可能简洁——仅包含用户必须配置的字段（如 API 密钥、必需凭证）。可选设置应记录在配置文件参考中（例如 $HERMES_HOME/myprovider.json），而不是在设置向导中全部提示。这能保持设置向导快速响应，同时仍支持高级配置。参见 Supermemory 提供者示例——它仅提示 API 密钥；所有其他选项均位于 supermemory.json 中。

保存配置​

def save_config(self, values: dict, hermes_home: str) -> None:
    """Write non-secret config to your native location."""
    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:
    """Called by the memory plugin discovery system."""
    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    # list hooks you implement

线程约定​

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()

配置文件隔离​

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

# CORRECT — profile-scoped
from hermes_constants import get_hermes_home
data_dir = get_hermes_home() / "my-provider"

# WRONG — shared across all profiles
data_dir = Path("~/.hermes/my-provider").expanduser()

测试​

参见 tests/agent/test_memory_plugin_e2e.py，其中包含使用真实 SQLite 提供者的完整端到端测试模式。

from agent.memory_manager import MemoryManager

mgr = MemoryManager()
mgr.add_provider(my_provider)
mgr.initialize_all(session_id="test-1", platform="cli")

# Test tool routing
result = mgr.handle_tool_call("my_tool", {"action": "add", "content": "test"})

# Test lifecycle
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 <provider-name> <subcommand> 下

激活提供者控制： 只有当你的提供者是配置中的活动 memory.provider 时，你的 CLI 命令才会显示。如果用户未配置你的提供者，你的命令将不会出现在 hermes --help 中。

示例​

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

def my_command(args):
    """Handler dispatched by argparse."""
    sub = getattr(args, "my_command", None)
    if sub == "status":
        print("Provider is active and connected.")
    elif sub == "config":
        print("Showing config...")
    else:
        print("Usage: hermes my-provider <status|config>")

def register_cli(subparser) -> None:
    """Build the hermes my-provider argparse tree.

    Called by discover_plugin_cli_commands() at argparse setup time.
    """
    subs = subparser.add_subparsers(dest="my_command")
    subs.add_parser("status", help="Show provider status")
    subs.add_parser("config", help="Show provider config")
    subparser.set_defaults(func=my_command)

参考实现​

参见 plugins/memory/honcho/cli.py，其中包含一个完整示例，包含 13 个子命令、跨配置文件管理（--target-profile）以及配置读写功能。

带 CLI 的目录结构​

plugins/memory/my-provider/
├── __init__.py      # MemoryProvider implementation + register()
├── plugin.yaml      # Metadata
├── cli.py           # register_cli(subparser) — CLI commands
└── README.md        # Setup instructions

单提供者规则​

同一时间只能激活一个外部内存提供者。如果用户尝试注册第二个，MemoryManager 会以警告拒绝。这可防止工具 Schema 膨胀和后端冲突。