Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
docs(agents): consolidate all unsubmitted zh fork edits (#2416)
Lilimamama18fe003fc3b4
diff --git a/docs/images/agents/zh/claude-code.md b/docs/images/agents/zh/claude-code.mdindex c6e629ceb..86cf4886a 100644--- a/docs/images/agents/zh/claude-code.md+++ b/docs/images/agents/zh/claude-code.md@@ -1,3 +1,4 @@+# Claude Code 接入为 [Claude Code](https://docs.claude.com/zh-CN/docs/claude-code/overview) 提供跨项目、跨 session 的长期记忆,越用越聪明。安装一次,每次对话自动召回和捕获,模型不需要主动调用任何工具。diff --git a/docs/images/agents/zh/cli.md b/docs/images/agents/zh/cli.mdindex ae41eba16..4377051db 100644--- a/docs/images/agents/zh/cli.md+++ b/docs/images/agents/zh/cli.md@@ -2,21 +2,21 @@面向开发者在本地终端直接安装、配置和使用 OpenViking CLI。-# 步骤1:在终端执行以下命令安装 OpenViking CLI,并进入配置流程:+## 步骤1:在终端执行以下命令安装 OpenViking CLI,并进入配置流程:```bashnpm i -g @openviking/cli && ov config```-# 步骤2:按提示填写 OpenViking 服务地址和 API Key。服务地址可使用:+## 步骤2:按提示填写 OpenViking 服务地址和 API Key。服务地址可使用:```texthttps://api.vikingdb.cn-beijing.volces.com/openviking```-# 步骤3:配置完成后,可运行以下命令查看 CLI 用法:+## 步骤3:配置完成后,可运行以下命令查看 CLI 用法:```bashov --helpdiff --git a/docs/images/agents/zh/cursor.md b/docs/images/agents/zh/cursor.mdindex 4534dc078..1fc19b4f9 100644--- a/docs/images/agents/zh/cursor.md+++ b/docs/images/agents/zh/cursor.md@@ -1,51 +1,29 @@+## 一、Cursor 接入 OpenViking 操作步骤-## 一、前置准备:获取 API Key+将 OpenViking 接入 Cursor 的流程,请在 Cursor 中按以下步骤操作:-所有 MCP 客户端的接入都依赖同一个 **Authorization Token**,即 OpenViking 控制台中的 API Key。请先按以下步骤获取并妥善保存。--### 1\.1 操作路径--1. 在左侧菜单选择 **用户管理**--2. 在用户列表中找到对应用户(个人版默认为 `default` / `admin`),点击 API Key 列右侧的 **复制** 图标--3. 将复制得到的 `ZGV\.\.\.hiMg` 形式的字符串妥善保存,作为后续所有 Agent 接入的 `Authorization` 值--**安全提示**:API Key 等同于账户密钥,请勿提交到 Git 仓库或公开渠道。建议通过环境变量或加密配置注入。------## 二、接入 Cursor 指南--以下为 OpenViking 标准接入 Cursor 的流程。--### 2\.1 接入步骤--#### 步骤 1:打开设置+### 步骤 1:打开 Cursor 设置在 Cursor 主界面右上角点击 **设置(齿轮图标)**,进入设置面板-#### 步骤 2:新增 MCP Server++### 步骤 2:新增 MCP Server在左侧菜单中选择 **Tools \& MCPs**,进入 MCP Servers 管理页。-点击 **Add Custom MCP** 按钮。+### 步骤 3:粘贴配置 JSON-#### 步骤 3:粘贴配置 JSON--在弹出的 **mcp\.json** 文件中粘贴以下 JSON,并将 `Authorization` 替换为第一章中复制的 API Key:+在弹出的 **mcp\.json** 文件中粘贴以下 JSON,其中 `Authorization` 等字段已经自动填入 API Key 值:```json{@@ -60,33 +38,38 @@}```-**关键说明**:`Authorization` 的值需带上 `Bearer` 前缀(注意空格),完整格式为 `Bearer \<API Key\>`。----#### 步骤 4:确认并启用+### 步骤 4:确认并启用保存 mcp\.json 配置文件并关闭后,Cursor 会自动建立 MCP 连接并加载工具列表。连接成功后,**`ov\-mcp\-server`** 会出现在 **Installed MCP Servers** 列表中,同时会显示已启用的工具数量(图中的 “10 tools enabled”)。配置完成后,可直接看到 `ov\-mcp\-server` 条目旁的开关呈绿色开启状态,代表服务已正常加载并就绪:-#### 步骤 5:MCP 连通性检查+### 步骤 5:MCP 连通性检查接入后建议通过两个简单 query 快速验证 MCP 是否正常工作。在 Cursor 对话框中依次输入:-**① ** **`ov ls`** — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构。+**① ** **`ov ls`** — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构:+```bash+ov ls+```-**② ****`ov health`** — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份。+**② ****`ov health`** — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份:+```bash+ov health+```-**验收标准**:`ov ls` 能返回 `agent / resources / session / user` 等目录;`ov health` 返回 `service initialized` 与当前用户名,即表示接入成功。++### 步骤 6:验收标准++`ov ls` 能返回 `agent / resources / session / user` 等目录;`ov health` 返回 `service initialized` 与当前用户名,即表示接入成功。-### 2\.2 配置参数说明+## 二、配置参数说明|字段|必填|说明||---|---|---|diff --git a/docs/images/agents/zh/hermes.md b/docs/images/agents/zh/hermes.mdindex 10b9079f0..2ae60b7a1 100644--- a/docs/images/agents/zh/hermes.md+++ b/docs/images/agents/zh/hermes.md@@ -1,10 +1,7 @@-# Hermes Agent[Hermes Agent](https://hermes-agent.nousresearch.com/) (Nous Research) 内置 OpenViking 记忆提供方。无需安装插件——把 Hermes 指向你的 OpenViking 服务即可,记忆存储、召回和抽取均原生支持。-## 配置--运行 Hermes 记忆配置向导:+## 步骤 1:运行 Hermes 记忆配置向导:```bashhermes memory setup@@ -18,7 +15,8 @@ hermes memory setup配置保存在 Hermes 的 `config.yaml` 和 `.env` 文件中。-## 验证++## 步骤 2:验证 Hermes 记忆状态```bashhermes memory status@@ -26,7 +24,7 @@ hermes memory status配置完成后,Hermes 自动使用 OpenViking 作为长期记忆——`viking_remember`、`viking_recall` 等记忆工具即刻可用。-## 参见+## 参考文档- [Hermes — OpenViking memory provider 文档](https://hermes-agent.nousresearch.com/docs/user-guide/features/memory-providers#openviking) — 完整配置指南- [部署指南](../guides/03-deployment.md) — 搭建 OpenViking 服务diff --git a/docs/images/agents/zh/mcp.md b/docs/images/agents/zh/mcp.mdindex b0bc02ce1..3b5bc6ab7 100644--- a/docs/images/agents/zh/mcp.md+++ b/docs/images/agents/zh/mcp.md@@ -1,6 +1,5 @@-# MCP 接入-步骤 1 MCP 配置+## 步骤 1:MCP 配置```json{@@ -15,8 +14,9 @@}```-**关键说明**:`Authorization` 的值需带上 `Bearer` 前缀(注意空格),完整格式为 `Bearer \<API Key\>`。+>**关键说明**:`Authorization` 的值需带上 `Bearer` 前缀(注意空格),完整格式为 `Bearer \<API Key\>`-步骤 2 测试 MCP 工具连通性++## 步骤 2:测试 MCP 工具连通性输入 `ov health` 检查 ov 的版本和连接状态diff --git a/docs/images/agents/zh/openclaw.md b/docs/images/agents/zh/openclaw.mdindex 358aef618..047934e2d 100644--- a/docs/images/agents/zh/openclaw.md+++ b/docs/images/agents/zh/openclaw.md@@ -5,10 +5,13 @@openclaw plugins install clawhub:@openviking/openclaw-plugin && openclaw openviking setup```-## 步骤 2:输入以下信息-执行安装命令后会依次提示输入以下信息,可复制后粘贴到你的 Agent 终端+## 步骤 2:复制 Base URL 和 API Key+执行安装命令后会依次提示输入 Base URL 和 API Key,可复制后粘贴到你的 Agent 终端-- Base URL: `https://api.vikingdb.cn-beijing.volces.com/openviking`+- Base URL: 复制以下 Base URL 到你的 Agent 终端+```text+https://api.vikingdb.cn-beijing.volces.com/openviking+```- API Key: 复制页面中展示的 API Key 到你的 Agent 终端## 步骤 3:重启 OpenClawdiff --git a/docs/images/agents/zh/trae.md b/docs/images/agents/zh/trae.mdindex 659f1a077..00226b30b 100644--- a/docs/images/agents/zh/trae.md+++ b/docs/images/agents/zh/trae.md@@ -13,43 +13,24 @@- 个人长期任务目标 / OKR / Roadmap 沉淀,Agent 在规划任务时自动对齐------## 二、前置准备:获取 API Key--所有 MCP 客户端的接入都依赖同一个 **Authorization Token**,即 OpenViking 控制台中的 API Key。请先按以下步骤获取并妥善保存:--1. 在左侧菜单选择 **用户管理**--2. 在用户列表中找到对应用户(个人版默认为 `default` / `admin`),点击 API Key 列右侧的 **复制** 图标--3. 将复制得到的 `ZGV\.\.\.hiMg` 形式的字符串妥善保存,作为后续所有 Agent 接入的 `Authorization` 值--**安全提示**:API Key 等同于账户密钥,请勿提交到 Git 仓库或公开渠道。建议通过环境变量或加密配置注入。-+## 二、Trae 接入 OpenViking 操作步骤------## 三、Trae 接入指南--**Trae** 是字节跳动推出的 AI IDE,原生支持通过 MCP 协议加载外部工具与上下文服务。以下为 OpenViking 的标准接入流程。--### 3\.1 接入步骤+**Trae** 是字节跳动推出的 AI IDE,原生支持通过 MCP 协议加载外部工具与上下文服务。请在 trae 按以下步骤操作:-#### 步骤 1:打开设置+### 步骤 1:打开 Trae 设置在 Trae 主界面右上角点击 **设置(齿轮图标)**,进入设置面板。-#### 步骤 2:进入 MCP 配置页+### 步骤 2:进入 MCP 配置页在左侧菜单中选择 **MCP**,进入 MCP Servers 管理页。-#### 步骤 3:新增 MCP Server+### 步骤 3:新增 MCP Server点击右侧的 **\+ 添加** 按钮,在下拉菜单中选择 **手动配置**。@@ -57,9 +38,9 @@-#### 步骤 4:粘贴配置 JSON+### 步骤 4:粘贴配置 JSON-在弹出的配置框中粘贴以下 JSON,并将 `Authorization` 替换为第二章中复制的 API Key:+在弹出的配置框中粘贴以下 JSON:```json{@@ -74,33 +55,38 @@}```-**关键说明**:`Authorization` 的值需带上 `Bearer` 前缀(注意空格),完整格式为 `Bearer \<API Key\>`。--#### 步骤 5:确认并启用+### 步骤 5:确认并启用点击 **确认** 按钮,Trae 会自动建立 MCP 连接并加载工具列表。连接成功后,`ov\-mcp\-server` 将出现在已配置的 MCP Servers 列表中。配置完成后,可在 MCP 管理页看到 `ov\-mcp\-server` 已加载并启用,右侧开关呈绿色:-#### 步骤 6:MCP 连通性检查+### 步骤 6:MCP 连通性检查接入后建议通过两个简单 query 快速验证 MCP 是否正常工作。在 Trae 对话框中依次输入:-**① ****`ov ls`** — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构。+**① ****`ov ls`** — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构:+```bash+ov ls+```-**② ****`ov health`** — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份。+**② ****`ov health`** — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份:+```bash+ov health+```-**验收标准**:`ov ls` 能返回 `agent / resources / session / user` 等目录;`ov health` 返回 `service initialized` 与当前用户名,即表示接入成功。+### 步骤:验收标准+`ov ls` 能返回 `agent / resources / session / user` 等目录;`ov health` 返回 `service initialized` 与当前用户名,即表示接入成功。-### 3\.2 配置参数说明+## 三、配置参数说明|字段|必填|说明||---|---|---|