Enhance documentation and configuration for Memory Gateway and agent plugin

config.example.yaml

@@ -1,27 +1,28 @@
-# Memory Gateway 配置示例
-# 复制为 config.yaml 并根据实际情况修改
+# Memory Gateway 配置示例。
+# 复制为 config.yaml 并根据实际服务器路径、端口和密钥修改。
+# 不要提交 config.yaml；它应包含本机/服务器密钥。
 
 # Memory Gateway 服务配置
 server:
-  # 监听地址，0.0.0.0 表示接受所有网卡（局域网可访问）
-  host: "0.0.0.0"
-  # MCP Server 端口
+  # 本机测试可用 127.0.0.1；需要远程调用时使用 0.0.0.0 并配置防火墙/反向代理。
+  host: "127.0.0.1"
+  # REST API、MCP RPC 和 SSE 共用端口。
   port: 1934
-  # 可选：API Key 认证，客户端需要提供相同的 Key
+  # 强烈建议生产/远程调用时设置；客户端通过 X-API-Key 传入。
   api_key: ""
 
 # OpenViking 后端配置
 openviking:
-  # OpenViking 服务器地址
-  url: "http://localhost:1933"
-  # OpenViking API Key（如有）
+  # OpenViking 服务器地址。Memory Gateway 通过它检索 context/resource/memory。
+  url: "http://127.0.0.1:1933"
+  # OpenViking API Key。按 OpenViking 实际配置填写。
   api_key: ""
-  # 请求超时时间（秒）
   timeout: 30
 
 # EverMemOS 后台长期记忆整理服务
 evermemos:
   enabled: true
+  # 可以是本机 memory_gateway.evermemos_service，也可以是远程 EverMemOS 服务。
   url: "http://127.0.0.1:1995"
   api_key: ""
   timeout: 30
@@ -33,9 +34,8 @@ evermemos:
 
 # 记忆配置
 memory:
-  # 默认命名空间
+  # 旧 /api/* 接口使用的默认命名空间。v1 API 会按 user/agent/workspace/session 自动展开 namespace。
   default_namespace: "memory-gateway"
-  # 默认搜索返回数量
   search_limit: 10
 
 # 日志配置
@@ -52,13 +52,16 @@ llm:
   timeout: 60
   max_input_chars: 24000
 
-# Obsidian 配置：用于 /api/knowledge/upload 保存 Markdown 笔记
+# Obsidian Vault 配置。
+# 服务端不要求安装 Obsidian 桌面应用；这里本质上是一个 Markdown vault 目录。
 obsidian:
-  vault_path: "/home/tom/memory-gateway/obsidian-vault"
+  vault_path: "/opt/memory-gateway/obsidian-vault"
   knowledge_dir: "01_Knowledge/Uploaded"
   review_dir: "Reviews/Queue"
 
-# v1 metadata storage. Use "memory" only for isolated unit tests.
+# v1 metadata storage。
+# SQLite 保存 users、memories、episodes、profiles、audit，是用户隔离和 ACL 判断的主要 metadata store。
+# Use "memory" only for isolated unit tests.
 storage:
   backend: "sqlite"
-  sqlite_path: "/home/tom/memory-gateway/memory_gateway.sqlite3"
+  sqlite_path: "/opt/memory-gateway/data/memory_gateway.sqlite3"