Agent SDK 參考 - TypeScript

npm install @anthropic-ai/claude-agent-sdk

function query({
  prompt,
  options
}: {
  prompt: string | AsyncIterable<SDKUserMessage>;
  options?: Options;
}): Query

function tool<Schema extends ZodRawShape>(
  name: string,
  description: string,
  inputSchema: Schema,
  handler: (args: z.infer<ZodObject<Schema>>, extra: unknown) => Promise<CallToolResult>
): SdkMcpToolDefinition<Schema>

function createSdkMcpServer(options: {
  name: string;
  version?: string;
  tools?: Array<SdkMcpToolDefinition<any>>;
}): McpSdkServerConfigWithInstance

interface Query extends AsyncGenerator<SDKMessage, void> {
  interrupt(): Promise<void>;
  setPermissionMode(mode: PermissionMode): Promise<void>;
}

type AgentDefinition = {
  description: string;
  tools?: string[];
  prompt: string;
  model?: 'sonnet' | 'opus' | 'haiku' | 'inherit';
}

type SettingSource = 'user' | 'project' | 'local';

// 像 SDK v0.0.x 一樣載入所有設定
const result = query({
  prompt: "分析此程式碼",
  options: {
    settingSources: ['user', 'project', 'local']  // 載入所有設定
  }
});

// 僅載入專案設定，忽略使用者和本機設定
const result = query({
  prompt: "執行 CI 檢查",
  options: {
    settingSources: ['project']  // 僅 .claude/settings.json
  }
});

// 透過排除本機設定確保 CI 中的一致行為
const result = query({
  prompt: "執行測試",
  options: {
    settingSources: ['project'],  // 僅團隊共用設定
    permissionMode: 'bypassPermissions'
  }
});

// 以程式設計方式定義所有內容（預設行為）
// 無檔案系統相依性 - settingSources 預設為 []
const result = query({
  prompt: "檢閱此 PR",
  options: {
    // settingSources: [] 是預設值，無需指定
    agents: { /* ... */ },
    mcpServers: { /* ... */ },
    allowedTools: ['Read', 'Grep', 'Glob']
  }
});

// 載入專案設定以包含 CLAUDE.md 檔案
const result = query({
  prompt: "按照專案慣例新增功能",
  options: {
    systemPrompt: {
      type: 'preset',
      preset: 'claude_code'  // 使用 CLAUDE.md 時必需
    },
    settingSources: ['project'],  // 從專案目錄載入 CLAUDE.md
    allowedTools: ['Read', 'Write', 'Edit']
  }
});

type PermissionMode =
  | 'default'           // 標準權限行為
  | 'acceptEdits'       // 自動接受檔案編輯
  | 'bypassPermissions' // 略過所有權限檢查
  | 'plan'              // 規劃模式 - 無執行

type CanUseTool = (
  toolName: string,
  input: ToolInput,
  options: {
    signal: AbortSignal;
    suggestions?: PermissionUpdate[];
  }
) => Promise<PermissionResult>;

type PermissionResult = 
  | {
      behavior: 'allow';
      updatedInput: ToolInput;
      updatedPermissions?: PermissionUpdate[];
    }
  | {
      behavior: 'deny';
      message: string;
      interrupt?: boolean;
    }

type McpServerConfig = 
  | McpStdioServerConfig
  | McpSSEServerConfig
  | McpHttpServerConfig
  | McpSdkServerConfigWithInstance;

type McpStdioServerConfig = {
  type?: 'stdio';
  command: string;
  args?: string[];
  env?: Record<string, string>;
}

type McpSSEServerConfig = {
  type: 'sse';
  url: string;
  headers?: Record<string, string>;
}

type McpHttpServerConfig = {
  type: 'http';
  url: string;
  headers?: Record<string, string>;
}

type McpSdkServerConfigWithInstance = {
  type: 'sdk';
  name: string;
  instance: McpServer;
}

type SdkPluginConfig = {
  type: 'local';
  path: string;
}

