Skip to content

docs(bot): document ov_server.api_key_type and exp_write_tools (#1994 + #2007)#2014

Merged
MaojiaSheng merged 4 commits into
volcengine:mainfrom
r266-tech:docs-bot-ov-server-api-key-type-exp-write-tools-r266
May 19, 2026
Merged

docs(bot): document ov_server.api_key_type and exp_write_tools (#1994 + #2007)#2014
MaojiaSheng merged 4 commits into
volcengine:mainfrom
r266-tech:docs-bot-ov-server-api-key-type-exp-write-tools-r266

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Document two bot.ov_server config fields added by recent feat PRs:

Both fields exist in OpenVikingConfig (bot/vikingbot/config/schema.py) but were not documented in bot/README.md or bot/README_CN.md. This patch adds 2 bullets per file (4 lines total, additive only) to the existing ov_server sub-list — same byte-mirror style as the surrounding root_api_key / account_id entries.

Why call out the agent_memory_enabled gate on exp_write_tools

exp_write_tools only takes effect when the OpenViking server has memory.agent_memory_enabled = true (defined in openviking_cli/utils/config/memory_config.py as MemoryConfig.agent_memory_enabled: bool = False, checked by openviking/session/compressor_v2.py). That gate lives in a different config namespace (server-side memory.*, not bot-side bot.ov_server.*), so the bullet states it explicitly to avoid the surprise of "I set exp_write_tools but nothing happens."

Verification

  • api_key_type: schema line api_key_type: Literal["root", "user"] = "root" (bot/vikingbot/config/schema.py:513), validator strips/lowercases input. Doc keeps to the verified contract from feat(bot):Support user-key OpenViking mode and align memory namespaces #1994 body wording; full client flow deferred to the source PR.
  • exp_write_tools: schema line exp_write_tools: list[str] = Field(default_factory=lambda: ["write_file", "edit_file"]) (bot/vikingbot/config/schema.py:519). Gate verified at compressor_v2.py:46 (if not getattr(config.memory, "agent_memory_enabled", False): return []).
  • No competing PR touches bot/README*.md for these fields (sibling-PR check clean).

Diff scope

  • 4 line additions total (2 bullets in EN, 2 bullets in ZH).
  • No formatting/style edits on existing content.
  • No code changes.

Codex adversarial review

  • Round 1 (gpt-5.5 xhigh): VERDICT: needs-attention — flagged missing agent_memory_enabled gate on exp_write_tools (0.85) and overclaimed api_key_type lifecycle (0.55).
  • Round 2 (gpt-5.5 xhigh) on this V2: VERDICT: approve — both findings resolved by tightening wording and adding the gate disclosure.

🤖 Generated with Claude Code

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2007 - Fully compliant

Compliant requirements:

  • Document api_key_type and exp_write_tools config fields
  • Update both English and Chinese README files

1994 - Fully compliant

Compliant requirements:

  • Document api_key_type config field
  • Update both English and Chinese README files
⏱️ 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.

@MaojiaSheng MaojiaSheng merged commit fb42a04 into volcengine:main May 19, 2026
1 check passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 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