CLAUDE.md 和规则)、skills、hooks 等。
当您省略 settingSources 时,query() 读取与 Claude Code CLI 相同的文件系统设置:用户、项目和本地设置、CLAUDE.md 文件以及 .claude/ skills、代理和命令。要在没有这些的情况下运行,请传递 settingSources: [],这会将代理限制为您以编程方式配置的内容。无论此选项如何,都会读取托管策略设置和全局 ~/.claude.json 配置。请参阅 settingSources 不控制的内容。
有关每个功能的概念概述以及何时使用它,请参阅 扩展 Claude Code。
使用 settingSources 控制文件系统设置
设置源选项(Python 中的setting_sources、TypeScript 中的 settingSources)控制 SDK 加载哪些基于文件系统的设置。传递显式列表以选择加入特定源,或传递空数组以禁用用户、项目和本地设置。
此示例通过将 settingSources 设置为 ["user", "project"] 来加载用户级和项目级设置:
<cwd> 是您通过 cwd 选项传递的工作目录,或者如果未设置则为进程的当前目录。有关完整的类型定义,请参阅 SettingSource(TypeScript)或 SettingSource(Python)。
省略
settingSources 等同于 ["user", "project", "local"]。
cwd 选项确定 SDK 查找项目级输入的位置。CLAUDE.md 和规则从 <cwd> 和每个父目录加载。Skills 从 <cwd> 和每个父目录直到存储库根目录加载。项目 settings.json 和 hooks 仅从 <cwd>/.claude/ 加载,没有父目录回退。
settingSources 不控制的内容
settingSources 涵盖用户、项目和本地设置。无论其值如何,都会读取一些输入:
项目说明(CLAUDE.md 和规则)
CLAUDE.md 文件和 .claude/rules/*.md 文件为您的代理提供关于您的项目的持久上下文:编码约定、构建命令、架构决策和说明。当 settingSources 包含 "project"(如上面的示例)时,SDK 在会话开始时将这些文件加载到上下文中。然后代理遵循您的项目约定,而无需在每个提示中重复它们。
CLAUDE.md 加载位置
所有级别都是累加的:如果项目和用户 CLAUDE.md 文件都存在,代理会看到两者。级别之间没有硬优先级规则;如果说明冲突,结果取决于 Claude 如何解释它们。编写不冲突的规则,或在更具体的文件中明确说明优先级(“这些项目说明覆盖任何冲突的用户级默认值”)。
有关如何构建和组织 CLAUDE.md 内容,请参阅 管理 Claude 的内存。
Skills
Skills 是 markdown 文件,为您的代理提供专业知识和可调用的工作流。与CLAUDE.md(每个会话都加载)不同,skills 按需加载。代理在启动时接收 skill 描述,并在相关时加载完整内容。
Skills 通过 settingSources 从文件系统中发现。当 query() 上的 skills 选项被省略时,发现的用户和项目 skills 会被启用,Skill 工具可用,与 CLI 行为相匹配。要控制启用哪些 skills,请将 skills 作为 "all"、skill 名称列表或 [] 传递以禁用所有。当设置 skills 时,SDK 会自动将 Skill 工具添加到 allowedTools。如果您还传递了显式的 tools 列表,请在该列表中包含 "Skill",以便 Claude 可以调用 skills。
Skills 必须创建为文件系统工件(
.claude/skills/<name>/SKILL.md)。SDK 没有用于注册 skills 的编程 API。有关完整详情,请参阅 SDK 中的 Agent Skills。Hooks
SDK 支持两种定义 hooks 的方式,它们并行运行:- 文件系统 hooks: 在
settings.json中定义的 shell 命令,当settingSources包含相关源时加载。这些与您为 交互式 Claude Code 会话 配置的 hooks 相同。 - 编程 hooks: 直接传递给
query()的回调函数。这些在您的应用程序进程中运行,可以返回结构化决策。请参阅 使用 hooks 控制执行。
.claude/settings.json 中有 hooks,并且您设置 settingSources: ["project"],那些 hooks 会在 SDK 中自动运行,无需额外配置。
Hook 回调接收工具输入并返回决策字典。返回 {} 意味着允许工具继续。要阻止执行,返回一个 hookSpecificOutput 对象,其中包含 permissionDecision: "deny" 和 permissionDecisionReason。原因会作为工具结果发送给 Claude。顶级 decision 和 reason 字段对于 PreToolUse 已弃用。有关完整的回调签名和返回类型,请参阅 hooks 指南。
何时使用哪种 hook 类型
TypeScript SDK 支持超出 Python 的其他 hook 事件,包括
SessionStart、SessionEnd、TeammateIdle 和 TaskCompleted。有关完整的事件兼容性表,请参阅 hooks 指南。选择正确的功能
Agent SDK 为您提供了多种方式来扩展代理的行为。如果您不确定使用哪种,此表将常见目标映射到正确的方法。
您启用的每个功能都会增加代理的上下文窗口。有关每个功能的成本以及这些功能如何分层组合,请参阅 扩展 Claude Code。
相关资源
- 扩展 Claude Code:所有扩展功能的概念概述,包含比较表和上下文成本分析
- SDK 中的 Skills:使用 skills 的完整指南
- 子代理:为隔离的子任务定义和调用子代理
- Hooks:在关键执行点拦截和控制代理行为
- 权限:使用模式、规则和回调控制工具访问
- 系统提示:在不使用 CLAUDE.md 文件的情况下注入上下文