plugins: [
  { type: 'local', path: './my-plugin' },
  { type: 'local', path: '/absolute/path/to/plugin' }
]

type SDKMessage = 
  | SDKAssistantMessage
  | SDKUserMessage
  | SDKUserMessageReplay
  | SDKResultMessage
  | SDKSystemMessage
  | SDKPartialAssistantMessage
  | SDKCompactBoundaryMessage;

type SDKAssistantMessage = {
  type: 'assistant';
  uuid: UUID;
  session_id: string;
  message: APIAssistantMessage; // 來自 Anthropic SDK
  parent_tool_use_id: string | null;
}

type SDKUserMessage = {
  type: 'user';
  uuid?: UUID;
  session_id: string;
  message: APIUserMessage; // 來自 Anthropic SDK
  parent_tool_use_id: string | null;
}

type SDKUserMessageReplay = {
  type: 'user';
  uuid: UUID;
  session_id: string;
  message: APIUserMessage;
  parent_tool_use_id: string | null;
}

type SDKResultMessage = 
  | {
      type: 'result';
      subtype: 'success';
      uuid: UUID;
      session_id: string;
      duration_ms: number;
      duration_api_ms: number;
      is_error: boolean;
      num_turns: number;
      result: string;
      total_cost_usd: number;
      usage: NonNullableUsage;
      permission_denials: SDKPermissionDenial[];
    }
  | {
      type: 'result';
      subtype: 'error_max_turns' | 'error_during_execution';
      uuid: UUID;
      session_id: string;
      duration_ms: number;
      duration_api_ms: number;
      is_error: boolean;
      num_turns: number;
      total_cost_usd: number;
      usage: NonNullableUsage;
      permission_denials: SDKPermissionDenial[];
    }

type SDKSystemMessage = {
  type: 'system';
  subtype: 'init';
  uuid: UUID;
  session_id: string;
  apiKeySource: ApiKeySource;
  cwd: string;
  tools: string[];
  mcp_servers: {
    name: string;
    status: string;
  }[];
  model: string;
  permissionMode: PermissionMode;
  slash_commands: string[];
  output_style: string;
}

type SDKPartialAssistantMessage = {
  type: 'stream_event';
  event: RawMessageStreamEvent; // 來自 Anthropic SDK
  parent_tool_use_id: string | null;
  uuid: UUID;
  session_id: string;
}

type SDKCompactBoundaryMessage = {
  type: 'system';
  subtype: 'compact_boundary';
  uuid: UUID;
  session_id: string;
  compact_metadata: {
    trigger: 'manual' | 'auto';
    pre_tokens: number;
  };
}

type SDKPermissionDenial = {
  tool_name: string;
  tool_use_id: string;
  tool_input: ToolInput;
}

type HookEvent = 
  | 'PreToolUse'
  | 'PostToolUse'
  | 'Notification'
  | 'UserPromptSubmit'
  | 'SessionStart'
  | 'SessionEnd'
  | 'Stop'
  | 'SubagentStop'
  | 'PreCompact';

type HookCallback = (
  input: HookInput, // 所有鉤子輸入類型的聯合
  toolUseID: string | undefined,
  options: { signal: AbortSignal }
) => Promise<HookJSONOutput>;

interface HookCallbackMatcher {
  matcher?: string;
  hooks: HookCallback[];
}

type HookInput = 
  | PreToolUseHookInput
  | PostToolUseHookInput
  | NotificationHookInput
  | UserPromptSubmitHookInput
  | SessionStartHookInput
  | SessionEndHookInput
  | StopHookInput
  | SubagentStopHookInput
  | PreCompactHookInput;

type BaseHookInput = {
  session_id: string;
  transcript_path: string;
  cwd: string;
  permission_mode?: string;
}

type PreToolUseHookInput = BaseHookInput & {
  hook_event_name: 'PreToolUse';
  tool_name: string;
  tool_input: ToolInput;
}

