Skip to content

社区插件 ​

社区维护的各运行时集成。各插件在目标平台、集成深度和维护状态上各有差异,使用前请先阅读各自的 README。

ZCode 记忆集成 ​

源码:examples/agent-hook-plugin

ZCode 社区集成通过配置驱动的生命周期 Hook 和 OpenViking MCP 服务提供跨项目、跨会话记忆:

  • SessionStart 注入用户画像。
  • UserPromptSubmit 召回相关记忆。
  • PreToolUse 将直接读取 viking:// 的操作引导至 MCP 工具。
  • Stop 在 detached worker 中捕获 rollout 里的未处理回合,并 commit OpenViking session。

ZCode 不提供 PreCompact、SessionEnd 和 subagent 生命周期 Hook。因此该适配器在 Stop 时 commit,以 ZCode rollout 文件作为权威增量对话源,只有 rollout 文件不可用时才回退到 Hook stdin。

安装 ​

前置条件:Node.js 18+、正在运行的 OpenViking 服务,以及 ZCode。

bash
curl -fsSL https://openviking.ai/install | bash
# AI agent 如不确定是否执行,可先阅读脚本头部,其中写明了它会做什么、如何核实。

安装器通过 ~/.zcode/ 或 zcode 二进制检测 ZCode,将运行时安装到 ~/.openviking/agent-integrations/zcode/,并把 Hook 与 MCP 配置合并到 ~/.zcode/cli/config.json。

重启 ZCode 后,请确认:

  • ~/.zcode/cli/config.json 包含 hooks.enabled: true、hooks.events 下的 OpenViking 条目,以及 mcp.servers.openviking。
  • 设置 OPENVIKING_DEBUG=1 后,可在 ~/.openviking/logs/zcode-hooks.log 查看诊断日志。
现象原因处理方式
Hook 未执行Hook 配置被禁用或已过期重跑安装器并重启 ZCode
召回为空OpenViking 不可用或记忆尚未提取检查 curl http://127.0.0.1:1933/health,并等待提取完成
MCP 工具未出现MCP proxy 启动失败检查 ~/.zcode/cli/config.json 中 mcp.servers.openviking 的绝对路径命令
重复捕获旧安装留下了重复 Hook 条目先运行 curl -fsSL https://openviking.ai/install | bash -s -- --uninstall --yes --harness zcode,再重新安装

实现细节与当前已验证的 ZCode 假设见插件目录中的 README 和 DESIGN.md。

Kimi Code 记忆集成 ​

源码:examples/agent-hook-plugin

Kimi Code 集成是原生 managed plugin。它复用 OpenViking 的共享 Hook 运行时,只在适配层保留 Kimi 特有的事件映射、wire transcript 解码、输出格式和 commit 策略:

  • UserPromptSubmit 召回记忆,并输出 Kimi 可直接注入的原始文本。
  • PreToolUse 拒绝 Read/Glob/Grep 直接访问 viking:// URI。
  • Stop、PreCompact 和 SessionEnd 增量捕获 wire.jsonl 回合;Interrupt 同步执行同一捕获流程,全部 OpenViking 请求共用 2 秒总预算。
  • 原生插件 manifest 提供 OpenViking MCP server,不修改 Kimi 的旧式配置文件。

安装 ​

前置条件:Node.js 18+、正在运行的 OpenViking 服务,以及 Kimi Code CLI。

bash
curl -fsSL https://openviking.ai/install | bash
# AI agent 如不确定是否执行,可先阅读脚本头部,其中写明了它会做什么、如何核实。

安装器会在 $KIMI_CODE_HOME/plugins/managed/openviking-memory/ 下组装自包含运行时(Kimi home 默认为 ~/.kimi-code/),并且只更新 plugins/installed.json 中的 openviking-memory 记录,不动其他插件。 重跑同一命令可升级。只卸载该插件:

bash
curl -fsSL https://openviking.ai/install | bash -s -- --uninstall --yes --harness kimicode

已验证的宿主契约和版本见 hosts/kimicode/DESIGN.md。

AstrBot 插件 ​

AstrBot 是一个多平台 IM Bot 框架,支持 QQ、Telegram、Discord、飞书等 20+ 平台。

源码:astrbot_plugin_openviking_memory

为 AstrBot 提供群聊/私聊的自动捕获、LLM 请求前的语义召回,以及可配置的 venue 记忆隔离。

安装:在 AstrBot WebUI → 插件市场搜索 OpenViking Memory 并安装;或从链接安装:https://github.com/t0saki/astrbot_plugin_openviking_memory.git

当前插件要求 AstrBot 4.23.1+ 和兼容的 OpenViking 服务。global 使用 User Key;venue 需要 Admin Key 创建用户。迁移旧配置前,先核对上方插件 README。

主要特性:

  • 基于 hooks 的自动召回与捕获,模型不需要主动调用工具
  • self_scope=global 共用一个 Bot 身份,venue 为群/私聊分别创建用户;每个人以 peer 表示。旧版 isolation_mode 会映射到这两种范围。
  • 按消息数、token 阈值或空闲超时自动 commit
  • 首次接入群聊时自动拉取平台历史消息入库

Open WebUI tool server ​

Open WebUI 是一个自托管的 AI 聊天界面。

源码:examples/openwebui-plugin

一个独立的 FastAPI server,把 OpenViking 的一组精选端点以 OpenAPI tools 形式暴露,让 Open WebUI 作为原生工具调用。部署与端点说明见 README。

更多示例 ​

examples/ 目录下还有 Agent 插件之外的部署与集成示例——Grafana 面板、Kubernetes Helm chart、多租户配置、快照流程和 SDK 片段等。

参见 ​

Open source under the AGPL-3.0 License. Font licenses