Claude 程式碼 SDK
概述
使用 Claude Code SDK 建構自訂 AI 代理
為什麼使用 Claude Code SDK?
Claude Code SDK 建立在支援 Claude Code 的代理框架之上,提供建構生產就緒代理所需的所有構建模塊:
- 優化的 Claude 整合:自動提示快取和效能優化
- 豐富的工具生態系統:檔案操作、程式碼執行、網路搜尋和 MCP 擴展性
- 進階權限:對代理功能的細粒度控制
- 生產必需品:內建錯誤處理、會話管理和監控
您可以使用 SDK 建構什麼?
以下是您可以建立的一些代理類型範例:
編碼代理:
- 診斷和修復生產問題的 SRE 代理
- 審核程式碼漏洞的安全審查機器人
- 分類事件的值班工程助理
- 執行風格和最佳實踐的程式碼審查代理
商業代理:
- 審查合約和合規性的法律助理
- 分析報告和預測的財務顧問
- 解決技術問題的客戶支援代理
- 為行銷團隊提供的內容創作助理
SDK 選項
Claude Code SDK 提供多種形式以適應不同的使用案例:
- 無頭模式 - 用於 CLI 腳本和自動化
- TypeScript SDK - 用於 Node.js 和網路應用程式
- Python SDK - 用於 Python 應用程式和資料科學
核心概念
身份驗證
對於基本身份驗證,請從 Anthropic Console 取得 Anthropic API 金鑰並設定 ANTHROPIC_API_KEY
環境變數。
SDK 也支援透過第三方 API 提供者進行身份驗證:
- Amazon Bedrock:設定
CLAUDE_CODE_USE_BEDROCK=1
環境變數並配置 AWS 憑證 - Google Vertex AI:設定
CLAUDE_CODE_USE_VERTEX=1
環境變數並配置 Google Cloud 憑證
有關第三方提供者的詳細配置說明,請參閱 Amazon Bedrock 和 Google Vertex AI 文件。
系統提示
系統提示定義您代理的角色、專業知識和行為。這是您指定要建構何種代理的地方。
工具權限
使用細粒度權限控制您的代理可以使用哪些工具:
allowedTools
- 明確允許特定工具disallowedTools
- 阻止特定工具permissionMode
- 設定整體權限策略
模型上下文協定 (MCP)
透過 MCP 伺服器使用自訂工具和整合來擴展您的代理。這允許您連接到資料庫、API 和其他外部服務。
常見使用案例
自動化測試和 CI/CD
建立在您的 CI/CD 管道中自動執行測試、分析結果和修復問題的代理。
程式碼審查和安全稽核
建構審查拉取請求以檢查安全漏洞、程式碼品質和合規性的代理。
事件回應
部署診斷生產問題、分析日誌和建議修復的 SRE 代理。
文件生成
建立基於您的程式碼庫生成和維護文件的代理。
資料分析
建構分析資料、生成報告和建立視覺化的代理。
最佳實踐
- 使用 JSON 輸出格式用於程式化解析回應
- 優雅地處理錯誤 - 檢查退出代碼並實施重試邏輯
- 使用會話管理在多輪對話中維護上下文
- 實施超時用於長時間執行的操作
- 尊重速率限制在進行多個請求時
- 徹底測試在部署到生產環境之前
相關資源
- CLI 參考 - 完整的 CLI 文件
- GitHub Actions 整合 - 自動化您的 GitHub 工作流程
- MCP 文件 - 使用自訂工具擴展 Claude
- 常見工作流程 - 逐步指南
- 疑難排解 - 常見問題和解決方案