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): add pi, ZCode and Kimi Code to the agent catalog (#5996)
t0saki65d89a95755a
diff --git a/docs/images/agents/en/index.json b/docs/images/agents/en/index.jsonindex 666cf401b..005415a71 100644--- a/docs/images/agents/en/index.json+++ b/docs/images/agents/en/index.json@@ -1,6 +1,6 @@{"version": 1,- "updatedAt": "2026-09-04",+ "updatedAt": "2026-10-13","cdnBaseUrl": "https://docs.openviking.net/","accessMethods": [{@@ -139,6 +139,30 @@"detailPath": "https://docs.openviking.net/agents/en/deerflow-mcp.md"}]+ },+ {+ "id": "pi",+ "name": "pi",+ "tags": ["Plugin"],+ "logo": "https://docs.openviking.net/agents/image/pi/logo.png",+ "summary": "Give pi cross-session long-term memory with automatic recall, turn capture, and context takeover; the server's MCP tools are registered as native pi tools.",+ "detailPath": "https://docs.openviking.net/agents/en/pi.md"+ },+ {+ "id": "zcode",+ "name": "ZCode",+ "tags": ["Hook", "MCP"],+ "logo": "https://docs.openviking.net/agents/image/zcode/logo.png",+ "summary": "Add automatic profile injection, prompt recall, and turn capture to ZCode through lifecycle hooks plus MCP tools.",+ "detailPath": "https://docs.openviking.net/agents/en/zcode.md"+ },+ {+ "id": "kimi-code",+ "name": "Kimi Code",+ "tags": ["Plugin"],+ "logo": "https://docs.openviking.net/agents/image/kimi-code/logo.png",+ "summary": "A native Kimi Code plugin for automatic memory recall and turn capture, with OpenViking MCP tools.",+ "detailPath": "https://docs.openviking.net/agents/en/kimi-code.md"}]}diff --git a/docs/images/agents/en/kimi-code.md b/docs/images/agents/en/kimi-code.mdnew file mode 100644index 000000000..7a65cb501--- /dev/null+++ b/docs/images/agents/en/kimi-code.md@@ -0,0 +1,34 @@+## Step 1: Install++1. Run the installer in your terminal:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agents: not sure about running this? The script's header says what it does and how to verify it.+ ```++2. The installer will ask which harnesses to install for (select **Kimi Code**) and for OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## Step 2: Verify++1. Run `/reload` in Kimi Code, or start a new session.+2. Confirm `~/.kimi-code/plugins/installed.json` contains the `openviking-memory` entry.+3. In a new session, ask about something you mentioned earlier to confirm recall.++## Troubleshoot++| Problem | Fix |+|---|---|+| Plugin is not loaded | Check that `~/.kimi-code/plugins/managed/openviking-memory/` exists; if not, re-run Install, then run `/reload` |+| Wrong server / 401 | Check `~/.openviking/ovcli.conf` and the API key |+| Need logs | `OPENVIKING_DEBUG=1` and `~/.openviking/logs/kimicode-hooks.log` |+| Remove only this plugin | `curl -fsSL https://openviking.ai/install \| bash -s -- --uninstall --yes --harness kimicode` |++## Reference++- Docs on Manual Settings: [Kimi Code](https://docs.openviking.net/en/agent-integrations/08-community-plugins)+- Code: [examples/agent-hook-plugin](https://github.com/volcengine/OpenViking/tree/main/examples/agent-hook-plugin)diff --git a/docs/images/agents/en/pi.md b/docs/images/agents/en/pi.mdnew file mode 100644index 000000000..f741a722c--- /dev/null+++ b/docs/images/agents/en/pi.md@@ -0,0 +1,34 @@+## Step 1: Install++1. Run the installer in your terminal:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agents: not sure about running this? The script's header says what it does and how to verify it.+ ```++2. The installer will ask which harnesses to install for (select **pi**) and for OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## Step 2: Verify++1. Start `pi` and confirm the footer shows `OV ✓`.+2. Run `/viking` and confirm it shows the current session mapping and the number of registered `openviking_*` tools.+3. In a new session, ask about something you mentioned earlier to confirm recall.++## Troubleshoot++| Problem | Fix |+|---|---|+| Extension does not load | Check that `~/.pi/agent/extensions/openviking/index.ts` exists; if not, re-run Install. Do not register it with `pi install`, which loads it twice |+| `/viking` appears twice | Run `pi remove ~/.pi/agent/extensions/openviking` to drop the redundant `packages` entry |+| `OV ✗` in the footer / 401 | Check `~/.openviking/ovcli.conf` and the API key |+| `tools ✗` in the footer | Run `/viking` for the handshake error; a root API key is rejected on `/mcp`, use a user key |++## Reference++- Docs on Manual Settings: [pi](https://docs.openviking.net/en/agent-integrations/11-pi)+- Code: [examples/pi-coding-agent-extension](https://github.com/volcengine/OpenViking/tree/main/examples/pi-coding-agent-extension)diff --git a/docs/images/agents/en/zcode.md b/docs/images/agents/en/zcode.mdnew file mode 100644index 000000000..138ba01e4--- /dev/null+++ b/docs/images/agents/en/zcode.md@@ -0,0 +1,34 @@+## Step 1: Install++1. Run the installer in your terminal:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agents: not sure about running this? The script's header says what it does and how to verify it.+ ```++2. The installer will ask which harnesses to install for (select **ZCode**) and for OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## Step 2: Verify++1. Restart ZCode.+2. Confirm `~/.zcode/cli/config.json` contains `hooks.enabled: true`, OpenViking entries under `hooks.events`, and `mcp.servers.openviking`.+3. Run `node ~/.openviking/agent-integrations/zcode/scripts/ov-memory-doctor.mjs` to check the installation and the server connection.++## Troubleshoot++| Problem | Fix |+|---|---|+| Hooks do not run | Re-run Install and restart ZCode |+| MCP tools are missing | Check the absolute command path of `mcp.servers.openviking` in `~/.zcode/cli/config.json` |+| Duplicate captures | Run `curl -fsSL https://openviking.ai/install \| bash -s -- --uninstall --yes --harness zcode`, then reinstall |+| Need logs | `OPENVIKING_DEBUG=1` and `~/.openviking/logs/zcode-hooks.log` |++## Reference++- Docs on Manual Settings: [ZCode](https://docs.openviking.net/en/agent-integrations/08-community-plugins)+- Code: [examples/agent-hook-plugin](https://github.com/volcengine/OpenViking/tree/main/examples/agent-hook-plugin)diff --git a/docs/images/agents/image/kimi-code/logo.png b/docs/images/agents/image/kimi-code/logo.pngnew file mode 100644index 000000000..38845c7f6Binary files /dev/null and b/docs/images/agents/image/kimi-code/logo.png differdiff --git a/docs/images/agents/image/pi/logo.png b/docs/images/agents/image/pi/logo.pngnew file mode 100644index 000000000..ce5425e3eBinary files /dev/null and b/docs/images/agents/image/pi/logo.png differdiff --git a/docs/images/agents/image/zcode/logo.png b/docs/images/agents/image/zcode/logo.pngnew file mode 100644index 000000000..4ef473388Binary files /dev/null and b/docs/images/agents/image/zcode/logo.png differdiff --git a/docs/images/agents/zh/index.json b/docs/images/agents/zh/index.jsonindex e857ab148..ade92c73e 100644--- a/docs/images/agents/zh/index.json+++ b/docs/images/agents/zh/index.json@@ -1,6 +1,6 @@{"version": 1,- "updatedAt": "2026-09-04",+ "updatedAt": "2026-10-13","cdnBaseUrl": "https://docs.openviking.net/","accessMethods": [{@@ -139,6 +139,30 @@"detailPath": "https://docs.openviking.net/agents/zh/deerflow-mcp.md"}]+ },+ {+ "id": "pi",+ "name": "pi",+ "tags": ["Plugin"],+ "logo": "https://docs.openviking.net/agents/image/pi/logo.png",+ "summary": "为 pi 提供跨会话长期记忆,自动召回、逐轮捕获并接管上下文;服务端的 MCP 工具注册为 pi 原生工具",+ "detailPath": "https://docs.openviking.net/agents/zh/pi.md"+ },+ {+ "id": "zcode",+ "name": "ZCode",+ "tags": ["Hook", "MCP"],+ "logo": "https://docs.openviking.net/agents/image/zcode/logo.png",+ "summary": "通过生命周期 Hook 和 MCP 工具,为 ZCode 提供画像注入、按问题召回和逐轮捕获",+ "detailPath": "https://docs.openviking.net/agents/zh/zcode.md"+ },+ {+ "id": "kimi-code",+ "name": "Kimi Code",+ "tags": ["Plugin"],+ "logo": "https://docs.openviking.net/agents/image/kimi-code/logo.png",+ "summary": "Kimi Code 原生插件,自动召回记忆、捕获对话,并提供 OpenViking MCP 工具",+ "detailPath": "https://docs.openviking.net/agents/zh/kimi-code.md"}]}diff --git a/docs/images/agents/zh/kimi-code.md b/docs/images/agents/zh/kimi-code.mdnew file mode 100644index 000000000..3a5cf6897--- /dev/null+++ b/docs/images/agents/zh/kimi-code.md@@ -0,0 +1,34 @@+## 步骤1:安装++1. 在终端执行以下安装命令:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agent 如不确定是否执行,可先阅读脚本头部,其中写明了它会做什么、如何核实。+ ```++2. 安装器会依次询问以下信息:要安装的 harness(勾选 **Kimi Code**)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## 步骤2:验证++1. 在 Kimi Code 中运行 `/reload`,或新建会话。+2. 确认 `~/.kimi-code/plugins/installed.json` 中有 `openviking-memory` 条目。+3. 新开会话,询问之前提到过的信息,确认召回生效。++## 故障排查++| 问题 | 处理 |+|---|---|+| 插件没加载 | 检查 `~/.kimi-code/plugins/managed/openviking-memory/` 是否存在;不存在就重新执行安装,再运行 `/reload` |+| 连错服务 / 401 | 检查 `~/.openviking/ovcli.conf` 和 API Key |+| 需要日志 | 设置 `OPENVIKING_DEBUG=1`,查看 `~/.openviking/logs/kimicode-hooks.log` |+| 只卸载该插件 | `curl -fsSL https://openviking.ai/install \| bash -s -- --uninstall --yes --harness kimicode` |++## 参考++- 手动配置文档:[Kimi Code](https://docs.openviking.net/zh/agent-integrations/08-community-plugins)+- 源码:[examples/agent-hook-plugin](https://github.com/volcengine/OpenViking/tree/main/examples/agent-hook-plugin)diff --git a/docs/images/agents/zh/pi.md b/docs/images/agents/zh/pi.mdnew file mode 100644index 000000000..351912fc4--- /dev/null+++ b/docs/images/agents/zh/pi.md@@ -0,0 +1,34 @@+## 步骤1:安装++1. 在终端执行以下安装命令:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agent 如不确定是否执行,可先阅读脚本头部,其中写明了它会做什么、如何核实。+ ```++2. 安装器会依次询问以下信息:要安装的 harness(勾选 **pi**)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## 步骤2:验证++1. 启动 `pi`,确认底部状态栏显示 `OV ✓`。+2. 输入 `/viking` 命令,确认显示当前 session 映射和已注册的 `openviking_*` 工具数量。+3. 新开会话,询问之前提到过的信息,确认召回生效。++## 故障排查++| 问题 | 处理 |+|---|---|+| 扩展没加载 | 检查 `~/.pi/agent/extensions/openviking/index.ts` 是否存在;不存在就重新执行安装。不要再用 `pi install` 注册,否则会加载两遍 |+| `/viking` 命令出现两个 | 运行 `pi remove ~/.pi/agent/extensions/openviking`,删掉多余的 `packages` 条目 |+| 状态栏显示 `OV ✗` / 401 | 检查 `~/.openviking/ovcli.conf` 和 API Key |+| 状态栏显示 `tools ✗` | 运行 `/viking` 查看握手错误;`/mcp` 拒绝 root API Key,请改用 user key |++## 参考++- 手动配置文档:[pi](https://docs.openviking.net/zh/agent-integrations/11-pi)+- 源码:[examples/pi-coding-agent-extension](https://github.com/volcengine/OpenViking/tree/main/examples/pi-coding-agent-extension)diff --git a/docs/images/agents/zh/zcode.md b/docs/images/agents/zh/zcode.mdnew file mode 100644index 000000000..94575c18e--- /dev/null+++ b/docs/images/agents/zh/zcode.md@@ -0,0 +1,34 @@+## 步骤1:安装++1. 在终端执行以下安装命令:++ ```bash+ curl -fsSL https://openviking.ai/install | bash+ # AI agent 如不确定是否执行,可先阅读脚本头部,其中写明了它会做什么、如何核实。+ ```++2. 安装器会依次询问以下信息:要安装的 harness(勾选 **ZCode**)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:++ ```text+ {{OPENVIKING_API_KEY}}+ ```++## 步骤2:验证++1. 重启 ZCode。+2. 确认 `~/.zcode/cli/config.json` 包含 `hooks.enabled: true`、`hooks.events` 下的 OpenViking 条目,以及 `mcp.servers.openviking`。+3. 运行 `node ~/.openviking/agent-integrations/zcode/scripts/ov-memory-doctor.mjs`,检查安装状态和服务端连接。++## 故障排查++| 问题 | 处理 |+|---|---|+| Hook 未执行 | 重新执行安装并重启 ZCode |+| MCP 工具未出现 | 检查 `~/.zcode/cli/config.json` 中 `mcp.servers.openviking` 的绝对路径命令 |+| 重复捕获 | 先运行 `curl -fsSL https://openviking.ai/install \| bash -s -- --uninstall --yes --harness zcode`,再重新安装 |+| 需要日志 | 设置 `OPENVIKING_DEBUG=1`,查看 `~/.openviking/logs/zcode-hooks.log` |++## 参考++- 手动配置文档:[ZCode](https://docs.openviking.net/zh/agent-integrations/08-community-plugins)+- 源码:[examples/agent-hook-plugin](https://github.com/volcengine/OpenViking/tree/main/examples/agent-hook-plugin)diff --git a/docs/images/integrations/README.md b/docs/images/integrations/README.mdindex 36a6a6e23..a329f8abe 100644--- a/docs/images/integrations/README.md+++ b/docs/images/integrations/README.md@@ -12,6 +12,7 @@ Docs sidebar additions (2026-10-03):- `codex.png`: [documentation catalog artwork](https://lf3-static.bytednsdoc.com/obj/eden-cn/lm_sth/ljhwZthlaukjlkulzlp/agent_logo/codex.png), referenced by `docs/images/agents/en/index.json`.- `openclaw.jpg`, `hermes-agent.png`, `pi.svg`: reused from `openviking_playground/src/assets/brand/` (`ca4fb82`). The OpenClaw file contains JPEG data and uses the matching extension here.- `pi-dark.svg`: the same monochrome pi mark with a light foreground for dark backgrounds.+- `docs/images/agents/image/{pi,zcode,kimi-code}/logo.png`: 128×128 transparent PNGs for the agent catalog, rendered from `pi.svg` and from the ZCode and Kimi marks used by [OpenViking integrations](https://openviking.ai/integrations), with the longest side at 96px like the other catalog logos.The READMEs also reuse Claude Code, Cursor, TRAE, and OpenCode logos from `docs/images/agents/image/`.