Skip to content

docs(channel): document ov_tools_enable config introduced in #1352#1571

Merged
qin-ctx merged 2 commits intovolcengine:mainfrom
r266-tech:docs/channel-ov-tools-enable-1352-v2
Apr 19, 2026
Merged

docs(channel): document ov_tools_enable config introduced in #1352#1571
qin-ctx merged 2 commits intovolcengine:mainfrom
r266-tech:docs/channel-ov-tools-enable-1352-v2

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

PR #1352 (merged 2026-04-17, shipped in v0.3.9) added a new ov_tools_enable: bool = True field to BaseChannelConfig so operators can disable OpenViking tools and memory/user-profile context injection per channel. The implementation landed in:

  • bot/vikingbot/config/schema.py: new ov_tools_enable field on BaseChannelConfig
  • bot/vikingbot/agent/loop.py: _get_channel_config + _get_ov_tools_enable wiring
  • bot/vikingbot/agent/context.py: gates openviking_search memory lookup and Current user's information profile injection on ov_tools_enable
  • bot/vikingbot/agent/tools/registry.py: filters openviking_* tool definitions when the flag is off

However, neither bot/README.md nor bot/README_CN.md referenced the new option. Users reading the channel config example would see only type/enabled/appId/allowFrom/… and would have to read config/schema.py to discover that they can turn off OV for a given channel.

Changes

bot/README.md (+3 lines):

  • Added "ov_tools_enable": true to the feishu channel example in the ov.conf JSON
  • Added a channels.*.ov_tools_enable row to the Security options table describing the default (true), the effect when false (no openviking_* tools, no OV memory/profile context), and a link to feat(bot): Add disable OpenViking config for channels. #1352

bot/README_CN.md (+3 lines): same content, translated to Chinese.

Both changes slot into sections that already document channels.*.allowFrom, so they follow the same documentation pattern as prior channel-level options.

Test plan

  • Pure docs — no code touched, no tests required
  • JSON example still valid (checked keys + commas)
  • Field name matches source of truth (bot/vikingbot/config/schema.py line 62, ov_tools_enable: bool = True)
  • Single r266-tech author, no Co-Authored-By trailer

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1352 - Fully compliant

Compliant requirements:

  • Document the new ov_tools_enable config option in both English and Chinese READMEs
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit 1e60de2 into volcengine:main Apr 19, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Apr 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants