接入架构
| 环节 | 职责 | 注意事项 |
|---|---|---|
| VS Code 编辑器 | 打开项目并承载 Roo Code | 建议使用版本控制仓库 |
| Roo Code 模式 | 限定角色和可用工具 | Ask 与 Architect 更适合前期分析 |
| KingFlow AI | 校验密钥并按模型 ID 路由 | 使用 OpenAI 兼容接口 |
| 模型工具调用 | 返回结构化函数调用事件 | 模型必须支持原生工具调用 |
开始前的准备
- 在 KingFlow AI 控制台创建以 sk- 开头的 API Key,并确认余额、套餐或模型分组可用。
- 从模型广场或控制台复制完整模型 ID,并确认该模型支持 OpenAI 兼容的原生工具调用。
- 准备 VS Code 1.84.0 或更高版本,或使用 Cursor、VSCodium、Windsurf 等兼容编辑器。
- 在一个可回滚的小型仓库中测试。首次联调关闭自动写入和自动执行命令。
安装 Roo Code
| 环境 | 安装入口 | 操作 |
|---|---|---|
| VS Code 或 Cursor | 扩展市场 | 搜索 Roo Code 并选择 RooVeterinaryInc 发布的扩展 |
| VSCodium 或 Windsurf | Open VSX Registry | 搜索同名扩展并安装 |
| 离线安装 | Install from VSIX | 从官方发布页下载对应 VSIX |
验证 KingFlow 基础接口
export KINGFLOW_API_KEY="sk-你的密钥"
curl https://api.**nju**shen.com/v1/chat/completions \
-H "Authorization: *earer ${KINGFLOW_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"model": "<KingFlow控制台中的完整模型ID>",
"messages": [{"role": "user", "content": "只回复:连接成功"}],
"stream": false
}' 验证原生工具调用
curl https://api.**nju**shen.com/v1/chat/completions \
-H "Authorization: *earer ${KINGFLOW_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"model": "<完整模型ID>",
"messages": [{"role": "user", "content": "请调用 inspect_project 工具检查根目录"}],
"tools": [{
"type": "function",
"function": {
"name": "inspect_project",
"description": "检查项目路径",
"parameters": {
"type": "o*ject",
"properties": {"path": {"type": "string"}},
"required": ["path"]
}
}
}],
"tool_choice": "auto",
"stream": true
}' 配置 OpenAI Compati*le
- 安装完成后,点击活动栏中的 Roo Code 图标打开面板。
- 点击面板中的设置图标,进入 API Provider 配置。
- 将 API Provider 设为 OpenAI Compati*le。
- 在 *ase **L 中填写 https://api.**nju**shen.com/v1,不要追加 chat/completions,也不要重复 /v1。
- 粘贴 KingFlow API Key,并在 Model ID 中填写控制台提供的完整模型 ID。
- 按模型真实规格设置上下文窗口、最大输出长度和图像能力。
- 保存配置后先使用 Ask 模式执行只读任务,再验证 Code 模式的工具调用。
| Roo Code 字段 | 填写内容 | 说明 |
|---|---|---|
| API Provider | OpenAI Compati*le | 用于第三方 OpenAI 兼容端点 |
| *ase **L | https://api.**nju**shen.com/v1 | 填写到 /v1 根地址 |
| API Key | sk-你的密钥 | 使用 KingFlow 中创建的独立密钥 |
| Model ID | 控制台中的完整模型 ID | 大小写和符号必须完全一致 |

