mirror of
https://github.com/claude-code-best/claude-code.git
synced 2026-06-15 21:05:51 +00:00
* docs: 修复文档巡检发现的 4 处错误 - daemon.md: 反映实际实现状态(supervisor/worker 已实现而非 stub) - bridge-mode.md: API 操作数量从 7 修正为 9 - web-search-tool.md: 文件路径从 src/tools/ 修正为 packages/builtin-tools/src/tools/ - remote-control-self-hosting.md: 补充缺失的 RCS_WS_IDLE_TIMEOUT 和 RCS_WS_KEEPALIVE_INTERVAL 配置项 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 Safety 和 Context 文档中的代码引用和类型错误 - permission-model: 修正规则来源从"五层"到八层,优先级顺序对齐代码 - permission-model: PermissionUpdate 类型改为实际的 addRules/replaceRules 等 - permission-model: 补充 acceptEdits 和 dontAsk 两种权限模式 - permission-model: DENIAL_LIMITS 字段名对齐实际代码 - plan-mode: 工具路径从 src/tools/ 改为 packages/builtin-tools/src/tools/ - compaction: 修正 COMPACTABLE_TOOLS 和 POST_COMPACT_* 的行号 - project-memory: 修正 ENTRYPOINT_NAME 常量的行号 - system-prompt: 修正 SystemPrompt 类型定义文件路径和多个行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复 introduction 文档中的错误路径和行号引用 - why-this-whitepaper.mdx: BashTool 路径从 src/tools/ 修正为 packages/builtin-tools/src/tools/ - what-is-claude-code.mdx: 移除不存在的 Azure provider,改为实际的 7 种 provider - architecture-overview.mdx: State 类型行号从 204 修正为 207 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复 conversation/features 文档中的错误 - streaming.mdx: queryStreamRaw → queryModelWithStreaming 函数名修正 - streaming.mdx: Azure 提供商不存在,替换为实际 7 个提供商 - debug-mode.mdx: --inspect-wait 描述错误,实际使用 BUN_INSPECT 环境变量 - buddy.mdx: 补充缺失的 companionReact.ts、CompanionCard.tsx、index.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复文档巡检中的源码引用错误 - feature-flags.mdx: 修正 feature() 兜底描述,实际从 bun:bundle 导入而非 cli.tsx:3 内联 - feature-flags.mdx: 修正工具 require 路径为 @claude-code-best/builtin-tools 包路径 - ant-only-world.mdx: 修正 tools.ts 中 require 路径为包路径 - ant-only-world.mdx: 修正 INTERNAL_ONLY_COMMANDS 行号 (267-295) 和数量 (24+) - skills.mdx: 修正 COMMANDS memoize 行号 258 → 299 - mcp-protocol.mdx: 修正 fetchToolsForClient LRU 缓存上限 20 → 100 - streaming.mdx: 修正流式事件引用 - file-operations.mdx: 修正工具路径引用 - search-and-navigation.mdx: 修正搜索工具引用 - shell-execution.mdx: 修正 shell 工具引用 - buddy.mdx: 补充缺失的 frontmatter 字段 - debug-mode.mdx: 修正调试模式描述 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 tools/agent 文档中的文件路径和行号引用 - 修正 TodoWriteTool、AgentTool、ToolSearchTool 等工具路径 src/tools/ → packages/builtin-tools/src/tools/ - 更新 Tool.ts、tools.ts、BashTool.tsx 中过时的行号引用 - 修正 WebSearchTool/WebFetchTool/EnterWorktreeTool/ExitWorktreeTool 路径 - 修正 AgentTool.tsx 中多行行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature 文档中的文件路径和行号引用 - ultraplan.md: 更新文件行数(525/349/127) - fork-subagent.md: 路径迁移 src/tools/ → packages/builtin-tools/ - mcp-skills.md: 修正 getMcpSkillCommands 行号 547→604,client.ts 行号 117→129 - kairos.md: 修正 getBriefSection/getProactiveSection 行号 - proactive.md: 修正 getProactiveSection 行号 860→864 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正顶层文档中的路径迁移和行号引用 - auto-updater.md: config.ts 行号 1735→1737,标注未接入启动流程的函数 - external-dependencies.md: WebSearchTool/WebFetchTool 路径迁移到 builtin-tools 包,Vertex 行号修正 - lsp-integration.md: LSPTool 路径从 src/tools/ 迁移到 packages/builtin-tools/ - stub-recovery-design-1-4.md: 修正 Windows 绝对路径链接为标准代码引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 task 文档中的文件扩展名和路径引用 - task-004: AssistantSessionChooser.ts → .tsx, assistant.ts → .tsx - task-003: cli.tsx 行号 249→272, markdownConfigLoader.ts 行号 29→35 - lan-pipes: SendMessageTool 路径迁移到 packages/builtin-tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 补充 computer-use-tools-reference 缺失的 Windows 工具 添加遗漏的 open_terminal 和 activate_window 两个 Windows 专属工具, 修正工具总数 37→39,Windows 工具数 10→12。 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 audit/bash-classifier/token-budget/tree-sitter 文档 - feature-flags-audit: ScheduleCronTool 路径迁移、DAEMON 状态更新为 COMPLETE、assistant 文件标记已补全、UDS 标记已实现 - bash-classifier: BashPermissionRequest 文件路径修正、withRetry 行号移除 - token-budget: attachments.ts 行号范围修正 - tree-sitter-bash: bashPermissions.ts 路径迁移到 packages/builtin-tools Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 langfuse-monitoring AgentTool 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 bridgeApi 行号和 Tool.ts 行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 Safety/Extensibility 文档中的工具路径迁移和行号引用 - sandbox.mdx: shouldUseSandbox.ts 和 bashPermissions.ts 路径迁移至 packages/builtin-tools - why-safety-matters.mdx: bashPermissions.ts 路径迁移(3 处) - plan-mode.mdx: EnterPlanModeTool/prompt.ts 路径迁移 - auto-mode.mdx: Auto mode 指令行号 3464→3481 - hooks.mdx: AgentTool/runAgent.ts 路径迁移 - skills.mdx: SkillTool.ts 路径迁移 - custom-agents.mdx: Agent built-in 目录和 exploreAgent.ts 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 internals 文档引用计数和路径 - ant-only-world: USER_TYPE 引用计数 465→410+,工具路径迁移到 builtin-tools - growthbook-ab-testing: growthbook.ts 行数 1156→1258 - hidden-features: 语音模式状态更新(audio-napi 已恢复) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正工具文档中的行号引用 - sub-agents: AgentTool.call 入口行号 340→387 - shell-execution: ShellCommand onTimeout 行号 129→144 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature 文档中的状态、路径和计数 - all-features-guide: 修正 feature flag 启用范围(dev only vs dev+build) - tier3-stubs: 大量状态修正(stub→已实现),缩减过时条目 - workflow-scripts: 路径迁移到 builtin-tools,状态更新 - web-browser-tool: 工具状态缺失→已实现,路径迁移 - context-collapse: CtxInspectTool 状态缺失→已实现 - computer-use: 行号引用更新,平台分发描述修正 - computer-use-tools-reference: 工具数 39→38 - voice-mode: voiceModeEnabled 行数 55→54 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 更新 the-loop 查询循环行号引用 query.ts 代码变更后终止原因行号整体偏移约 40 行 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 补充 feature-flags-audit 完整 build 默认 feature 列表 添加 ULTRATHINK/LODESTONE/ACP/DAEMON 等 19 个缺失的 build 默认 feature, 修正 dev-only 特征标注(UDS_INBOX/LAN_PIPES/BG_SESSIONS/TEMPLATES) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit ConfigTool 路径迁移 ConfigTool 路径从 src/tools/ 迁移到 packages/builtin-tools/src/tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit BashTool 路径迁移 BashTool 路径从 src/tools/ 迁移到 packages/builtin-tools/src/tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit SkillTool 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 更新 feature-flags-audit WorkflowTool 状态为已实现 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
152 lines
6.1 KiB
Plaintext
152 lines
6.1 KiB
Plaintext
---
|
||
title: "计划模式 - Plan Mode 先看后做的安全机制"
|
||
description: "基于源码解析 Claude Code Plan Mode 的完整实现:EnterPlanModeTool/ExitPlanModeV2Tool 的工具设计、权限上下文切换机制、Prompt-based 权限请求、计划文件持久化、Teammate 审批流程。"
|
||
keywords: ["Plan Mode", "计划模式", "EnterPlanMode", "ExitPlanMode", "prepareContextForPlanMode", "allowedPrompts"]
|
||
---
|
||
|
||
{/* 本章目标:基于源码揭示 Plan Mode 的完整实现 */}
|
||
|
||
## 问题场景
|
||
|
||
你说"重构这个模块",AI 立刻开始改代码——但你还没搞清楚它打算怎么改。等改了一半发现方向不对,已经来不及了。
|
||
|
||
## Plan Mode 的解决方案
|
||
|
||
计划模式给对话加了一个"只读阶段",通过两个工具实现闭环:
|
||
|
||
<Steps>
|
||
<Step title="EnterPlanMode — 进入计划模式">
|
||
AI 自主判断(或用户触发)任务需要规划,调用 `EnterPlanModeTool`(`packages/builtin-tools/src/tools/EnterPlanModeTool/EnterPlanModeTool.ts:36`)。该工具需要**用户审批**(`checkPermissions` 返回 `ask`)。
|
||
</Step>
|
||
<Step title="探索阶段 — 只读工具集">
|
||
权限模式切换为 `'plan'`,AI 只能使用 `isReadOnly()` 为 true 的工具(Read、Grep、Glob、Agent 等)。写操作被自动拒绝。
|
||
</Step>
|
||
<Step title="ExitPlanMode — 提交方案审批">
|
||
AI 完成探索后,调用 `ExitPlanModeV2Tool`(`packages/builtin-tools/src/tools/ExitPlanModeTool/ExitPlanModeV2Tool.ts:147`),将计划文件提交给用户审阅。这是第二个**需要用户审批**的节点。
|
||
</Step>
|
||
<Step title="恢复执行 — 全部工具权限">
|
||
用户批准后,权限模式恢复为进入前的状态,AI 按计划执行。
|
||
</Step>
|
||
</Steps>
|
||
|
||
## 权限的自动收窄与恢复
|
||
|
||
### 进入:`prepareContextForPlanMode()`
|
||
|
||
`EnterPlanModeTool.call()`(第 77 行)的核心逻辑:
|
||
|
||
```typescript
|
||
// 1. 记录转换状态(保存之前的模式)
|
||
handlePlanModeTransition(currentMode, 'plan')
|
||
|
||
// 2. 切换权限上下文为 plan 模式
|
||
context.setAppState(prev => ({
|
||
...prev,
|
||
toolPermissionContext: applyPermissionUpdate(
|
||
prepareContextForPlanMode(prev.toolPermissionContext),
|
||
{ type: 'setMode', mode: 'plan', destination: 'session' },
|
||
),
|
||
}))
|
||
```
|
||
|
||
`prepareContextForPlanMode()`(`src/utils/permissions/permissionSetup.ts`)做了什么:
|
||
- 创建新的 `ToolPermissionContext`,`mode` 设为 `'plan'`
|
||
- 在 plan 模式下,工具的 `isReadOnly()` 检查成为唯一准入条件
|
||
- 如果用户的默认模式是 `'auto'`,还会激活 classifier 的副作用
|
||
|
||
### 退出:权限恢复 + Prompt-based 权限
|
||
|
||
`ExitPlanModeV2Tool` 的退出逻辑做了两件关键的事:
|
||
|
||
**1. 恢复权限模式**
|
||
|
||
通过 `handlePlanModeTransition()` 和 `applyPermissionUpdate()` 恢复到进入前的模式。
|
||
|
||
**2. 注入 Prompt-based 权限**
|
||
|
||
这是 Plan Mode 最精妙的设计——AI 可以在计划中声明它需要执行的命令类别:
|
||
|
||
```typescript
|
||
// ExitPlanModeV2Tool 的 inputSchema
|
||
allowedPrompts: z.array(z.object({
|
||
tool: z.enum(['Bash']),
|
||
prompt: z.string().describe('Semantic description, e.g. "run tests"'),
|
||
})).optional()
|
||
```
|
||
|
||
当 AI 提交计划时,如果声明了 `allowedPrompts: [{ tool: 'Bash', prompt: 'run tests' }]`,用户批准后,"run tests" 这类 Bash 命令会被自动放行——不再需要逐个确认。
|
||
|
||
## 计划文件的持久化
|
||
|
||
计划内容被写入磁盘文件(由 `getPlanFilePath()` 确定路径),这与简单的"AI 说一段话然后开始执行"有本质区别:
|
||
|
||
1. `ExitPlanModeV2Tool` 的 `normalizeToolInput` 从磁盘读取计划内容,注入到 `input.plan` 和 `input.planFilePath`
|
||
2. 计划文件是用户**可编辑**的——用户可以在审批前修改 AI 的方案
|
||
3. `planWasEdited` 字段标记用户是否修改了计划,影响后续的 tool_result 回显
|
||
4. `persistFileSnapshotIfRemote()` 在远程场景下保存文件快照
|
||
|
||
## Teammate 场景下的计划审批
|
||
|
||
在 Agent Swarms(`isAgentSwarmsEnabled()`)模式下,计划审批有额外的协作流程:
|
||
|
||
```typescript
|
||
// 如果是 Teammate 角色
|
||
if (isTeammate()) {
|
||
// 发送计划到 Team Leader 的 mailbox 等待审批
|
||
const requestId = generateRequestId()
|
||
writeToMailbox(getTeamName(), {
|
||
type: 'plan_approval_request',
|
||
plan, requestId, ...
|
||
})
|
||
// 返回 awaitingLeaderApproval: true
|
||
// Team Leader 审批后通过 mailbox 通知 Teammate
|
||
}
|
||
```
|
||
|
||
这意味着在蜂群模式下,计划可能不是由直接用户审批,而是由 Team Leader 审批。
|
||
|
||
## 什么时候该用计划模式
|
||
|
||
`EnterPlanModeTool` 的 Prompt(`packages/builtin-tools/src/tools/EnterPlanModeTool/prompt.ts`)定义了两套触发标准——外部版本更积极(鼓励规划),内部版本更克制(仅在真正模糊时使用):
|
||
|
||
| 场景 | 外部版本 | 内部版本 |
|
||
|------|---------|---------|
|
||
| 修复 typo | 跳过 | 跳过 |
|
||
| 添加删除按钮 | **进入**(涉及多个文件) | **跳过**(路径明确) |
|
||
| 重构认证系统 | **进入** | **进入**(高影响重构) |
|
||
| "开始做 X" | — | **跳过**(直接开始) |
|
||
| 架构决策(Redis vs 内存缓存) | **进入** | **进入**(真正模糊) |
|
||
|
||
## 计划模式 + 任务系统
|
||
|
||
计划模式通常与任务系统配合使用:
|
||
|
||
1. 在计划模式中,AI 把实施步骤创建为任务列表(`TodoWrite`)
|
||
2. 用户审批计划(包含任务列表)
|
||
3. 退出计划模式后,AI 按任务列表逐项执行
|
||
4. 用户可以通过任务列表追踪进度
|
||
|
||
## 完整生命周期
|
||
|
||
```
|
||
用户: "重构这个模块"
|
||
↓
|
||
AI 判断需要规划 → 调用 EnterPlanModeTool
|
||
↓ 用户审批(Ask 对话框)
|
||
handlePlanModeTransition(default, 'plan') // 保存 default
|
||
prepareContextForPlanMode() // 创建只读上下文
|
||
↓
|
||
AI 使用 Read/Grep/Glob/Agent 探索代码库
|
||
↓ (可能 10+ 轮只读工具调用)
|
||
AI 形成方案 → 调用 ExitPlanModeV2Tool({
|
||
allowedPrompts: [
|
||
{ tool: 'Bash', prompt: 'run tests' },
|
||
{ tool: 'Bash', prompt: 'install dependencies' }
|
||
]
|
||
})
|
||
↓ 用户审批计划(可编辑计划文件)
|
||
恢复权限模式 → 注入 prompt-based 权限
|
||
↓
|
||
AI 使用全部工具执行计划,"run tests" 等命令自动放行
|
||
```
|