- 使用 Agent SDK 設置項目
- 創建一個包含一些有缺陷代碼的文件
- 運行一個代理,自動查找並修復錯誤
先決條件
- Node.js 18+ 或 Python 3.10+
- 一個 Anthropic 帳戶(在此註冊)
設置
安裝 SDK
為您的語言安裝 Agent SDK 包:
- TypeScript
- Python (uv)
- Python (pip)
TypeScript SDK 為您的平台捆綁了一個本機 Claude Code 二進制文件作為可選依賴項,因此您無需單獨安裝 Claude Code。
設置您的 API 密鑰
從 Claude 控制台獲取 API 密鑰,然後在您的項目目錄中創建一個 SDK 還支持通過第三方 API 提供商進行身份驗證:
.env 文件:- Amazon Bedrock:設置
CLAUDE_CODE_USE_BEDROCK=1環境變量並配置 AWS 憑證 - Google Vertex AI:設置
CLAUDE_CODE_USE_VERTEX=1環境變量並配置 Google Cloud 憑證 - Microsoft Azure:設置
CLAUDE_CODE_USE_FOUNDRY=1環境變量並配置 Azure 憑證
除非事先獲得批准,否則 Anthropic 不允許第三方開發人員提供 claude.ai 登錄或對其產品的速率限制,包括基於 Claude Agent SDK 構建的代理。請改用本文檔中描述的 API 密鑰身份驗證方法。
創建有缺陷的文件
此快速開始將引導您構建一個可以查找並修復代碼中的錯誤的代理。首先,您需要一個包含一些故意錯誤的文件供代理修復。在my-agent 目錄中創建 utils.py 並粘貼以下代碼:
calculate_average([])因除以零而崩潰get_user_name(None)因 TypeError 而崩潰
構建查找並修復錯誤的代理
如果您使用 Python SDK,請創建agent.py,或者如果使用 TypeScript,請創建 agent.ts:
-
query:創建 agentic 循環的主要入口點。它返回一個異步迭代器,因此您使用async for在 Claude 工作時流式傳輸消息。請參閱 Python 或 TypeScript SDK 參考中的完整 API。 -
prompt:您希望 Claude 執行的操作。Claude 根據任務確定要使用哪些工具。 -
options:代理的配置。此示例使用allowedTools預先批准Read、Edit和Glob,並使用permissionMode: "acceptEdits"自動批准文件更改。其他選項包括systemPrompt、mcpServers等。請參閱 Python 或 TypeScript 的所有選項。
async for 循環在 Claude 思考、調用工具、觀察結果並決定下一步操作時持續運行。每次迭代都會產生一條消息:Claude 的推理、工具調用、工具結果或最終結果。SDK 處理編排(工具執行、上下文管理、重試),因此您只需使用流。當 Claude 完成任務或遇到錯誤時,循環結束。
循環內的消息處理會過濾人類可讀的輸出。如果沒有過濾,您會看到原始消息對象,包括系統初始化和內部狀態,這對於調試很有用,但通常很冗長。
此示例使用流式傳輸來實時顯示進度。如果您不需要實時輸出(例如,對於後台作業或 CI 管道),您可以一次收集所有消息。有關詳細信息,請參閱流式傳輸與單輪模式。
運行您的代理
您的代理已準備好。使用以下命令運行它:- Python
- TypeScript
utils.py。您將看到處理空列表和空用戶的防禦性代碼。您的代理自主地:
- 讀取
utils.py以理解代碼 - 分析邏輯並識別會導致崩潰的邊界情況
- 編輯文件以添加適當的錯誤處理
如果您看到”API key not found”,請確保您已在
.env 文件或 shell 環境中設置 ANTHROPIC_API_KEY 環境變量。有關更多幫助,請參閱完整故障排除指南。嘗試其他提示
現在您的代理已設置好,嘗試一些不同的提示:"Add docstrings to all functions in utils.py""Add type hints to all functions in utils.py""Create a README.md documenting the functions in utils.py"
自定義您的代理
您可以通過更改選項來修改代理的行為。以下是一些示例: 添加網絡搜索功能:Bash 後,嘗試:"Write unit tests for utils.py, run them, and fix any failures"
關鍵概念
工具控制您的代理可以執行的操作:| 工具 | 代理可以執行的操作 |
|---|---|
Read、Glob、Grep | 只讀分析 |
Read、Edit、Glob | 分析和修改代碼 |
Read、Edit、Bash、Glob、Grep | 完全自動化 |
| 模式 | 行為 | 用例 |
|---|---|---|
acceptEdits | 自動批准文件編輯和常見文件系統命令,詢問其他操作 | 受信任的開發工作流 |
dontAsk | 拒絕不在 allowedTools 中的任何內容 | 鎖定的無頭代理 |
auto(僅 TypeScript) | 模型分類器批准或拒絕每個工具調用 | 具有安全防護的自主代理 |
bypassPermissions | 運行每個工具而不提示 | 沙箱 CI、完全受信任的環境 |
default | 需要 canUseTool 回調來處理批准 | 自定義批准流程 |
acceptEdits 模式,它自動批准文件操作,以便代理可以無需交互提示地運行。如果您想提示用戶批准,請使用 default 模式並提供一個 canUseTool 回調來收集用戶輸入。如需更多控制,請參閱權限。
故障排除
API 錯誤 thinking.type.enabled 不支持此模型
Claude Opus 4.7 將 thinking.type.enabled 替換為 thinking.type.adaptive。當您選擇 claude-opus-4-7 時,較舊的 Agent SDK 版本會失敗並出現以下 API 錯誤: