|
1 | | -# start-application-cap 帮助文档 |
2 | 1 |
|
3 | | -CAP应用示例模版 |
| 2 | +> 注:当前项目为 Serverless Devs 应用,由于应用中会存在需要初始化才可运行的变量(例如应用部署地区、函数名等等),所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用,**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化,详情可参考[部署 & 体验](#部署--体验) 。 |
| 3 | +
|
| 4 | +# mcp-agentloop-memory 帮助文档 |
| 5 | + |
| 6 | +<description> |
| 7 | + |
| 8 | +AgentLoop Memory MCP Server |
| 9 | + |
| 10 | +</description> |
| 11 | + |
| 12 | + |
| 13 | +## 资源准备 |
| 14 | + |
| 15 | +使用该项目,您需要有开通以下服务并拥有对应权限: |
| 16 | + |
| 17 | +<service> |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +| 服务/业务 | 权限 | 相关文档 | |
| 22 | +| --- | --- | --- | |
| 23 | +| 函数计算 | AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) | |
| 24 | + |
| 25 | +</service> |
| 26 | + |
| 27 | +<remark> |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +</remark> |
| 32 | + |
| 33 | +<disclaimers> |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +</disclaimers> |
| 38 | + |
| 39 | +## 部署 & 体验 |
| 40 | + |
| 41 | +<appcenter> |
| 42 | + |
| 43 | +- :fire: 通过 [云原生应用开发平台 CAP](https://functionai.console.aliyun.com/template-detail?template=mcp-agentloop-memory) ,[](https://functionai.console.aliyun.com/template-detail?template=mcp-agentloop-memory) 该应用。 |
| 44 | + |
| 45 | +</appcenter> |
| 46 | +<deploy> |
| 47 | + |
| 48 | + |
| 49 | +</deploy> |
| 50 | + |
| 51 | +## 案例介绍 |
| 52 | + |
| 53 | +<appdetail id="flushContent"> |
| 54 | + |
| 55 | +### alibabacloud-agentloop-memory-mcp-server |
| 56 | + |
| 57 | +阿里云 AgentLoop MemoryStore 的 MCP Server 实现,为 AI Agent 提供长期记忆管理能力,支持通过 MCP 协议(SSE 传输)进行记忆的增删改查和语义搜索。 |
| 58 | + |
| 59 | +#### AgentLoop MemoryStore |
| 60 | + |
| 61 | +[AgentLoop MemoryStore](https://www.alibabacloud.com/) 是阿里云提供的全托管 AI Agent 长期记忆服务。它为 AI Agent 提供智能记忆层,使其能够跨会话记住用户偏好、持续学习并实现个性化交互,适用于智能客服、个人助理、教育辅导等场景。 |
| 62 | + |
| 63 | +**核心特性:** |
| 64 | + |
| 65 | +- **多维度记忆**:自动从对话中提取用户偏好、事实陈述、会话摘要等结构化记忆,支持自定义提取策略 |
| 66 | +- **分层检索**:L1 混合检索 → L2 Rerank 精排 → L3 Agentic Search,兼顾召回广度与精度 |
| 67 | +- **异步提取**:记忆处理异步执行,不阻塞 Agent 主流程,支持弹性扩缩容 |
| 68 | +- **全托管**:无需搭建向量数据库或维护存储实例,开通即用 |
| 69 | +- **可观测**:内置监控大盘,覆盖检索延迟、Token 消耗、存储量等核心指标 |
| 70 | + |
| 71 | +本案例将 AgentLoop MemoryStore 封装为标准 [MCP](https://modelcontextprotocol.io/) Server,支持 Cursor、Claude Desktop 等 MCP 客户端直接接入。 |
| 72 | + |
| 73 | + |
| 74 | +#### 安装 |
| 75 | + |
| 76 | +```bash |
| 77 | +pip install alibabacloud-agentloop-memory-mcp-server |
| 78 | +``` |
| 79 | + |
| 80 | +#### 快速开始 |
| 81 | + |
| 82 | +##### 1. 配置环境变量 |
| 83 | + |
| 84 | +```bash |
| 85 | +export ALIBABA_CLOUD_ACCESS_KEY_ID=your_access_key_id |
| 86 | +export ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_access_key_secret |
| 87 | +export ALIBABA_CLOUD_REGION_ID=cn-hangzhou |
| 88 | +export ALIBABA_CLOUD_WORKSPACE=your_workspace_name |
| 89 | +export ALIBABA_CLOUD_MEMORY_STORE=your_memory_store_name |
| 90 | +``` |
| 91 | + |
| 92 | +##### 2. 启动服务 |
| 93 | + |
| 94 | +```bash |
| 95 | +# 使用 python -m 启动 |
| 96 | +python -m mcp_server_agentloop_memory |
| 97 | + |
| 98 | +# 或使用命令行入口 |
| 99 | +alibabacloud-agentloop-memory-mcp-server |
| 100 | + |
| 101 | +# 指定参数启动 |
| 102 | +python -m mcp_server_agentloop_memory \ |
| 103 | + --access-key-id <your_ak_id> \ |
| 104 | + --access-key-secret <your_ak_secret> \ |
| 105 | + --region-id cn-hangzhou \ |
| 106 | + --workspace <workspace_name> \ |
| 107 | + --memory-store <memory_store_name> \ |
| 108 | + --port 8080 |
| 109 | +``` |
| 110 | + |
| 111 | +##### 3. 连接 MCP Client |
| 112 | + |
| 113 | +服务启动后,MCP Client 通过 SSE 连接: |
| 114 | + |
| 115 | +``` |
| 116 | +GET http://localhost:8080/mcp/{client_name}/sse/{user_id} |
| 117 | +``` |
| 118 | + |
| 119 | +- `client_name`:客户端标识(如 `cursor`、`my-agent`),映射为 `agent_id` |
| 120 | +- `user_id`:用户标识,用于隔离不同用户的记忆数据 |
| 121 | + |
| 122 | +#### CLI 参数 |
| 123 | + |
| 124 | +| 参数 | 环境变量 | 默认值 | 说明 | |
| 125 | +|------|---------|--------|------| |
| 126 | +| `--access-key-id` | `ALIBABA_CLOUD_ACCESS_KEY_ID` | - | 阿里云 AccessKey ID | |
| 127 | +| `--access-key-secret` | `ALIBABA_CLOUD_ACCESS_KEY_SECRET` | - | 阿里云 AccessKey Secret | |
| 128 | +| `--region-id` | `ALIBABA_CLOUD_REGION_ID` | `cn-hangzhou` | 阿里云区域 | |
| 129 | +| `--workspace` | `ALIBABA_CLOUD_WORKSPACE` | - | Workspace 名称 | |
| 130 | +| `--memory-store` | `ALIBABA_CLOUD_MEMORY_STORE` | - | Memory Store 名称 | |
| 131 | +| `--host` | - | `0.0.0.0` | 监听地址 | |
| 132 | +| `--port` | - | `8080` | 监听端口 | |
| 133 | +| `--log-level` | - | `INFO` | 日志级别 | |
| 134 | + |
| 135 | +#### MCP Tools |
| 136 | + |
| 137 | +| 工具名 | 参数 | 说明 | |
| 138 | +|--------|------|------| |
| 139 | +| `add_memories` | `text: str` | 添加记忆。当用户分享个人信息、偏好或要求记住某些内容时调用 | |
| 140 | +| `search_memory` | `query: str` | 语义搜索记忆。用户提问时自动调用,返回按相关度排序的记忆 | |
| 141 | +| `list_memories` | 无 | 列出当前用户的所有记忆 | |
| 142 | +| `delete_memories` | `memory_ids: list[str]` | 按 ID 删除指定记忆 | |
| 143 | +| `delete_all_memories` | 无 | 删除当前用户的所有记忆 | |
| 144 | + |
| 145 | +#### 权限要求 |
| 146 | + |
| 147 | +需要阿里云 RAM 用户具有 AgentLoop MemoryStore 相关 API 的访问权限。获取和管理 AccessKey 请参考[阿里云 AccessKey 管理](https://help.aliyun.com/document_detail/53045.html)。 |
| 148 | + |
| 149 | +#### 开发 |
| 150 | + |
| 151 | +```bash |
| 152 | +# 安装开发依赖 |
| 153 | +pip install -e ".[dev]" |
| 154 | + |
| 155 | +# 运行测试(需要配置环境变量) |
| 156 | +pytest tests/ -v |
| 157 | +``` |
| 158 | + |
| 159 | + |
| 160 | + |
| 161 | + |
| 162 | +</appdetail> |
| 163 | + |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | +## 使用流程 |
| 171 | + |
| 172 | +<usedetail id="flushContent"> |
| 173 | + |
| 174 | +部署完成拿到 URL 后,准备好支持 SSE 的 MCP Client,通过 SSETransport 进行连接。 |
| 175 | + |
| 176 | +</usedetail> |
| 177 | + |
| 178 | +## 二次开发指南 |
| 179 | + |
| 180 | +<development id="flushContent"> |
| 181 | +</development> |
| 182 | + |
| 183 | + |
| 184 | + |
| 185 | + |
| 186 | + |
| 187 | + |
0 commit comments