type PostToolUseHookInput = BaseHookInput & {
  hook_event_name: 'PostToolUse';
  tool_name: string;
  tool_input: ToolInput;
  tool_response: ToolOutput;
}

type NotificationHookInput = BaseHookInput & {
  hook_event_name: 'Notification';
  message: string;
  title?: string;
}

type UserPromptSubmitHookInput = BaseHookInput & {
  hook_event_name: 'UserPromptSubmit';
  prompt: string;
}

type SessionStartHookInput = BaseHookInput & {
  hook_event_name: 'SessionStart';
  source: 'startup' | 'resume' | 'clear' | 'compact';
}

type SessionEndHookInput = BaseHookInput & {
  hook_event_name: 'SessionEnd';
  reason: 'clear' | 'logout' | 'prompt_input_exit' | 'other';
}

type StopHookInput = BaseHookInput & {
  hook_event_name: 'Stop';
  stop_hook_active: boolean;
}

type SubagentStopHookInput = BaseHookInput & {
  hook_event_name: 'SubagentStop';
  stop_hook_active: boolean;
}

type PreCompactHookInput = BaseHookInput & {
  hook_event_name: 'PreCompact';
  trigger: 'manual' | 'auto';
  custom_instructions: string | null;
}

type HookJSONOutput = AsyncHookJSONOutput | SyncHookJSONOutput;

type AsyncHookJSONOutput = {
  async: true;
  asyncTimeout?: number;
}

type SyncHookJSONOutput = {
  continue?: boolean;
  suppressOutput?: boolean;
  stopReason?: string;
  decision?: 'approve' | 'block';
  systemMessage?: string;
  reason?: string;
  hookSpecificOutput?:
    | {
        hookEventName: 'PreToolUse';
        permissionDecision?: 'allow' | 'deny' | 'ask';
        permissionDecisionReason?: string;
      }
    | {
        hookEventName: 'UserPromptSubmit';
        additionalContext?: string;
      }
    | {
        hookEventName: 'SessionStart';
        additionalContext?: string;
      }
    | {
        hookEventName: 'PostToolUse';
        additionalContext?: string;
      };
}

type ToolInput = 
  | AgentInput
  | BashInput
  | BashOutputInput
  | FileEditInput
  | FileReadInput
  | FileWriteInput
  | GlobInput
  | GrepInput
  | KillShellInput
  | NotebookEditInput
  | WebFetchInput
  | WebSearchInput
  | TodoWriteInput
  | ExitPlanModeInput
  | ListMcpResourcesInput
  | ReadMcpResourceInput;

interface AgentInput {
  /**
   * 任務的簡短（3-5 個字）描述
   */
  description: string;
  /**
   * 代理要執行的任務
   */
  prompt: string;
  /**
   * 用於此任務的專用代理類型
   */
  subagent_type: string;
}

interface BashInput {
  /**
   * 要執行的命令
   */
  command: string;
  /**
   * 選用的逾時時間（以毫秒為單位，最多 600000）
   */
  timeout?: number;
  /**
   * 此命令功能的清晰、簡潔描述（5-10 個字）
   */
  description?: string;
  /**
   * 設定為 true 以在背景執行此命令
   */
  run_in_background?: boolean;
}

interface BashOutputInput {
  /**
   * 要從中擷取輸出的背景 shell 的 ID
   */
  bash_id: string;
  /**
   * 選用的正規表達式以篩選輸出行
   */
  filter?: string;
}

interface FileEditInput {
  /**
   * 要修改的檔案的絕對路徑
   */
  file_path: string;
  /**
   * 要取代的文字
   */
  old_string: string;
  /**
   * 用來取代它的文字（必須與 old_string 不同）
   */
  new_string: string;
  /**
   * 取代 old_string 的所有出現次數（預設 false）
   */
  replace_all?: boolean;
}

interface FileReadInput {
  /**
   * 要讀取的檔案的絕對路徑
   */
  file_path: string;
  /**
   * 開始讀取的行號
   */
  offset?: number;
  /**
   * 要讀取的行數
   */
  limit?: number;
}

