Skip to content

docs: add agent integration assets#2306

Merged
ZaynJarvis merged 2 commits into
volcengine:mainfrom
yufeng201:feat/agents-tos-assets
May 29, 2026
Merged

docs: add agent integration assets#2306
ZaynJarvis merged 2 commits into
volcengine:mainfrom
yufeng201:feat/agents-tos-assets

Conversation

@yufeng201
Copy link
Copy Markdown
Contributor

Description

Add static agent integration assets under the docs public asset tree so the docs deployment can serve a stable agent list and per-agent Markdown guides.

Related Issue

N/A

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Added docs/images/agents/index.json with agent card metadata, logo URLs, tags, summaries, and detail links.
  • Added Markdown detail pages for OpenClaw, Hermes, Claude Code, Codex, TRAE, and Opencode.
  • Served the assets through the existing VitePress public asset flow, producing stable /agents/* paths in the docs build.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Validated locally with:

  • python3 -m json.tool docs/images/agents/index.json
  • ./node_modules/.bin/vitepress build . from docs/

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

N/A

Additional Notes

The Markdown files live under docs/images/agents/ because the docs VitePress config uses images as publicDir. After build, these files are available under stable /agents/ URLs.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🏅 Score: 85
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Internal Image Links

Contains internal Lark image URLs with temporary auth codes; external users cannot access these. Replace with public CDN-hosted images.

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MTNkMDA0ZDBhZGRmODlkNmNjMGRiMGEwZTIyMzZlNThfMmNkMmZlZjA1ZWJjNTAyMGMzODFiNmRiZDk2ZTU3ZDhfSUQ6NzY0NDUxMTgwNDM5NjI3NjkzNl8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

---

# 三、Trae 接入指南

**Trae** 是字节跳动推出的 AI IDE,原生支持通过 MCP 协议加载外部工具与上下文服务。以下为 OpenViking 的标准接入流程。

## 3\.1 接入步骤

### 步骤 1 · 打开设置

在 Trae 主界面右上角点击 **设置(齿轮图标)**,进入设置面板。

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=ZjI2NTRmZGYzZWZlM2QxOWFlNGQzNzRlM2UzMWY5YmZfZTMzMWRhMDdiN2MwNmVmNzU0OWQ5MTQ3YTk2YmUwMGRfSUQ6NzY0NDUxMTk4NjYyNjAwNTk0OF8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 2 · 进入 MCP 配置页

在左侧菜单中选择 **MCP**,进入 MCP Servers 管理页。

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MDk3NGYwN2ZhNWU3NTg1ZTI3ZWMyYzMyZTlhZDkwNDJfMDgyZGQwNWMzMjkyN2Y0NmU3OTU2ZTJmMGRkZmI4YmJfSUQ6NzY0NDUxMjA1Njk2NTY5NjQ4MV8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 3 · 新增 MCP Server

点击右侧的 **\+ 添加** 按钮,在下拉菜单中选择 **手动配置**![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=YjY4NTg3OGM4MzJkNjE4OGUzNzY2MThiNmI1YjRhNTBfZDU4ZmUwZTU0MzU5OTQ0OWE3ZDNmMzJmODg1NzYyNDJfSUQ6NzY0NDUxMjE2NDcyNDU5MTU0N18xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MjFmMWE0MmY3Njc5MTVmN2E3NjY3ODQ2MWY0YWEyZTRfZGFlMjI3YzU3MTRmYzVhNWI1NGVkYzJiZmY5NGZiMTRfSUQ6NzY0NDU2NTk1NzU2NTk0MjcyNl8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 4 · 粘贴配置 JSON

在弹出的配置框中粘贴以下 JSON,并将 `Authorization` 替换为第二章中复制的 API Key:

```json
{
  "mcpServers": {
    "ov-mcp-server": {
      "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",
      "headers": {
        "Authorization": "Bearer ZGVmYXV********YzdlZjhiMg"
      }
    }
  }
}

关键说明Authorization 的值需带上 Bearer 前缀(注意空格),完整格式为 Bearer \<API Key\>

Image

步骤 5 · 确认并启用

点击 确认 按钮,Trae 会自动建立 MCP 连接并加载工具列表。连接成功后,ov\-mcp\-server 将出现在已配置的 MCP Servers 列表中。配置完成后,可在 MCP 管理页看到 ov\-mcp\-server 已加载并启用,右侧开关呈绿色:

Image

步骤 6 · MCP 连通性检查

接入后建议通过两个简单 query 快速验证 MCP 是否正常工作。在 Trae 对话框中依次输入:

**① **ov ls — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构。

Image

**② **ov health — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份。

Image

验收标准ov ls 能返回 agent / resources / session / user 等目录;ov health 返回 service initialized 与当前用户名,即表示接入成功。

3.2 配置参数说明

字段 必填 说明
mcpServers MCP Server 配置根节点
ov\-mcp\-server 服务别名,可自定义;建议保持与上下文识别一致
url OpenViking MCP 服务端点;CN 区固定为 https://api\.vikingdb\.cn\-beijing\.volces\.com/openviking/mcp
headers\.Authorization 格式 Bearer \<API Key\>,来源见第二章

四、常见问题(FAQ)

问题 解决建议
连接失败 / 401 Unauthorized 检查 Authorization 是否带 Bearer 前缀;确认 API Key 未过期或被重置
连接失败 / 网络超时
确认网络可访问 api\.vikingdb\.cn\-beijing\.volces\.com;企业网络请配置代理白名单
Agent 无法识别工具 检查 MCP Server 是否已"启用";部分客户端需重启进程后加载新配置
mcp工具因 argument schema 与当前模型不兼容,请切换/修复 mcp server 或切换模型 (4027) Image
Image
尝试切换模型或升级到最新版 Trae

</details>

<details><summary><a href='https://github.com/volcengine/OpenViking/pull/2306/files#diff-3e7a218bae73aa91555a37a68455e90b034cc42e92415bec4a58f884266fae9aR1-R1'><strong>Missing Top-Level Heading</strong></a>

Starts with level-2 heading instead of level-1, inconsistent with other agent Markdown files.
</summary>

```markdown
## 步骤 1 安装 OpenViking
HTML Entities in Markdown

Uses HTML entities (", <) instead of plain Markdown characters, which may render poorly.

- 记忆历史决策与\&\#34;踩坑笔记\&\#34;(为什么不用 X、上次用 Y 出过什么问题)

- 个人长期任务目标 / OKR / Roadmap 沉淀,Agent 在规划任务时自动对齐

---

# 二、前置准备:获取 API Key

所有 MCP 客户端的接入都依赖同一个 **Authorization Token**,即 OpenViking 控制台中的 API Key。请先按以下步骤获取并妥善保存。

## 2\.1 操作路径

1. 在左侧菜单选择 **用户管理**

2. 在用户列表中找到对应用户(个人版默认为 `default` / `admin`),点击 API Key 列右侧的 **复制** 图标

3. 将复制得到的 `ZGV\.\.\.hiMg` 形式的字符串妥善保存,作为后续所有 Agent 接入的 `Authorization`**安全提示**:API Key 等同于账户密钥,请勿提交到 Git 仓库或公开渠道。建议通过环境变量或加密配置注入。

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MTNkMDA0ZDBhZGRmODlkNmNjMGRiMGEwZTIyMzZlNThfMmNkMmZlZjA1ZWJjNTAyMGMzODFiNmRiZDk2ZTU3ZDhfSUQ6NzY0NDUxMTgwNDM5NjI3NjkzNl8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

---

# 三、Trae 接入指南

**Trae** 是字节跳动推出的 AI IDE,原生支持通过 MCP 协议加载外部工具与上下文服务。以下为 OpenViking 的标准接入流程。

## 3\.1 接入步骤

### 步骤 1 · 打开设置

在 Trae 主界面右上角点击 **设置(齿轮图标)**,进入设置面板。

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=ZjI2NTRmZGYzZWZlM2QxOWFlNGQzNzRlM2UzMWY5YmZfZTMzMWRhMDdiN2MwNmVmNzU0OWQ5MTQ3YTk2YmUwMGRfSUQ6NzY0NDUxMTk4NjYyNjAwNTk0OF8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 2 · 进入 MCP 配置页

在左侧菜单中选择 **MCP**,进入 MCP Servers 管理页。

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MDk3NGYwN2ZhNWU3NTg1ZTI3ZWMyYzMyZTlhZDkwNDJfMDgyZGQwNWMzMjkyN2Y0NmU3OTU2ZTJmMGRkZmI4YmJfSUQ6NzY0NDUxMjA1Njk2NTY5NjQ4MV8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 3 · 新增 MCP Server

点击右侧的 **\+ 添加** 按钮,在下拉菜单中选择 **手动配置**![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=YjY4NTg3OGM4MzJkNjE4OGUzNzY2MThiNmI1YjRhNTBfZDU4ZmUwZTU0MzU5OTQ0OWE3ZDNmMzJmODg1NzYyNDJfSUQ6NzY0NDUxMjE2NDcyNDU5MTU0N18xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

![Image](https://internal-api-drive-stream.larkoffice.com/space/api/box/stream/download/authcode/?code=MjFmMWE0MmY3Njc5MTVmN2E3NjY3ODQ2MWY0YWEyZTRfZGFlMjI3YzU3MTRmYzVhNWI1NGVkYzJiZmY5NGZiMTRfSUQ6NzY0NDU2NTk1NzU2NTk0MjcyNl8xNzgwMDM5ODY4OjE3ODAxMjYyNjhfVjM)

### 步骤 4 · 粘贴配置 JSON

在弹出的配置框中粘贴以下 JSON,并将 `Authorization` 替换为第二章中复制的 API Key:

```json
{
  "mcpServers": {
    "ov-mcp-server": {
      "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",
      "headers": {
        "Authorization": "Bearer ZGVmYXV********YzdlZjhiMg"
      }
    }
  }
}

关键说明Authorization 的值需带上 Bearer 前缀(注意空格),完整格式为 Bearer \&lt;API Key\&gt;

Image

步骤 5 · 确认并启用

点击 确认 按钮,Trae 会自动建立 MCP 连接并加载工具列表。连接成功后,ov\-mcp\-server 将出现在已配置的 MCP Servers 列表中。配置完成后,可在 MCP 管理页看到 ov\-mcp\-server 已加载并启用,右侧开关呈绿色:

Image

步骤 6 · MCP 连通性检查

接入后建议通过两个简单 query 快速验证 MCP 是否正常工作。在 Trae 对话框中依次输入:

**① **ov ls — 列出 OpenViking 根目录内容,确认连接畅通、可正确返回目录结构。

Image

**② **ov health — 调用 health 工具,确认 OpenViking 服务端状态与当前用户身份。

Image

验收标准ov ls 能返回 agent / resources / session / user 等目录;ov health 返回 service initialized 与当前用户名,即表示接入成功。

3.2 配置参数说明

字段 必填 说明
mcpServers MCP Server 配置根节点
ov\-mcp\-server 服务别名,可自定义;建议保持与上下文识别一致
url OpenViking MCP 服务端点;CN 区固定为 https://api\.vikingdb\.cn\-beijing\.volces\.com/openviking/mcp
headers\.Authorization 格式 Bearer \&lt;API Key\&gt;,来源见第二章

</details>

</td></tr>
</table>

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link
Copy Markdown
Collaborator

@ZaynJarvis ZaynJarvis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ZaynJarvis ZaynJarvis merged commit 18897e4 into volcengine:main May 29, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants