# DeepSeek Harness
> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。
DeepSeek Harness 是 DeepSeek AI 开发的一套用来构建、运行和扩展智能体的应用框架，采用**一切皆插件**的架构。本文介绍如何配置方舟 Agent Plan 到 DeepSeek Harness 中使用。
> **注意**
>
> DeepSeek Harness 目前处于**开发者预览**阶段，正在快速迭代，后续可能会出现破坏兼容性的变更。
# 一、前提条件
* 您已按需订阅 Agent Plan 套餐。如未，请访问 [开通管理-Agent Plan](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan?agentMode=close) 页面订阅套餐。
* 您已安装 Node.js（建议使用 LTS 版本）。
# 二、配置 DeepSeek Harness
您可以按下面任一方式在 DeepSeek Harness 中接入方舟 Agent Plan。**自动化助手** 通过 ArkCLI Helper 引导完成工具配置；**通过 Web UI 手动配置** 通过 DeepSeek Harness Web UI 逐项填写；**通过 Ark 插件配置** 借助方舟官方插件自动完成 provider 添加，只需填入 API Key。
## 方式 1：自动化助手（推荐）
ArkCLI Helper 是一个编码工具助手，支持快速配置选择的工具接入 Agent Plan。安装并运行该助手，根据界面提示操作可自动完成工具配置，降低手动配置的时间成本和出错风险。
> **注意**
>
> * ArkCLI Helper 是基于 Ark Helper 升级演进的工具配置服务，相关能力将持续在 ArkCLI Helper 上迭代更新。建议优先使用 ArkCLI Helper 完成工具配置。
> * ArkCLI Helper 支持 macOS、Linux、Windows 系统。
1. 安装 Ark CLI。
```Bash
# 1. 通过 NPM 安装
npm install -g @volcengine/ark-cli@latest
# 2. 验证安装
arkcli --version
```
2. 登录 Ark CLI。
```Bash
arkcli auth login
```
根据界面提示选择登录方式。若之前已登录过 arkcli，会沿用上次选择的配置；如需重新选择，请先执行 `arkcli config reset` 后再运行 `arkcli auth login`。首次登录时，按提示完成以下配置：
1. **选择项目（Project）**：可按需选择，或默认选择**账号全部资源**。
2. **选择消费模式（Type）**：选择 `agent-plan`。
其中：
* ``：运行 ArkCLI Helper 时填写的 Agent Plan 专属 API Key。
3. 运行 ArkCLI Helper，根据界面提示完成 DeepSeek Harness 的配置。
1. 在命令行界面输入 `arkcli helper` 命令，启动 ArkCLI Helper。
运行过程中会提示填写 Agent Plan 专属 API Key；如需在本地环境变量中管理，可使用 `ARK_API_KEY` 作为变量名。
2. **选择要配置的 Plan profile**：`agent-plan_cn-beijing_personal (Agent Plan)`。
3. **选择默认 model**：按需选择。
4. **选择要配置的 AI Agent**：`DeepSeek Harness`。
当前支持的 Harness 包括：豆包搜索、专业数据集、Agent 记忆（OpenViking）、AI Native 应用开发底座，根据界面提示按需选择`配置`或者`跳过`。
完成上述操作后，将自动完成 DeepSeek Harness 的基础配置，并按选择结果自动安装对应的 Harness 工具，无需手动安装。
## 方式 2：通过 Web UI 手动配置
1. 启动 DeepSeek Harness。
1. 在终端执行以下命令启动 DeepSeek Harness 的 Web UI。
```bash
npx @deepseek-ai/dsh web
```
2. 在浏览器打开命令输出的访问地址。默认地址为 `http://127.0.0.1:3080/`。
2. 在 DeepSeek Harness Web UI 中，单击左下角**设置**。
3. 在左侧导航栏单击**模型**，根据界面信息进行配置。
- 方式一：配置 DeepSeek 卡片
在 DeepSeek 卡片，选择**自定义设置**，按下面信息填写并保存。
- **API 密钥**：填写 Agent Plan [专属 API Key](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&OpenModelVisible=false&advancedActiveKey=agentPlan)。
- **API 地址**：`https://ark.cn-beijing.volces.com/api/plan/v3`
- **添加模型**：按需添加套餐支持的**文本生成模型**，模型列表参见 [支持模型及 Harness](/docs/agent-plan-personal-plan-overview#3d801f5f)。
- 方式二：添加自定义提供方
单击**添加自定义提供方**，按下面信息填写完成提供方的创建。
- **Provider ID**：自定义设置，后续如需重命名则需要添加新的提供方，并删除旧的提供方。
- **显式名称**：自定义设置。
- **API 地址**、**API 协议**：支持的 API 地址、API 协议及对应关系如下，不要配置错误。
|API 协议 | API 地址 |
|---|---|
|openai-completions |`https://ark.cn-beijing.volces.com/api/plan/v3` |
|openai-responses |`https://ark.cn-beijing.volces.com/api/plan/v3` |
|anthropic-messages |`https://ark.cn-beijing.volces.com/api/plan` |
- **API 密钥**：填写 Agent Plan [专属 API Key](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&OpenModelVisible=false&advancedActiveKey=agentPlan)。
- **添加模型**：按需添加套餐支持的**文本生成模型**，模型列表参见 [支持模型及 Harness](/docs/agent-plan-personal-plan-overview#3d801f5f)。
4. (可选) 如果需要给模型配置支持图片输入，则需要在配置文件中进行配置。
1. 在模型配置页面，单击**打开配置文件**，路径`$DSH_HOME/settings.yaml`。
2. 在支持的模型配置部分加上 `input: [text, image]`，配置示例如下。
```Yaml
llm-pi-ai:
providers:
ark-plan:
displayName: ark-plan
apiKeyEnv: ARK_PLAN_API_KEY
api: openai-responses
baseURL: https://ark.cn-beijing.volces.com/api/plan/v3
models:
- id: doubao-seed-2.1-pro
name: doubao-seed-2.1-pro
input: [text, image]
```
## 方式 3：通过 Ark 插件配置
方舟提供以下官方 Ark Plan 和后付费模型插件，自动为 DeepSeek Harness 配置方舟 Agent Plan、Harness(专业数据集、豆包搜索、Agent 记忆等)与后付费模型 provider，安装后可以自动完成 DeepSeek Harness 与方舟服务的对接，免去手动填写 API 地址、API Key 等步骤：
1. 启动 DeepSeek Harness。
1. 在终端执行以下命令启动 DeepSeek Harness 的 Web UI。
```bash
npx @deepseek-ai/dsh web
```
2. 在浏览器打开命令输出的访问地址。默认地址为 `http://127.0.0.1:3080/`。
2. 在对话框中输入以下 Prompt，让 Agent 帮你完成安装`ark-plan-api` 插件。
```bash
帮我安装下面的插件：curl -fsSL -o dsh-ark-plugin-install.sh "https://lf3-static.bytednsdoc.com/obj/eden-cn/ylwslo-yrh/ljhwZthlaukjlkulzlp/ark-cli-outer-resource/dsh-ark-plugin-install.sh" && bash dsh-ark-plugin-install.sh --plugin-name ark-plan-api
```
3. `ark-plan-api` 插件安装后会在 **设置 > 模型** 页面自动添加 Agent Plan、Coding Plan 以及后付费的模型 provider，用户可输入自己的 Agent Plan [专属 API Key](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&OpenModelVisible=false&advancedActiveKey=agentPlan)。回到对话页，在输入框右下角的模型下拉菜单中选择 **Ark Agent Plan** 下的模型即可开始使用。
4. (可选) 安装插件市场，方便后续查看和管理已装插件。
```bash
帮我安装下面插件：dsh plugin --profile web add dshmarket
```
安装完成后，**设置** 侧边栏会新增 **插件市场** 页。
# 三、使用 DeepSeek Harness
1. 在页面中点击 **选择工作区**，添加你启动 `dsh` 时所在的项目目录。选中工作区后，会话输入框才可用。
2. 在输入框右下角的模型下拉菜单中选择 **Ark Agent Plan** 下的模型即可开始使用。可用模型列表参见 [支持模型及 Harness](/docs/agent-plan-personal-plan-overview#3d801f5f)。
3. 在输入框输入需求即可开始使用 DeepSeek Harness。
Agent 可以读取和编辑工作区文件、运行命令、委派工作并维护计划。当操作在当前权限策略下需要审批时，Web UI 会先询问你。