interface FileWriteInput {
  /**
   * 要寫入的檔案的絕對路徑
   */
  file_path: string;
  /**
   * 要寫入檔案的內容
   */
  content: string;
}

interface GlobInput {
  /**
   * 要與檔案比對的 glob 模式
   */
  pattern: string;
  /**
   * 要搜尋的目錄（預設為 cwd）
   */
  path?: string;
}

interface GrepInput {
  /**
   * 要搜尋的正規表達式模式
   */
  pattern: string;
  /**
   * 要搜尋的檔案或目錄（預設為 cwd）
   */
  path?: string;
  /**
   * 用於篩選檔案的 glob 模式（例如 "*.js"）
   */
  glob?: string;
  /**
   * 要搜尋的檔案類型（例如 "js"、"py"、"rust"）
   */
  type?: string;
  /**
   * 輸出模式："content"、"files_with_matches" 或 "count"
   */
  output_mode?: 'content' | 'files_with_matches' | 'count';
  /**
   * 不區分大小寫搜尋
   */
  '-i'?: boolean;
  /**
   * 顯示行號（用於內容模式）
   */
  '-n'?: boolean;
  /**
   * 每個比對前要顯示的行數
   */
  '-B'?: number;
  /**
   * 每個比對後要顯示的行數
   */
  '-A'?: number;
  /**
   * 每個比對前後要顯示的行數
   */
  '-C'?: number;
  /**
   * 將輸出限制為前 N 行/項目
   */
  head_limit?: number;
  /**
   * 啟用多行模式
   */
  multiline?: boolean;
}

interface KillShellInput {
  /**
   * 要終止的背景 shell 的 ID
   */
  shell_id: string;
}

interface NotebookEditInput {
  /**
   * Jupyter 筆記本檔案的絕對路徑
   */
  notebook_path: string;
  /**
   * 要編輯的儲存格的 ID
   */
  cell_id?: string;
  /**
   * 儲存格的新來源
   */
  new_source: string;
  /**
   * 儲存格的類型（程式碼或 markdown）
   */
  cell_type?: 'code' | 'markdown';
  /**
   * 編輯的類型（取代、插入、刪除）
   */
  edit_mode?: 'replace' | 'insert' | 'delete';
}

interface WebFetchInput {
  /**
   * 要從中擷取內容的 URL
   */
  url: string;
  /**
   * 要在擷取的內容上執行的提示
   */
  prompt: string;
}

interface WebSearchInput {
  /**
   * 要使用的搜尋查詢
   */
  query: string;
  /**
   * 僅包含來自這些網域的結果
   */
  allowed_domains?: string[];
  /**
   * 永遠不要包含來自這些網域的結果
   */
  blocked_domains?: string[];
}

interface TodoWriteInput {
  /**
   * 更新的待辦事項清單
   */
  todos: Array<{
    /**
     * 任務描述
     */
    content: string;
    /**
     * 任務狀態
     */
    status: 'pending' | 'in_progress' | 'completed';
    /**
     * 任務描述的主動形式
     */
    activeForm: string;
  }>;
}

interface ExitPlanModeInput {
  /**
   * 使用者批准要執行的計畫
   */
  plan: string;
}

interface ListMcpResourcesInput {
  /**
   * 選用的伺服器名稱以篩選資源
   */
  server?: string;
}

interface ReadMcpResourceInput {
  /**
   * MCP 伺服器名稱
   */
  server: string;
  /**
   * 要讀取的資源 URI
   */
  uri: string;
}

type ToolOutput = 
  | TaskOutput
  | BashOutput
  | BashOutputToolOutput
  | EditOutput
  | ReadOutput
  | WriteOutput
  | GlobOutput
  | GrepOutput
  | KillBashOutput
  | NotebookEditOutput
  | WebFetchOutput
  | WebSearchOutput
  | TodoWriteOutput
  | ExitPlanModeOutput
  | ListMcpResourcesOutput
  | ReadMcpResourceOutput;