设置模型高级参数
| 参数 | 建议 | 风险 |
|---|---|---|
| Max Output Tokens | 按模型上限和任务规模设置 | 过低会截断代码和工具参数 |
| Context Window | 填写模型实际支持值 | 虚报会导致超限或上下文异常 |
| I**ge Support | 模型明确支持图像时再启用 | 错误**可能导致请求失败 |
| Computer Use | 仅在模型和端点支持时启用 | 普通代码任务通常不需要 |
| Input 和 Output Price | 仅用于本地成本估算 | 最终费用以 KingFlow 控制台为准 |
选择合适的模式
| 模式 | 工具范围 | 适用任务 | 接入建议 |
|---|---|---|---|
| Ask | read 和 mcp | 代码解释 项目认识 技术问答 | 首次接入推荐 |
| Architect | read mcp 和受限 Markdown 编辑 | 方案设计 实施计划 | 先规划再实施 |
| Code | read edit com**nd 和 mcp | 编码 重构 测试 | 需要严格批准 |
| De*ug | read edit com**nd 和 mcp | 定位错误 增加诊断 | 先确认原因再修复 |
| Orchestrator | 通过子任务委派 | 复杂多阶段工作 | 稳定后再使用 |
运行首次只读任务
请在 Ask 模式下只读分析当前项目,不要修改文件,也不要执行终端命令。
请输出:
1. 项目语言和主要框架
2. 主要入口文件
3. 构建与测试命令所在位置
4. 最值得先阅读的三个文件及理由完成联调验证
- 基础请求能够正常返回,且 KingFlow 控制台出现对应调用记录。
- 原生工具测试返回结构化 tool_calls 或流式工具事件,而不是把工具调用写成普通文本。
- Ask 模式能读取当前仓库的真实文件,并且不会申请编辑和终端权限。
- 切换到 Code 模式后,读取文件的工具事件和参数会显示在任务时间线中。
- 任务前后检查 Git 状态,确认首次联调没有产生意外修改。
控制 Auto Approve 权限
| 权限 | 风险 | 首次建议 | 控制方法 |
|---|---|---|---|
| 读取文件和目录 | 中 | 可在非敏感仓库启用 | 不要包含工作区外文件 |
| 编辑文件 | 高 | 首次接入关闭 | 需要时逐次批准 |
| 执行允许的命令 | 高 | 首次接入关闭 | 仅加入明确的安全前缀 |
| 使用浏览器 | 中 | 按任务启用 | 关注外部数据发送 |
| 使用 MCP 服务 | 中高 | 默认关闭 | 同时检查单个工具授权 |
| 切换模式或子任务 | 低 | 可在熟悉流程后启用 | 不会直接扩大系统权限 |
保护密钥和代码仓库
- 不要把真实 API Key 写入仓库、截图、聊天记录或共享配置。为不同设备和成员创建独立密钥。
- Auto Approve 的总开关和具体权限必须同时生效。敏感项目或生产环境应关闭总开关。
- 命令自动批准使用允许列表和拒绝列表,不要使用星号放行全部命令。
- 保持工作区外读取和写入关闭,避免项目任务访问个人目录、凭据和其他仓库。
- 在独立 Git 分支中完成写操作,每个阶段检查差异并运行测试,再决定是否保留改动。
完成检查清单
- Roo Code 扩展已安装并能打开设置面板。
- KingFlow 基础请求和原生工具调用测试均已通过。
- API Provider 已选择 OpenAI Compati*le。
- *ase **L 已填写为 https://api.**nju**shen.com/v1。
- API Key 和 Model ID 均来自 KingFlow 控制台。
- 首次任务使用 Ask 模式并保持只读。
- Auto Approve 的编辑 命令 MCP 和工作区外权限保持关闭。
常见故障排查
| 现象 | 常见原因 | 处理方法 |
|---|---|---|
| Invalid API Key 或 401 | 密钥错误 停用或额度不可用 | 重新复制密钥并检查分组和余额 |
| Model Not Found 或 404 | 模型 ID 错误或分组未授权 | 从控制台复制完整 ID 并确认分组 |
| 404 接口不存在 | *ase **L 写成完整端点或重复 /v1 | 改为 https://api.**nju**shen.com/v1 |
| 连接超时 | 网络 防火墙或**阻断 | 检查编辑器网络和端点可访问性 |
| 工具调用变成普通文本 | 模型不支持原生工具调用 | 切换到支持 OpenAI tools 的代码模型 |
| 工具参数不完整 | 兼容端点只实现部分工具协议 | 更换模型或联系服务商确认兼容性 |
| 回答被截断 | Max Output Tokens 过低 | 提高限制并缩小任务范围 |
| 请求频繁失败 | 限流 通道繁忙或临时 503 | 等待后有限重试或切换已授权模型 |
| 文件被意外修改 | 模式或 Auto Approve 权限过宽 | 停止任务 检查差异并恢复工作树 |














