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>
212 lines
8.0 KiB
Plaintext
212 lines
8.0 KiB
Plaintext
---
|
||
title: "自定义 Agent - 从 Markdown 到运行时的完整链路"
|
||
description: "揭秘 Claude Code 自定义 Agent 完整链路:Agent 定义的 Markdown 数据模型、三种加载来源、工具过滤策略和与 AgentTool 的联动机制。"
|
||
keywords: ["自定义 Agent", "Agent 定义", "Markdown Agent", "Agent 配置", "角色定制"]
|
||
---
|
||
|
||
{/* 本章目标:揭示 Agent 定义的完整数据模型、加载发现机制、工具过滤和与 AgentTool 的联动 */}
|
||
|
||
## Agent 定义的三种来源
|
||
|
||
Claude Code 的 Agent 不仅仅来自用户自定义——系统有三类来源,按优先级合并:
|
||
|
||
| 来源 | 位置 | 优先级 |
|
||
|------|------|--------|
|
||
| **Built-in** | `packages/builtin-tools/src/tools/AgentTool/built-in/` 硬编码 | 最低(可被覆盖) |
|
||
| **Plugin** | 通过插件系统注册 | 中 |
|
||
| **User/Project/Policy** | `.claude/agents/*.md` 或 settings.json | 最高 |
|
||
|
||
合并逻辑在 `getActiveAgentsFromList()` 中:按 `agentType` 去重,后者覆盖前者。这意味着你可以在 `.claude/agents/` 中放一个 `Explore.md` 来完全替换内置的 Explore Agent。
|
||
|
||
## Markdown Agent 文件的完整格式
|
||
|
||
```markdown
|
||
---
|
||
# === 必需字段 ===
|
||
name: "reviewer" # Agent 标识(agentType)
|
||
description: "Code review specialist, read-only analysis"
|
||
|
||
# === 工具控制 ===
|
||
tools: "Read,Glob,Grep,Bash" # 允许的工具列表(逗号分隔)
|
||
disallowedTools: "Write,Edit" # 显式禁止的工具
|
||
|
||
# === 模型配置 ===
|
||
model: "haiku" # 指定模型(或 "inherit" 继承主线程)
|
||
effort: "high" # 推理努力程度:low/medium/high 或整数
|
||
|
||
# === 行为控制 ===
|
||
maxTurns: 10 # 最大 agentic 轮次
|
||
permissionMode: "plan" # 权限模式:plan/bypassPermissions 等
|
||
background: true # 始终作为后台任务运行
|
||
initialPrompt: "/search TODO" # 首轮用户消息前缀(支持斜杠命令)
|
||
|
||
# === 隔离与持久化 ===
|
||
isolation: "worktree" # 在独立 git worktree 中运行
|
||
memory: "project" # 持久记忆范围:user/project/local
|
||
|
||
# === MCP 服务器 ===
|
||
mcpServers:
|
||
- "slack" # 引用已配置的 MCP 服务器
|
||
- database: # 内联定义
|
||
command: "npx"
|
||
args: ["mcp-db"]
|
||
|
||
# === Hooks ===
|
||
hooks:
|
||
PreToolUse:
|
||
- command: "audit-log.sh"
|
||
timeout: 5000
|
||
|
||
# === Skills ===
|
||
skills: "code-review,security-review" # 预加载的 skills(逗号分隔)
|
||
|
||
# === 显示 ===
|
||
color: "blue" # 终端中的 Agent 颜色标识
|
||
---
|
||
|
||
你是代码审查专家。你的职责是...
|
||
|
||
(正文内容 = system prompt)
|
||
```
|
||
|
||
### 字段解析细节
|
||
|
||
- **`tools`**:通过 `parseAgentToolsFromFrontmatter()` 解析,支持逗号分隔字符串或数组
|
||
- **`model: "inherit"`**:使用主线程的模型(区分大小写,只有小写 "inherit" 有效)
|
||
- **`memory`**:启用后自动注入 `Write`/`Edit`/`Read` 工具(即使 `tools` 未包含),并在 system prompt 末尾追加 memory 指令
|
||
- **`isolation: "remote"`**:仅在 Anthropic 内部可用(`USER_TYPE === 'ant'`),外部构建只支持 `worktree`
|
||
- **`background`**:`true` 使 Agent 始终在后台运行,主线程不等待结果
|
||
|
||
## 加载与发现机制
|
||
|
||
`getAgentDefinitionsWithOverrides()`(被 `memoize` 缓存)执行完整的发现流程:
|
||
|
||
```
|
||
1. 加载 Markdown 文件
|
||
├── loadMarkdownFilesForSubdir('agents', cwd)
|
||
│ ├── ~/.claude/agents/*.md (用户级,source = 'userSettings')
|
||
│ ├── .claude/agents/*.md (项目级,source = 'projectSettings')
|
||
│ └── managed/policy sources (策略级,source = 'policySettings')
|
||
│
|
||
└── 每个 .md 文件:
|
||
├── 解析 YAML frontmatter
|
||
├── 正文作为 system prompt
|
||
├── 校验必需字段(name, description)
|
||
├── 静默跳过无 frontmatter 的 .md 文件(可能是参考文档)
|
||
└── 解析失败 → 记录到 failedFiles,不阻塞其他 Agent
|
||
|
||
2. 并行加载 Plugin Agents
|
||
└── loadPluginAgents() → memoized
|
||
|
||
3. 初始化 Memory Snapshots(如果 AGENT_MEMORY_SNAPSHOT 启用)
|
||
└── initializeAgentMemorySnapshots()
|
||
|
||
4. 合并 Built-in + Plugin + Custom
|
||
└── getActiveAgentsFromList() → 按 agentType 去重,后者覆盖前者
|
||
|
||
5. 分配颜色
|
||
└── setAgentColor(agentType, color) → 终端 UI 中区分不同 Agent
|
||
```
|
||
|
||
## 工具过滤的实现
|
||
|
||
当 Agent 被派生时,`AgentTool` 根据定义中的 `tools` / `disallowedTools` 过滤可用工具列表:
|
||
|
||
```
|
||
全部工具
|
||
↓ disallowedTools 移除
|
||
↓ tools 白名单过滤(如果指定)
|
||
可用工具
|
||
```
|
||
|
||
- **`tools` 未指定**:Agent 可以使用所有工具(默认全能)
|
||
- **`tools` 指定**:只能使用列出的工具
|
||
- **`disallowedTools`**:即使 `tools` 未指定,这些工具也被禁止
|
||
- **自动注入**:`memory` 启用时自动添加 `Write`/`Edit`/`Read`
|
||
|
||
以内置 Explore Agent 为例:
|
||
|
||
```typescript
|
||
// packages/builtin-tools/src/tools/AgentTool/built-in/exploreAgent.ts
|
||
disallowedTools: [
|
||
'Agent', // 不能嵌套调用 Agent
|
||
'ExitPlanMode', // 不需要 plan mode
|
||
'FileEdit', // 只读
|
||
'FileWrite', // 只读
|
||
'NotebookEdit', // 只读
|
||
]
|
||
```
|
||
|
||
## System Prompt 的注入方式
|
||
|
||
Agent 的 system prompt 通过 `getSystemPrompt()` 闭包延迟生成:
|
||
|
||
```typescript
|
||
// Markdown Agent
|
||
getSystemPrompt: () => {
|
||
if (isAutoMemoryEnabled() && memory) {
|
||
return systemPrompt + '\n\n' + loadAgentMemoryPrompt(agentType, memory)
|
||
}
|
||
return systemPrompt
|
||
}
|
||
```
|
||
|
||
这意味着:
|
||
1. **Markdown 正文 = 完整的 system prompt**——不是追加,而是替换默认 prompt
|
||
2. **Memory 指令**在 memory 启用时自动追加到末尾
|
||
3. **闭包延迟计算**——memory 状态可能在文件加载后才变化
|
||
|
||
对于 Built-in Agent,`getSystemPrompt` 接受 `toolUseContext` 参数,可以根据运行时状态(如是否使用嵌入式搜索工具)动态调整 prompt 内容。
|
||
|
||
## 与 AgentTool 的联动
|
||
|
||
当主 Agent 需要派生子 Agent 时:
|
||
|
||
```
|
||
AgentTool.call({ subagent_type: "reviewer", ... })
|
||
↓
|
||
1. 从 agentDefinitions.activeAgents 查找 agentType === "reviewer"
|
||
↓
|
||
2. 检查 requiredMcpServers(如果 Agent 要求特定 MCP 服务器)
|
||
↓
|
||
3. 过滤工具列表(tools / disallowedTools)
|
||
↓
|
||
4. 解析模型:
|
||
- "inherit" → 使用主线程模型
|
||
- 具体模型名 → 直接使用
|
||
- 未指定 → 主线程模型
|
||
↓
|
||
5. 解析权限模式(permissionMode)
|
||
↓
|
||
6. 构建隔离环境(如果 isolation === "worktree")
|
||
↓
|
||
7. 注入 system prompt(getSystemPrompt())
|
||
↓
|
||
8. 注入 initialPrompt(如果定义了)
|
||
↓
|
||
9. 启动子 Agent 循环(forkSubagent / runAgent)
|
||
```
|
||
|
||
## 内置 Agent 参考
|
||
|
||
| Agent | agentType | 角色 | 工具限制 | 模型 |
|
||
|-------|-----------|------|---------|------|
|
||
| **General Purpose** | `general-purpose` | 默认子 Agent | 全部工具 | 主线程模型 |
|
||
| **Explore** | `Explore` | 代码搜索专家 | 只读(无 Write/Edit) | haiku(外部) |
|
||
| **Plan** | `Plan` | 规划专家 | 只读 + ExitPlanMode | inherit |
|
||
| **Verification** | `verification` | 结果验证 | 由 feature flag 控制 | — |
|
||
| **Code Guide** | `claude-code-guide` | Claude Code 使用指南 | 只读 | — |
|
||
| **Statusline Setup** | `statusline-setup` | 终端状态栏配置 | 有限 | — |
|
||
|
||
SDK 入口(`sdk-ts`/`sdk-py`/`sdk-cli`)不加载 Code Guide Agent。环境变量 `CLAUDE_AGENT_SDK_DISABLE_BUILTIN_AGENTS` 可以完全禁用内置 Agent,给 SDK 用户提供空白画布。
|
||
|
||
## Agent Memory:持久化的 Agent 状态
|
||
|
||
当 `memory` 字段启用时,Agent 获得跨会话的持久记忆:
|
||
|
||
- **`local`**:当前项目、当前用户有效
|
||
- **`project`**:当前项目所有用户共享
|
||
- **`user`**:所有项目共享
|
||
|
||
Memory 通过 `loadAgentMemoryPrompt()` 注入到 system prompt 末尾,包含读写记忆的指令。Agent Memory Snapshot 机制在项目间同步 `user` 级记忆。
|