SpyBara
Go Premium

agent-sdk/claude-code-features.md 2026-09-17 05:00 UTC to 2026-09-18 23:58 UTC

This page contains 1 addition and 1 deletion.

2026
Thu 10 23:00 Mon 14 22:58 Fri 18 23:58

在 SDK 中使用 Claude Code 功能

將專案指令、skills、hooks 和其他 Claude Code 功能載入到您的 SDK 代理中。

Agent SDK 建立在與 Claude Code 相同的基礎上,這意味著您的 SDK 代理可以存取相同的基於檔案系統的功能:專案指令(CLAUDE.md 和規則)、skills、hooks 等。

當您省略 settingSources 時,query() 會讀取與 Claude Code CLI 相同的檔案系統設定:使用者、專案和本機設定、CLAUDE.md 檔案以及 .claude/ skills、代理和命令。若要在沒有這些的情況下執行,請傳遞 settingSources: [],這會將代理限制為您以程式設計方式設定的內容。無論此選項如何,都會讀取受管原則設定和全域 ~/.claude.json 設定。請參閱 settingSources 不控制的內容。

使用 settingSources 控制檔案系統設定

設定來源選項(Python 中的 setting_sources、TypeScript 中的 settingSources)控制 SDK 載入哪些基於檔案系統的設定。傳遞明確清單以選擇加入特定來源,或傳遞空陣列以停用使用者、專案和本機設定。

此範例透過將 settingSources 設定為 ["user", "project"] 來載入使用者層級和專案層級設定:

from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ResultMessage
import asyncio


async def main():
async for message in query(
prompt="Help me refactor the auth module",
options=ClaudeAgentOptions(
# "user" loads from ~/.claude/, "project" loads from ./.claude/ in cwd.
# Together they give the agent access to CLAUDE.md, skills, hooks, and
# permissions from both locations.
setting_sources=["user", "project"],
allowed_tools=["Read", "Edit", "Bash"],
),
):
if isinstance(message, AssistantMessage):
for block in message.content:
if hasattr(block, "text"):
print(block.text)
if isinstance(message, ResultMessage) and message.subtype == "success":
print(f"\nResult: {message.result}")


asyncio.run(main())

當此程式執行時,助理的回應會列印到標準輸出,然後在執行完成後列印最終結果行。

每個來源都會從特定位置載入設定,其中 <cwd> 是您透過 cwd 選項傳遞的工作目錄,或如果未設定則為程序的目前目錄。如需完整的型別定義,請參閱 SettingSource(TypeScript)或 SettingSource(Python)。

