Agentic Memory智能体记忆服务支持以插件形式接入主流AI编程助手与智能体框架,为其添加跨会话的持久化记忆能力。插件的本质是把服务端的MCP Server与生命周期钩子接入客户端,安装后即可在会话中直接存取记忆。本文介绍在Claude Code、Claude Cowork、Cursor、Codex、QoderWork、Hermes中安装并配置Agentic Memory插件的方法。
前提条件
支持的客户端与能力范围
客户端 | 安装方式 | MCP服务器 | 生命周期钩子 | Skill |
Claude Code(CLI) | 插件市场安装 | 支持 | 支持,共6个事件 | 不含 |
Claude Cowork(桌面应用) | 插件市场安装 | 支持 | 支持,共6个事件 | 不含 |
Cursor | 手动配置MCP服务器,或插件安装 | 支持 | 仅插件安装方式支持,共5个事件 | 仅插件安装方式包含 |
Codex | 方案A直接配置MCP服务器,或方案B侧加载插件 | 支持 | 仅方案B支持,且需额外运行安装脚本,共3个事件 | 仅方案B包含 |
QoderWork | 导入Kit压缩包 | 支持,需手动替换环境变量 | 支持,需手动合并钩子配置 | 包含 |
Hermes |
| 支持,需额外配置MCP客户端 | 不适用 | 不适用 |
Claude Code与Claude Cowork共享同一套插件系统,安装一次即可在两端生效。
接入流程
接入分为三个步骤,其中步骤二提供两种安装方式,二选一即可。
步骤 | 说明 | 是否必须 |
步骤一:获取API Key与访问域名 | 在AI搜索开放平台控制台获取API Key与访问域名,并写入环境变量。各客户端的插件配置均通过环境变量读取凭证。 | 必须。两种安装方式都依赖该凭证;Hermes只需获取凭证,无需配置环境变量。 |
步骤二:安装插件 | 方式一由Agent读取插件仓库文档自动安装;方式二按客户端手动执行命令或写入配置文件。 | 必须。两种方式二选一。 |
步骤三:验证安装 | 验证服务端连通性,并确认客户端已加载MCP工具。 | 建议执行,用于确认凭证与插件配置生效。 |
步骤一:获取API Key与访问域名
获取API Key与访问域名
登录AI搜索开放平台控制台。
在左侧导航栏,单击API Keys。
在页面上方访问域名区域,记录所需的API域名。公网环境使用公网API域名,VPC环境使用私网API域名,两者均支持HTTPS。该域名即为后续配置中的base URL。
单击创建API Key,按页面提示完成账号安全验证,然后复制以
OS-开头的API Key。
创建API Key时会触发阿里云账号安全验证,需通过MFA验证(阿里云APP或Google身份验证器动态码)或扫脸验证之一。若已有可用的API Key,可在列表操作列单击查看直接获取明文,该操作不触发安全验证。同一账号至多允许10个API Key同时启用。
配置环境变量
Claude Code、Claude Cowork、Cursor、Codex、QoderWork均通过环境变量读取凭证,请先将API Key与访问域名写入Shell配置文件。Hermes不使用环境变量,请直接跳至Hermes章节。
# zsh(macOS默认)
echo 'export AGENTIC_MEMORY_API_KEY="OS-your-api-key"' >> ~/.zshrc
echo 'export AGENTIC_MEMORY_BASE_URL="https://xxx.platform-cn-shanghai.opensearch.aliyuncs.com"' >> ~/.zshrc
source ~/.zshrc
# bash
echo 'export AGENTIC_MEMORY_API_KEY="OS-your-api-key"' >> ~/.bashrc
echo 'export AGENTIC_MEMORY_BASE_URL="https://xxx.platform-cn-shanghai.opensearch.aliyuncs.com"' >> ~/.bashrc
source ~/.bashrc确认环境变量已生效。
echo $AGENTIC_MEMORY_API_KEY
echo $AGENTIC_MEMORY_BASE_URL步骤二:安装插件
安装插件有两种方式,二选一即可:方式一由Agent读取插件仓库文档自动完成安装,适合快速接入;方式二按客户端手动执行命令或写入配置文件,适合需要了解差异化配置或方式一执行失败时使用。两种方式都要求先完成步骤一,插件的MCP配置通过环境变量读取凭证。
方式一:由Agent自动安装(推荐)
在兼容的Agent对话框内输入以下Prompt指令,由Agent自行完成插件安装。
Claude Code、Claude Cowork、Cursor、Codex、QoderWork:
请根据https://github.com/aliyun/alibabacloud-opensearch-memory/blob/main/README.md 文档安装插件Hermes:
请根据https://github.com/aliyun/alibabacloud-opensearch-memory-for-hermes.git 文档安装插件安装完成后请执行步骤三验证。若Agent执行失败,或需要了解各客户端的差异化配置,请改用方式二手动安装。
方式二:手动安装
请根据实际使用的客户端选择对应的安装方式。除Hermes外,其余客户端均需先完成步骤一的环境变量配置。
Claude Code与Claude Cowork
Claude Code与Claude Cowork共享同一套插件系统。安装后将自动完成完整配置,包括MCP服务器与生命周期钩子。
CLI方式:
claude plugin marketplace add aliyun/alibabacloud-opensearch-memory
claude plugin install agentic-memory@agentic-memory-pluginsCowork桌面应用方式:打开Cowork标签页,在侧边栏单击Customize,单击Browse plugins,然后安装Agentic Memory。
安装后自动注册的生命周期钩子如下。
钩子事件 | 触发条件 | 功能 |
SessionStart | 启动、恢复或上下文压缩后 | 加载历史记忆作为启动上下文 |
UserPromptSubmit | 每次提交提示词 | 将相关记忆注入提示 |
PreToolUse | 调用Write或Edit工具前 | 拦截对记忆文件的直接写入 |
PreCompact | 上下文压缩前 | 生成压缩前摘要 |
TaskCompleted | 任务完成时 | 保存本次任务的学习成果 |
Stop | 回合结束时 | 提醒Agent持久化学习成果 |
Cursor
若此前已在Cursor的MCP设置中配置过agentic-memory,请先移除已有条目,避免工具重复注册。
手动配置方式仅接入MCP服务器,不含钩子与Skill。在.cursor/mcp.json中添加以下内容。
{
"mcpServers": {
"agentic-memory": {
"url": "${env:AGENTIC_MEMORY_BASE_URL}/v1/agentic-memory/mcp",
"headers": {
"Authorization": "Bearer ${env:AGENTIC_MEMORY_API_KEY}"
}
}
}
}若需同时获得Skill与生命周期钩子(sessionStart、beforeSubmitPrompt、preToolUse、preCompact、stop共5个事件),请改用插件安装方式,插件仓库已内置Cursor插件清单。
Codex
Codex提供两种接入方案,请勿同时使用。插件清单会通过.codex-mcp.json自动注册agentic-memory为MCP服务器,若再手动添加[mcp_servers.agentic-memory]会导致重复注册。
方案A:直接配置MCP服务器
最快捷,仅获得MCP功能。Codex从~/.codex/config.toml读取MCP服务器配置,添加以下内容。
[mcp_servers.agentic-memory]
url = "${AGENTIC_MEMORY_BASE_URL}/v1/agentic-memory/mcp"
bearer_token_env_var = "AGENTIC_MEMORY_API_KEY"在Shell中导出AGENTIC_MEMORY_API_KEY与AGENTIC_MEMORY_BASE_URL,然后重启Codex。若当前Codex版本不支持在url中插值环境变量,请将${AGENTIC_MEMORY_BASE_URL}替换为步骤一获取的实际访问域名。
说明:codex mcp add仅支持stdio类型的服务器,Agentic Memory是HTTP服务器,只能在config.toml中直接配置,或通过Codex应用的Plugins > Connect to a custom MCP > Streamable HTTP界面配置。
方案B:侧加载插件
可获得完整体验,包括MCP服务器、Skill与可选的生命周期钩子。注册插件市场。
codex plugin marketplace add https://github.com/aliyun/alibabacloud-opensearch-memory.git重启Codex,运行/plugins,从Agentic Memory Plugins市场安装Agentic Memory。
管理插件的常用命令如下。
codex plugin marketplace upgrade # 拉取最新插件版本
codex plugin marketplace remove agentic-memory-plugins # 取消注册插件市场方案B可选步骤:启用生命周期钩子
Codex不会自动从插件清单加载钩子,仅读取~/.codex/hooks.json或<repo>/.codex/hooks.json。运行插件内置的安装脚本,将Agentic Memory的钩子配置合并进去。
python3 <插件安装目录>/scripts/install_codex_hooks.py脚本会向~/.codex/hooks.json合并3个条目,并把脚本路径改写为绝对路径,同时保留您已有的其他钩子。
事件 | 功能 |
SessionStart | 加载历史记忆作为启动上下文 |
UserPromptSubmit | 将相关记忆注入提示 |
Stop | 在回合结束时提醒Agent保存学习成果 |
注意:必须从codex plugin marketplace add侧加载得到的插件目录运行该脚本,不要从自行git clone的目录运行。脚本靠插件目录名识别自己写入的钩子条目,从自建克隆目录运行时,重复执行会重复追加条目,且--uninstall无法删除条目。
启用钩子还需在~/.codex/config.toml中打开codex_hooks特性开关,否则安装脚本会打印提示。修改后请重启Codex。
[features]
codex_hooks = true如需卸载钩子,执行python3 <插件安装目录>/scripts/install_codex_hooks.py --uninstall。由于钩子文件中存储的是绝对路径,若移动或删除了插件目录,请从新位置重新运行安装脚本。
QoderWork
步骤1:克隆仓库并打包为zip文件
git clone https://github.com/aliyun/alibabacloud-opensearch-memory.git && zip -r alibabacloud-opensearch-memory.zip alibabacloud-opensearch-memory步骤2:导入Kit
在QoderWork中,通过右上角的Expert Kits > Install Kit导入alibabacloud-opensearch-memory.zip。
步骤3:手动替换MCP配置中的环境变量
QoderWork不支持在url中使用环境变量,需手动将~/.qoderwork/plugins-custom/agentic-memory/.mcp.json中的${AGENTIC_MEMORY_BASE_URL}和${AGENTIC_MEMORY_API_KEY}替换为实际值。
步骤4:手动合并钩子配置
QoderWork不支持hooks子目录,需手动将~/.qoderwork/plugins-custom/agentic-memory/hooks/hooks.json中的设置添加到~/.qoderwork/settings.json,并将其中的${CLAUDE_PLUGIN_ROOT}替换为实际路径前缀~/.qoderwork/plugins-custom/agentic-memory。
步骤5:为所有脚本添加执行权限
chmod +x ~/.qoderwork/plugins-custom/agentic-memory/scripts/*步骤6:重启QoderWork
Hermes
Hermes通过memory provider方式接入,与其他客户端的插件机制不同,不依赖环境变量,凭证写在插件的配置文件中。
步骤1:安装插件
hermes plugins install https://github.com/aliyun/alibabacloud-opensearch-memory-for-hermes.git注意:hermes plugins install仅安装插件文件,不保证为memory provider安装Python运行时依赖。安装完成后必须补齐依赖,二选一即可。交互式安装:运行
hermes memory setup,用方向键选择agentic_memory,由Hermes依据plugin.yaml自动安装pip_dependencies。手动安装:将依赖安装到Hermes实际使用的Python环境中,然后设置provider。
pip install requests
hermes config set memory.provider agentic-memory步骤2:配置插件
若选择交互式安装,插件会提示输入所有必需配置项;否则需手动创建配置文件$HERMES_HOME/agentic_memory.json。
配置项 | 默认值 | 说明 |
| 无,必填 | API基础URL,即步骤一获取的访问域名 |
| 无,必填 | Bearer Token,即步骤一获取的API Key |
| 空,首次运行时自动生成 | 用户标识 |
|
| Agent标识 |
说明:工作空间名由api_endpoint自动解析得出,无需配置。步骤3:配置MCP客户端
在~/.hermes/config.yaml中添加以下内容。
mcp_servers:
agentic-memory:
url: [YOUR_ENDPOINT]/v1/agentic-memory/mcp
headers:
Accept: application/json, text/event-stream
Authorization: Bearer [YOUR_API_TOKEN]步骤4:重启Hermes
重启Hermes以加载插件与MCP服务器。
步骤三:验证安装
验证服务端连通性
在配置客户端之前,可先用以下命令确认凭证与访问域名可用。返回serverInfo即表示连通正常。
curl -X POST "$AGENTIC_MEMORY_BASE_URL/v1/agentic-memory/mcp" \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-H "Authorization: Bearer $AGENTIC_MEMORY_API_KEY" \
-d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"verify","version":"1.0"}}}'若API Key无效,将返回HTTP 400与如下响应。
{"code":"CredentialsNotFound","message":"Invalid token","request_id":"..."}验证客户端接入
启动新会话,或重启当前会话。
输入
在我的记忆中搜索 hello。若
agentic-memory的工具出现并正常响应,则表示接入成功。
验证Hermes接入
检查Hermes是否已识别到该provider。
hermes memory status预期输出如下。
Provider: agentic-memory
Plugin: installed
Status: available随后启动Hermes会话,让Hermes记住一条信息,再让Hermes检索这条信息,必要时可按记忆ID删除。
MCP工具
插件接入的MCP服务器共提供18个工具,分为记忆、知识库、技能与混合检索四类。
类别 | 工具 | 说明 |
记忆 |
| 提交一次记忆写入,异步执行,返回 |
记忆 |
| 按 |
记忆 |
| 在当前工作空间内语义检索记忆 |
记忆 |
| 按ID获取单条记忆 |
记忆 |
| 按精确过滤条件分页返回记忆 |
记忆 |
| 按ID覆盖更新记忆正文 |
记忆 |
| 按ID删除单条记忆 |
知识库 |
| 依据文档元信息发现候选文档 |
知识库 |
| 按语义相关性检索文档片段或章节 |
知识库 |
| 获取指定文档的章节树 |
知识库 |
| 获取章节树节点的完整内容 |
知识库 |
| 在指定文档内做精确文本或正则匹配 |
知识库 |
| 按行范围读取文档原文 |
技能 |
| 列出当前工作空间可用的技能 |
技能 |
| 语义检索可复用的技能 |
技能 |
| 查看技能的完整内容或其关联文件 |
技能 |
| 创建、更新、删除技能 |
混合检索 |
| 一次调用跨记忆、技能、知识库文档检索 |
关于各工具的完整参数与返回结构,请参见通过MCP接入Agentic Memory智能体记忆服务。
记忆写入的关键行为
写入是异步的。
memory_add立即返回event_id与status: PENDING,需调用memory_event_status_get轮询至SUCCEEDED,才能拿到生成的记忆ID。一条消息可能被抽取成多条记忆。服务端会对输入做事实抽取与去重,写入数量与输入消息数不是一一对应;若输入中不含可抽取的事实,最终可能不产生任何记忆。
memory_search的filters必须是{"AND": [...]}结构。直接传入{"user_id": "xxx"}会返回HTTP 422错误filters must be exactly {'AND': [<entry>, ...]} with no other top-level keys。
更新插件
插件更新后(从插件市场拉取新版本,或重新本地安装),现有会话中的MCP服务器连接会持有过期句柄并停止响应,需重启客户端以重新连接。
Claude Code:在提示符中运行
/restart,或关闭后重新打开CLI。Cursor:退出并重新启动。
Codex:重启编辑器会话。
Hermes:重启Hermes。
重启后无需重新输入AGENTIC_MEMORY_API_KEY。插件的MCP配置在会话启动时(而非安装时)对${AGENTIC_MEMORY_API_KEY}做变量插值,因此只要环境变量已持久化设置(在Shell配置文件或~/.claude/settings.json的env块中),重启后即可自动重连。
若重启后仍无法重连,请检查新Shell中能否读到AGENTIC_MEMORY_API_KEY,并确认该值以OS-开头。
echo $AGENTIC_MEMORY_API_KEY使用限制
同一账号至多允许10个API Key同时启用。
创建API Key需通过账号安全验证(MFA验证或扫脸验证)。
生命周期钩子脚本依赖本地
jq命令。Codex的钩子安装脚本靠插件目录名识别自身写入的条目,从自建
git clone目录运行时,幂等替换与--uninstall均会失效。