Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/content/docs/cli/agentkit-cli.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,35 @@ veadk agentkit init
veadk agentkit launch
```

## Invoke HarnessApp Runtime

`veadk agentkit invoke` can call a HarnessApp Runtime directly and enable Harness Extension for a single request. Common flags:

| Flag | Description |
| :-- | :-- |
| `--harness` | Agent name inside HarnessApp. |
| `--endpoint` | Runtime endpoint. |
| `--apikey` | Runtime API key. |
| `--model-id` | One-shot model override. |
| `--tools` | One-shot tool override, comma-separated. |
| `--skills` | One-shot skill override, comma-separated. |
| `--enable-harness-enhance` | Enable Harness Extension for this request. |
| `--harness-components` | Enabled Harness components for this request, comma-separated. |
| `--harness-profile` | Optional runtime profile. |
| `--harness-compression-provider` | Optional compaction provider, default `builtin`. |

```bash
veadk agentkit invoke \
--harness research-agent \
--endpoint "$HARNESS_URL" \
--apikey "$HARNESS_KEY" \
--model-id "your-model-id" \
--tools web_search,run_code \
--enable-harness-enhance \
--harness-components "invocation_context,compactor,response_verification" \
"Summarize the tool results with evidence."
```

## Further reference

For the full parameter details of each subcommand, see the [AgentKit CLI](https://volcengine.github.io/agentkit-sdk-python/content/2.agentkit-cli/1.overview.html).
29 changes: 29 additions & 0 deletions docs/content/docs/cli/agentkit-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,35 @@ veadk agentkit init
veadk agentkit launch
```

## 调用 HarnessApp Runtime

`veadk agentkit invoke` 可以直接调用 HarnessApp Runtime,并通过请求参数临时开启 Harness Extension。常用参数如下:

| 参数 | 说明 |
| :-- | :-- |
| `--harness` | HarnessApp 中的智能体名称。 |
| `--endpoint` | Runtime endpoint。 |
| `--apikey` | Runtime API Key。 |
| `--model-id` | 单次调用覆盖模型名称。 |
| `--tools` | 单次调用覆盖工具列表,逗号分隔。 |
| `--skills` | 单次调用覆盖技能列表,逗号分隔。 |
| `--enable-harness-enhance` | 本次调用启用 Harness Extension。 |
| `--harness-components` | 本次调用启用的 Harness 组件,逗号分隔。 |
| `--harness-profile` | 可选运行 profile。 |
| `--harness-compression-provider` | 可选压缩 provider,默认 `builtin`。 |

```bash
veadk agentkit invoke \
--harness research-agent \
--endpoint "$HARNESS_URL" \
--apikey "$HARNESS_KEY" \
--model-id "your-model-id" \
--tools web_search,run_code \
--enable-harness-enhance \
--harness-components "invocation_context,compactor,response_verification" \
"Summarize the tool results with evidence."
```

## 更多参考

各子命令的完整参数说明请参阅 [AgentKit 命令行工具](https://volcengine.github.io/agentkit-sdk-python/content/2.agentkit-cli/1.overview.html)。
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,23 @@ Prefix `TOOL_`, configured only when the corresponding tool is used.
| VOD | `TOOL_VOD_GROUPS` | Video editing capability groups |
| | `TOOL_VOD_TIMEOUT` | Connection timeout |

## Harness Extension

Prefix `HARNESS_`, used to attach optional Harness plugins to HarnessApp Runtime or `Runner`. The Harness Extension is bundled with VeADK; install the `veadk-python[harness]` extra only when you want the optional `headroom` compaction provider.

| Variable | Meaning |
| :- | :- |
| `HARNESS_ENHANCE_ENABLED` | Enable Harness plugins; accepts `true` / `false`. |
| `HARNESS_ENHANCE_COMPONENTS` | Enabled components, comma-separated; common value: `invocation_context,compactor,response_verification`. |
| `HARNESS_PROFILE` | Plugin runtime profile for policy selection; default `default`. |
| `HARNESS_COMPRESSION_PROVIDER` | Tool-result compaction provider, default `builtin`; optional `headroom`. |
| `HARNESS_MAX_CONTEXT_CHARS` | Context compaction threshold, default `24000`. |
| `HARNESS_MAX_TOOL_RESULT_CHARS` | Single tool-result compaction threshold, default `4000`. |
| `HARNESS_VERIFIER_MODE` | Final-response verification mode, `observe` or `block`; default `observe`. |
| `HARNESS_STORE_PATH` | Optional JSONL event store path; in-memory store is used when unset. |

The `harness_enhance` block maps to these environment variables when deploying a HarnessApp Runtime. Prefer `harness.yaml` or `veadk agentkit invoke` flags for normal developer workflows; use environment variables for platform integration and container runtimes.

## Databases

Prefix `DATABASE_`, grouped by storage type. Memory and the knowledge base read the matching config based on the selected backend.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,23 @@ volcengine:
| VOD | `TOOL_VOD_GROUPS` | 视频编辑能力组 |
| | `TOOL_VOD_TIMEOUT` | 连接超时时长 |

## Harness Extension

统一前缀 `HARNESS_`,用于给 HarnessApp Runtime 或 `Runner` 挂载可选的 Harness 插件能力。Harness Extension 随 VeADK 安装;只有当选择 `headroom` 压缩 provider 时,才需要安装 `veadk-python[harness]` 额外依赖。

| 环境变量 | 释义 |
| :- | :- |
| `HARNESS_ENHANCE_ENABLED` | 是否启用 Harness 插件,支持 `true` / `false`。 |
| `HARNESS_ENHANCE_COMPONENTS` | 启用的组件,逗号分隔;常用值为 `invocation_context,compactor,response_verification`。 |
| `HARNESS_PROFILE` | 插件运行 profile,用于区分运行策略;默认 `default`。 |
| `HARNESS_COMPRESSION_PROVIDER` | 工具结果压缩 provider,默认 `builtin`;可选 `headroom`。 |
| `HARNESS_MAX_CONTEXT_CHARS` | 上下文压缩阈值,默认 `24000`。 |
| `HARNESS_MAX_TOOL_RESULT_CHARS` | 单个工具结果压缩阈值,默认 `4000`。 |
| `HARNESS_VERIFIER_MODE` | 最终回答校验模式,`observe` 或 `block`,默认 `observe`。 |
| `HARNESS_STORE_PATH` | 可选 JSONL 事件存储路径;不设置时使用内存存储。 |

`harness_enhance` 配置块会在 HarnessApp Runtime 部署时映射为这些环境变量。推荐开发者优先通过 `harness.yaml` 或 `veadk agentkit invoke` 参数启用,环境变量适合平台集成和镜像运行时。

## 数据库

统一前缀 `DATABASE_`,按存储类型分组。记忆与知识库按所选后端读取对应配置。
Expand Down
Loading