來源 載入的內容 位置
"project" 專案 settings.json 和 hooks;專案 CLAUDE.md 和 .claude/rules/*.md;專案 skills、commands 和 subagents <cwd>/.claude/ 用於 settings.json 和 hooks;<cwd> 和每個父目錄用於 CLAUDE.md 和 rules;<cwd> 和每個父目錄直到儲存庫根目錄用於 skills、commands 和 subagents,加上您透過 additionalDirectories 或 add_dirs 選項傳遞的每個目錄的 .claude/skills/、.claude/commands/ 和 .claude/agents/ 資料夾,SDK 會將其作為 --add-dir 傳遞給 Claude Code
"user" 使用者 settings.json;使用者 CLAUDE.md 和 ~/.claude/rules/*.md;使用者 skills、commands 和 subagents ~/.claude/ 用於 settings.json、CLAUDE.md 和 rules;~/.claude/skills/、~/.claude/commands/ 和 ~/.claude/agents/ 用於 skills、commands 和 subagents
"local" CLAUDE.local.md、.claude/settings.local.json <cwd>/.claude/ 用於 settings.local.json;<cwd> 和每個父目錄用於 CLAUDE.local.md

省略 settingSources 等同於 ["user", "project", "local"]。

cwd 選項決定 SDK 在何處尋找專案層級輸入。專案 settings.json 和 hooks 僅從 <cwd>/.claude/ 載入,沒有父目錄回退。

settingSources 不控制的內容

settingSources 涵蓋使用者、專案和本機設定。無論其值如何,都會讀取一些輸入:

輸入 行為 停用方式
受管原則設定 端點管理的原則(例如 MDM plist、登錄原則或受管設定檔)從主機載入。伺服器管理的設定在工作階段使用符合條件的認證(例如組織 OAuth 登入、直接配置的 API 金鑰或 user_oauth Anthropic 設定檔)進行驗證時,在符合條件的配置上擷取 端點原則:從主機移除受管設定檔、plist 或登錄原則。伺服器管理的設定:由您的 Claude 組織中的擁有者控制;您無法從 SDK 停用它們
~/.claude.json 全域設定 始終讀取 在 env 中使用 CLAUDE_CONFIG_DIR 重新定位
~/.claude/projects/<project>/memory/ 的自動記憶體 預設載入到系統提示中。代理程式使用標準 Write 和 Edit 工具而非專用記憶體工具寫入新記憶體,因此必須啟用這些工具才能讓代理程式儲存記憶體 在設定中設定 autoMemoryEnabled: false,或在 env 中設定 CLAUDE_CODE_DISABLE_AUTO_MEMORY=1
claude.ai MCP 連接器 當工作階段使用您的 claude.ai 登入進行驗證時載入。當 CLAUDE_CODE_OAUTH_TOKEN 持有來自 claude setup-token 的權杖時不會載入,該權杖只能進行模型請求。傳遞 mcpServers: {} 不會抑制連接器 設定 strictMcpConfig: true、disableClaudeAiConnectors: true 在設定中,或在 env 中設定 ENABLE_CLAUDEAI_MCP_SERVERS=false
sandbox.credentials deny 項目和 ~/.claude/settings.json 中的檔案 mask 項目 當命令沙箱執行時,Claude Code 會套用 deny 項目,並將 credentials.files mask 項目保持為限制,即使 settingSources 排除使用者設定。Claude Code 僅使用這些項目來縮小沙箱化命令可以存取的內容 從 ~/.claude/settings.json 移除項目

專案指令(CLAUDE.md 和規則)

CLAUDE.md 檔案和 .claude/rules/*.md 檔案為您的代理提供有關您的專案的持久上下文:編碼慣例、建置命令、架構決策和指令。當 settingSources 包含 "project"(如 settingSources 範例所示)時,SDK 在工作階段開始時將這些檔案載入到上下文中。代理隨後會遵循您的專案慣例,而無需在每個提示中重複它們。

CLAUDE.md 載入位置

層級 位置 何時載入
專案(根目錄) <cwd>/CLAUDE.md 或 <cwd>/.claude/CLAUDE.md settingSources 包含 "project"
專案規則 <cwd>/.claude/rules/*.md 和 .claude/rules/*.md 在每個父目錄中 settingSources 包含 "project"
專案(父目錄) cwd 上方目錄中的 CLAUDE.md 檔案 settingSources 包含 "project",在工作階段開始時載入
專案(子目錄) cwd 子目錄中的 CLAUDE.md 檔案 settingSources 包含 "project",當代理讀取該子樹中的檔案時按需載入
本機 <cwd>/CLAUDE.local.md 和 CLAUDE.local.md 在每個父目錄中 settingSources 包含 "local"
使用者 ~/.claude/CLAUDE.md settingSources 包含 "user"
使用者規則 ~/.claude/rules/*.md settingSources 包含 "user"

所有層級都是累加的:如果專案和使用者 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。

from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage
import asyncio


# Skills in .claude/skills/ are discovered automatically
# when settingSources includes "project"
async def main():
async for message in query(
prompt="Review this PR using our code review checklist",
options=ClaudeAgentOptions(
setting_sources=["user", "project"],
skills="all",
allowed_tools=["Read", "Grep", "Glob"],
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)


asyncio.run(main())

Hooks

SDK 支援兩種定義 hooks 的方式,它們並行執行:

  • 檔案系統 hooks: 在 settings.json 中定義的 shell 命令,當 settingSources 包含相關來源時載入。這些是您為 互動式 Claude Code 工作階段 設定的相同 hooks。
  • 程式設計 hooks: 直接傳遞給 query() 的回呼函式。這些在您的應用程式程序中執行,可以返回結構化決策。請參閱 使用 hooks 控制執行。

Hook 回呼接收工具輸入並返回決策字典。返回 {} 表示允許工具繼續。若要阻止執行,請返回一個 hookSpecificOutput 物件,其中包含 permissionDecision: "deny" 和 permissionDecisionReason。原因會作為工具結果發送給 Claude。請參閱 hooks 指南 以取得完整的回呼簽名和返回型別。

from claude_agent_sdk import query, ClaudeAgentOptions, HookMatcher, ResultMessage
import asyncio


# PreToolUse hook callback. Positional args:
#   input_data: HookInput dict with tool_name, tool_input, hook_event_name
#   tool_use_id: str | None, the ID of the tool call being intercepted
#   context: HookContext, reserved for future abort-signal support
async def audit_bash(input_data, tool_use_id, context):
command = input_data.get("tool_input", {}).get("command", "")
if "rm -rf" in command:
return {
"hookSpecificOutput": {
"hookEventName": "PreToolUse",
"permissionDecision": "deny",
"permissionDecisionReason": "Destructive command blocked",
}
}
return {}  # Empty dict: allow the tool to proceed


# Filesystem hooks from .claude/settings.json run automatically
# when settingSources loads them. You can also add programmatic hooks:
async def main():
async for message in query(
prompt="Refactor the auth module",
options=ClaudeAgentOptions(
setting_sources=["project"],  # Loads hooks from .claude/settings.json
hooks={
"PreToolUse": [
HookMatcher(matcher="Bash", hooks=[audit_bash]),
]
},
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)


asyncio.run(main())

何時使用哪種 hook 類型

Hook 類型 最適合
檔案系統(settings.json) 在 CLI 和 SDK 工作階段之間共享 hooks。支援 "command"(shell 指令碼)、"http"(POST 到端點)、"mcp_tool"(呼叫連接的 MCP 伺服器的工具)、"prompt"(LLM 評估提示)和 "agent"(生成驗證器代理)。這些在主代理和它生成的任何子代理中執行。
程式設計(query() 中的回呼) 應用程式特定邏輯、結構化決策和進程內整合。這些也在子代理內執行。hook 輸入(回呼的第一個引數)攜帶 agent_id 和 agent_type 欄位,用於識別哪個代理觸發了 hook。

如需程式設計 hooks 的完整詳細資訊,請參閱 使用 hooks 控制執行。如需檔案系統 hook 語法,請參閱 Hooks。

選擇正確的功能

Agent SDK 為您提供了多種方式來擴展代理的行為。如果您不確定要使用哪一種,此表將常見目標對應到正確的方法。

您想要... 使用 SDK 表面
設定代理始終遵循的專案慣例 CLAUDE.md settingSources: ["project"] 會自動載入它
為代理提供它在相關時載入的參考資料 Skills settingSources + skills 選項
執行可重複使用的工作流程(部署、審查、發佈) 使用者可呼叫的 skills settingSources + skills 選項
將隔離的子任務委派給新的上下文(研究、審查) 子代理 agents 參數 + allowedTools: ["Agent"]
協調多個 Claude Code 實例,具有共享任務清單和直接的代理間訊息傳遞 代理團隊 不直接透過 SDK 選項設定。代理團隊是一個 CLI 功能,其中一個工作階段充當團隊主管,協調獨立隊友之間的工作
在工具呼叫上執行確定性邏輯(審計、阻止、轉換) Hooks hooks 參數與回呼,或透過 settingSources 載入的 shell 指令碼
為 Claude 提供對外部服務的結構化工具存取 MCP mcpServers 參數

您啟用的每項功能都會增加代理的上下文視窗。如需每項功能的成本以及這些功能如何分層組合,請參閱 擴展 Claude Code。

  • 擴展 Claude Code:所有擴展功能的概念概述,包含比較表和上下文成本分析
  • SDK 中的 Skills:以程式設計方式使用 skills 的完整指南
  • 子代理:為隔離的子任務定義和呼叫子代理
  • Hooks:在關鍵執行點攔截和控制代理行為
  • 權限:使用模式、規則和回呼控制工具存取
  • 系統提示:在不使用 CLAUDE.md 檔案的情況下注入上下文