interface TaskOutput {
  /**
   * 來自子代理的最終結果訊息
   */
  result: string;
  /**
   * 權杖使用統計資料
   */
  usage?: {
    input_tokens: number;
    output_tokens: number;
    cache_creation_input_tokens?: number;
    cache_read_input_tokens?: number;
  };
  /**
   * 美元總成本
   */
  total_cost_usd?: number;
  /**
   * 執行持續時間（以毫秒為單位）
   */
  duration_ms?: number;
}

interface BashOutput {
  /**
   * 合併的 stdout 和 stderr 輸出
   */
  output: string;
  /**
   * 命令的結束代碼
   */
  exitCode: number;
  /**
   * 命令是否因逾時而被終止
   */
  killed?: boolean;
  /**
   * 背景程序的 Shell ID
   */
  shellId?: string;
}

interface BashOutputToolOutput {
  /**
   * 自上次檢查以來的新輸出
   */
  output: string;
  /**
   * 目前的 shell 狀態
   */
  status: 'running' | 'completed' | 'failed';
  /**
   * 結束代碼（完成時）
   */
  exitCode?: number;
}

interface EditOutput {
  /**
   * 確認訊息
   */
  message: string;
  /**
   * 進行的取代次數
   */
  replacements: number;
  /**
   * 已編輯的檔案路徑
   */
  file_path: string;
}

type ReadOutput = 
  | TextFileOutput
  | ImageFileOutput
  | PDFFileOutput
  | NotebookFileOutput;

interface TextFileOutput {
  /**
   * 包含行號的檔案內容
   */
  content: string;
  /**
   * 檔案中的總行數
   */
  total_lines: number;
  /**
   * 實際返回的行數
   */
  lines_returned: number;
}

interface ImageFileOutput {
  /**
   * Base64 編碼的影像資料
   */
  image: string;
  /**
   * 影像 MIME 類型
   */
  mime_type: string;
  /**
   * 檔案大小（以位元組為單位）
   */
  file_size: number;
}

interface PDFFileOutput {
  /**
   * 頁面內容陣列
   */
  pages: Array<{
    page_number: number;
    text?: string;
    images?: Array<{
      image: string;
      mime_type: string;
    }>;
  }>;
  /**
   * 總頁數
   */
  total_pages: number;
}

interface NotebookFileOutput {
  /**
   * Jupyter 筆記本儲存格
   */
  cells: Array<{
    cell_type: 'code' | 'markdown';
    source: string;
    outputs?: any[];
    execution_count?: number;
  }>;
  /**
   * 筆記本中繼資料
   */
  metadata?: Record<string, any>;
}

interface WriteOutput {
  /**
   * 成功訊息
   */
  message: string;
  /**
   * 寫入的位元組數
   */
  bytes_written: number;
  /**
   * 已寫入的檔案路徑
   */
  file_path: string;
}

interface GlobOutput {
  /**
   * 比對的檔案路徑陣列
   */
  matches: string[];
  /**
   * 找到的比對數
   */
  count: number;
  /**
   * 使用的搜尋目錄
   */
  search_path: string;
}

type GrepOutput = 
  | GrepContentOutput
  | GrepFilesOutput
  | GrepCountOutput;

interface GrepContentOutput {
  /**
   * 具有內容的比對行
   */
  matches: Array<{
    file: string;
    line_number?: number;
    line: string;
    before_context?: string[];
    after_context?: string[];
  }>;
  /**
   * 比對總數
   */
  total_matches: number;
}

interface GrepFilesOutput {
  /**
   * 包含比對的檔案
   */
  files: string[];
  /**
   * 包含比對的檔案數
   */
  count: number;
}

interface GrepCountOutput {
  /**
   * 每個檔案的比對計數
   */
  counts: Array<{
    file: string;
    count: number;
  }>;
  /**
   * 所有檔案中的總比對數
   */
  total: number;
}

interface KillBashOutput {
  /**
   * 成功訊息
   */
  message: string;
  /**
   * 已終止的 shell 的 ID
   */
  shell_id: string;
}

