README
🚀 Mem0 MCP 服务器配置指南
本指南将指导你完成 Mem0 MCP 服务器的配置和使用,帮助你快速搭建记忆存储与检索服务。
🚀 快速开始
要运行 Mem0 MCP 服务器,请执行以下步骤:
# 安装依赖项
npm install mem0ai safeLogger
# 启动服务器
node src/index.js --mode [cloud/local] [--userId <默认用户ID>]
✨ 主要特性
- 支持云存储和本地存储两种模式,满足不同场景需求。
- 提供
add_memory和search_memory核心工具,方便记忆的添加和检索。 - 支持高级参数配置,可灵活定制记忆处理规则。
📦 安装指南
依赖安装
运行以下命令安装必要的依赖:
npm install mem0ai safeLogger
启动服务器
使用以下命令启动服务器:
node src/index.js --mode [cloud/local] [--userId <默认用户ID>]
其中,--mode 参数可选值为 cloud 或 local,分别代表云存储模式和本地存储模式。
💻 使用示例
基础用法
添加记忆
{
"content": "重要信息需要记住",
"userId": "user123",
"sessionId": "project-abc",
"metadata": {
"custom_instructions": "优先处理此记忆"
}
}
搜索记忆
{
"query": "最近的项目更新",
"userId": "user123",
"filters": {
"AND": [
{ "field": "project_id", "value": "abc123" },
{ "field": "timestamp", "operator": ">", "value": "2023-01-01" }
]
},
"top_k": 5
}
📚 详细文档
配置选项
MCP 服务器支持两种运行模式:
- 云存储模式:使用 Mem0 的云服务来存储和检索记忆。需要设置
MEM0_API_KEY环境变量。 - 本地存储模式:在本地使用 OpenAI embeddings 来处理记忆。需要设置
OPENAI_API_KEY环境变量。
核心工具
add_memory
- 说明:添加新的记忆内容到存储。
- 输入格式:
{
"content": string,
"userId": string,
"sessionId": string (可选),
"metadata": object (可选)
}
- 输出:返回成功状态或错误信息。
search_memory
- 说明:根据查询从存储中检索相关记忆。
- 输入格式:
{
"query": string,
"userId": string,
"filters": object (可选),
"top_k": number (可选, 默认10),
"threshold": number (可选, 默认0.3)
}
- 输出:返回匹配记忆列表及相似度评分。
高级参数
add_memory 的高级选项
{
"content": string,
"userId": string,
"sessionId": string (可选),
"metadata": {
"includes": string, // 特定包含的偏好
"excludes": string, // 特定排除的偏好
"immutable": boolean, // 是否不可变
"expiration_date": string, // 过期日期,格式: YYYY-MM-DD
"custom_instructions": string, // 项目特定指令
"version": string // 记忆版本,默认为 v2
}
}
search_memory 的高级选项
{
"query": string,
"userId": string,
"filters": {
"OR": [ 条件数组 ] |
"AND": [ 条件数组 ]
},
"top_k": number, // 最大返回结果数
"threshold": number, // 相似度阈值
"fields": string[], // 返回的具体字段
"rerank": boolean, // 是否重新排序,默认否
"keyword_search": boolean, // 是否关键词搜索,默认否
"filter_memories": boolean, // 是否过滤记忆,默认否
"org_id": string, // 组织 ID 过滤
"project_id": string // 项目 ID 过滤
}
环境变量
# 必需设置
MEM0_API_KEY=your_api_key # 云模式时需要
OR
OPENAI_API_KEY=your_api_key # 本地模式时需要
# 可选设置
DEFAULT_USER_ID=user123 # 默认用户 ID
PORT=3000 # 自定义服务端口
LOG_LEVEL=info # 日志级别
🔧 技术细节
安全注意事项
- 确保 API 密钥安全,避免泄露。
- 处理敏感数据时使用加密技术。
- 定期备份重要记忆数据。
错误处理
常见错误及解决方法: | 错误码 | 描述 | 解决方案 | | ---- | ---- | ---- | | 401 | 认证失败 | 检查 API 密钥是否正确 | | 500 | 服务内部错误 | 联系技术支持 | | 422 | 参数验证失败 | 确认输入格式和参数符合要求 |
性能优化
- 定期清理过期记忆。
- 配置合适的缓存策略。
- 使用负载均衡处理高并发请求。
监控与日志
- 集成应用性能监控工具。
- 分析日志文件以排查问题。
- 设置警报机制及时响应异常情况。
故障排除
如果遇到问题,请参考以下步骤:
- 检查服务是否正常运行。
- 查看最新日志获取错误信息。
- 确认 API 密钥和配置是否正确。
- 联系 Mem0 支持团队寻求帮助。
附录
- 支持的过滤操作符:
=,>,<,>=,<=,!= - 日志格式:
[timestamp] [level] [message] - 默认端口:3000
⚠️ 重要提示
本文档内容可能会更新,建议定期查阅 Mem0 官方文档获取最新信息。
Scan to contact