interface NotebookEditOutput {
  /**
   * 成功訊息
   */
  message: string;
  /**
   * 執行的編輯類型
   */
  edit_type: 'replaced' | 'inserted' | 'deleted';
  /**
   * 受影響的儲存格 ID
   */
  cell_id?: string;
  /**
   * 編輯後筆記本中的總儲存格數
   */
  total_cells: number;
}

interface WebFetchOutput {
  /**
   * AI 模型對提示的回應
   */
  response: string;
  /**
   * 已擷取的 URL
   */
  url: string;
  /**
   * 重新導向後的最終 URL
   */
  final_url?: string;
  /**
   * HTTP 狀態代碼
   */
  status_code?: number;
}

interface WebSearchOutput {
  /**
   * 搜尋結果
   */
  results: Array<{
    title: string;
    url: string;
    snippet: string;
    /**
     * 可用的其他中繼資料
     */
    metadata?: Record<string, any>;
  }>;
  /**
   * 結果總數
   */
  total_results: number;
  /**
   * 搜尋的查詢
   */
  query: string;
}

interface TodoWriteOutput {
  /**
   * 成功訊息
   */
  message: string;
  /**
   * 目前的待辦事項統計資料
   */
  stats: {
    total: number;
    pending: number;
    in_progress: number;
    completed: number;
  };
}

interface ExitPlanModeOutput {
  /**
   * 確認訊息
   */
  message: string;
  /**
   * 使用者是否批准計畫
   */
  approved?: boolean;
}

interface ListMcpResourcesOutput {
  /**
   * 可用資源
   */
  resources: Array<{
    uri: string;
    name: string;
    description?: string;
    mimeType?: string;
    server: string;
  }>;
  /**
   * 資源總數
   */
  total: number;
}

interface ReadMcpResourceOutput {
  /**
   * 資源內容
   */
  contents: Array<{
    uri: string;
    mimeType?: string;
    text?: string;
    blob?: string;
  }>;
  /**
   * 提供資源的伺服器
   */
  server: string;
}

type PermissionUpdate = 
  | {
      type: 'addRules';
      rules: PermissionRuleValue[];
      behavior: PermissionBehavior;
      destination: PermissionUpdateDestination;
    }
  | {
      type: 'replaceRules';
      rules: PermissionRuleValue[];
      behavior: PermissionBehavior;
      destination: PermissionUpdateDestination;
    }
  | {
      type: 'removeRules';
      rules: PermissionRuleValue[];
      behavior: PermissionBehavior;
      destination: PermissionUpdateDestination;
    }
  | {
      type: 'setMode';
      mode: PermissionMode;
      destination: PermissionUpdateDestination;
    }
  | {
      type: 'addDirectories';
      directories: string[];
      destination: PermissionUpdateDestination;
    }
  | {
      type: 'removeDirectories';
      directories: string[];
      destination: PermissionUpdateDestination;
    }

type PermissionBehavior = 'allow' | 'deny' | 'ask';

type PermissionUpdateDestination = 
  | 'userSettings'     // 全域使用者設定
  | 'projectSettings'  // 每個目錄的專案設定
  | 'localSettings'    // Gitignored 本機設定
  | 'session'          // 僅限目前工作階段

type PermissionRuleValue = {
  toolName: string;
  ruleContent?: string;
}

type ApiKeySource = 'user' | 'project' | 'org' | 'temporary';

type ConfigScope = 'local' | 'user' | 'project';

type NonNullableUsage = {
  [K in keyof Usage]: NonNullable<Usage[K]>;
}

type Usage = {
  input_tokens: number | null;
  output_tokens: number | null;
  cache_creation_input_tokens?: number | null;
  cache_read_input_tokens?: number | null;
}

type CallToolResult = {
  content: Array<{
    type: 'text' | 'image' | 'resource';
    // 其他欄位因類型而異
  }>;
  isError?: boolean;
}

class AbortError extends Error {}